pymatsolver.BiCGJacobi#
- class pymatsolver.BiCGJacobi(A, maxiter=1000, rtol=1e-06, atol=0.0, check_accuracy=False, check_rtol=1e-06, check_atol=0, **kwargs)[source]#
Diagonal pre-conditioned BiCG solver.
- Parameters:
- A
matrix The matrix to solve, must have a
diagonal()method.- maxiter
int,optional The maximum number of BiCG iterations to perform.
- rtol
float,optional The relative tolerance for the BiCG solver to terminate.
- atol
float,optional The absolute tolerance for the BiCG solver to terminate.
- check_accuracybool,
optional Whether to check the accuracy of the solution.
- check_rtol
float,optional The relative tolerance to check against for accuracy.
- check_atol
float,optional The absolute tolerance to check against for accuracy.
- **kwargs
Extra keyword arguments passed to the base class.
- A
- Attributes:
AThe matrix to solve with.
TThe transposed solve operator
- atol
check_accuracyWhether the check the accuracy after a solve.
check_atolThe absolute tolerance used to check the solve operation.
check_rtolThe relative tolerance used to check the solve operation.
dtypeThe data type of the matrix.
is_hermitianWhether the matrix is hermitian.
is_positive_definiteWhether the matrix is positive definite.
is_realWhether the matrix is real.
is_symmetricWhether the matrix is symmetric.
- maxiter
- rtol
shapeThe input matrix dimensions.
Methods
conj()Return the complex conjugate version of this solver.
Return the complex conjugate version of this solver.
factor([A])(Re)factor the matrix.
solve(rhs)Solves the system of equations for the given right hand side.
Return the transposed solve operator.
clean
get_attributes