#include <LinearSystem.hpp>
Public Member Functions | |
LinearSystem (PetscInt lhsVectorSize, unsigned rowPreallocation=UINT_MAX) | |
LinearSystem (Vec templateVector, unsigned rowPreallocation) | |
LinearSystem (Vec residualVector, Mat jacobianMatrix) | |
LinearSystem (PetscInt lhsVectorSize, Mat lhsMatrix, Vec rhsVector) | |
~LinearSystem () | |
void | SetMatrixElement (PetscInt row, PetscInt col, double value) |
void | AddToMatrixElement (PetscInt row, PetscInt col, double value) |
void | AssembleFinalLinearSystem () |
void | AssembleIntermediateLinearSystem () |
void | AssembleFinalLhsMatrix () |
void | AssembleFinalPrecondMatrix () |
void | AssembleIntermediateLhsMatrix () |
void | AssembleRhsVector () |
void | SetMatrixIsSymmetric (bool isSymmetric=true) |
bool | IsMatrixSymmetric () |
void | SetMatrixIsConstant (bool matrixIsConstant) |
void | SetRelativeTolerance (double relativeTolerance) |
void | SetAbsoluteTolerance (double absoluteTolerance) |
void | SetKspType (const char *kspType) |
void | SetPcType (const char *pcType, boost::shared_ptr< std::vector< PetscInt > > pBathNodes=boost::shared_ptr< std::vector< PetscInt > >()) |
void | DisplayMatrix () |
void | DisplayRhs () |
void | SetMatrixRow (PetscInt row, double value) |
Vec | GetMatrixRowDistributed (unsigned row_index) |
void | ZeroMatrixRowsWithValueOnDiagonal (std::vector< unsigned > &rRows, double diagonalValue) |
void | ZeroMatrixRowsAndColumnsWithValueOnDiagonal (std::vector< unsigned > &rRowColIndices, double diagonalValue) |
void | ZeroMatrixColumn (PetscInt col) |
void | ZeroLhsMatrix () |
void | ZeroRhsVector () |
void | ZeroLinearSystem () |
Vec | Solve (Vec lhsGuess=NULL) |
void | SetRhsVectorElement (PetscInt row, double value) |
void | AddToRhsVectorElement (PetscInt row, double value) |
unsigned | GetSize () const |
void | SetNullBasis (Vec nullbasis[], unsigned numberOfBases) |
void | RemoveNullSpace () |
Vec & | rGetRhsVector () |
Vec | GetRhsVector () const |
Mat & | rGetLhsMatrix () |
Mat | GetLhsMatrix () const |
Mat & | rGetPrecondMatrix () |
Vec & | rGetDirichletBoundaryConditionsVector () |
void | GetOwnershipRange (PetscInt &lo, PetscInt &hi) |
double | GetMatrixElement (PetscInt row, PetscInt col) |
double | GetRhsVectorElement (PetscInt row) |
unsigned | GetNumIterations () const |
template<size_t MATRIX_SIZE> | |
void | AddLhsMultipleValues (unsigned *matrixRowAndColIndices, c_matrix< double, MATRIX_SIZE, MATRIX_SIZE > &rSmallMatrix) |
template<size_t VECTOR_SIZE> | |
void | AddRhsMultipleValues (unsigned *vectorIndices, c_vector< double, VECTOR_SIZE > &smallVector) |
void | SetPrecondMatrixIsDifferentFromLhs (bool precondIsDifferent=true) |
void | SetUseFixedNumberIterations (bool useFixedNumberIterations=true, unsigned evaluateNumItsEveryNSolves=UINT_MAX) |
void | ResetKspSolver () |
Private Member Functions | |
template<class Archive> | |
void | serialize (Archive &archive, const unsigned int version) |
Private Attributes | |
Mat | mLhsMatrix |
Mat | mPrecondMatrix |
Vec | mRhsVector |
PetscInt | mSize |
PetscInt | mOwnershipRangeLo |
PetscInt | mOwnershipRangeHi |
MatNullSpace | mMatNullSpace |
bool | mDestroyMatAndVec |
KSP | mKspSolver |
bool | mKspIsSetup |
double | mNonZerosUsed |
bool | mMatrixIsConstant |
double | mTolerance |
bool | mUseAbsoluteTolerance |
std::string | mKspType |
std::string | mPcType |
Vec | mDirichletBoundaryConditionsVector |
PCBlockDiagonal * | mpBlockDiagonalPC |
PCLDUFactorisation * | mpLDUFactorisationPC |
PCTwoLevelsBlockDiagonal * | mpTwoLevelsBlockDiagonalPC |
boost::shared_ptr< std::vector < PetscInt > > | mpBathNodes |
bool | mPrecondMatrixIsNotLhs |
unsigned | mRowPreallocation |
bool | mUseFixedNumberIterations |
unsigned | mEvaluateNumItsEveryNSolves |
void * | mpConvergenceTestContext |
unsigned | mNumSolves |
PetscReal | mEigMin |
PetscReal | mEigMax |
bool | mForceSpectrumReevaluation |
Friends | |
class | TestLinearSystem |
class | TestPCBlockDiagonal |
class | TestPCTwoLevelsBlockDiagonal |
class | TestPCLDUFactorisation |
class | TestChebyshevIteration |
class | boost::serialization::access |
Definition at line 59 of file LinearSystem.hpp.
LinearSystem::LinearSystem | ( | PetscInt | lhsVectorSize, | |
unsigned | rowPreallocation = UINT_MAX | |||
) |
Constructor.
lhsVectorSize | the size of the LHS vector | |
rowPreallocation | the max number of nonzero entries expected on a row
|
Definition at line 44 of file LinearSystem.cpp.
References PetscTools::CreateVec(), EXCEPTION, mKspType, mLhsMatrix, mNumSolves, mOwnershipRangeHi, mOwnershipRangeLo, mPcType, mRhsVector, mRowPreallocation, mSize, and PetscTools::SetupMat().
LinearSystem::LinearSystem | ( | Vec | templateVector, | |
unsigned | rowPreallocation | |||
) |
Alternative constructor.
Create a linear system, where the size is based on the size of a given PETSc vec.
The LHS & RHS vectors will be created by duplicating this vector's settings. This should avoid problems with using VecScatter on bidomain simulation results.
templateVector | a PETSc vec | |
rowPreallocation | the max number of nonzero entries expected on a row |
Definition at line 136 of file LinearSystem.cpp.
References mKspType, mLhsMatrix, mNumSolves, mOwnershipRangeHi, mOwnershipRangeLo, mPcType, mRhsVector, mRowPreallocation, mSize, and PetscTools::SetupMat().
LinearSystem::LinearSystem | ( | Vec | residualVector, | |
Mat | jacobianMatrix | |||
) |
Alternative constructor.
Create a linear system which wraps the provided PETSc objects so we can access them using our API. Either of the objects may be NULL, but at least one of them must not be.
Useful for storing residuals and jacobians when solving nonlinear PDEs.
residualVector | the residual vector | |
jacobianMatrix | the Jacobian matrix |
Definition at line 177 of file LinearSystem.cpp.
References mKspType, mLhsMatrix, mNumSolves, mOwnershipRangeHi, mOwnershipRangeLo, mPcType, mRhsVector, mRowPreallocation, and mSize.
LinearSystem::LinearSystem | ( | PetscInt | lhsVectorSize, | |
Mat | lhsMatrix, | |||
Vec | rhsVector | |||
) |
Alternative constructor for archiving.
lhsVectorSize | the size of the LHS vector | |
lhsMatrix | the RHS matrix | |
rhsVector | the RHS vector |
Definition at line 99 of file LinearSystem.cpp.
References mLhsMatrix, mNumSolves, mOwnershipRangeHi, mOwnershipRangeLo, and mRhsVector.
LinearSystem::~LinearSystem | ( | ) |
Destructor.
Definition at line 241 of file LinearSystem.cpp.
References PetscTools::AmMaster(), mDestroyMatAndVec, mDirichletBoundaryConditionsVector, mKspIsSetup, mKspSolver, mLhsMatrix, mMatNullSpace, mNumSolves, mpBlockDiagonalPC, mpConvergenceTestContext, mpLDUFactorisationPC, mPrecondMatrix, mPrecondMatrixIsNotLhs, mpTwoLevelsBlockDiagonalPC, and mRhsVector.
void LinearSystem::serialize | ( | Archive & | archive, | |
const unsigned int | version | |||
) | [inline, private] |
Archive the member variables.
archive | ||
version |
Definition at line 156 of file LinearSystem.hpp.
References mKspType, mMatrixIsConstant, mNonZerosUsed, mPcType, mTolerance, and mUseAbsoluteTolerance.
void LinearSystem::SetMatrixElement | ( | PetscInt | row, | |
PetscInt | col, | |||
double | value | |||
) |
Change one of the entires of the matrix to the specified value.
row | the row index | |
col | the column index | |
value | the value for this entry |
Definition at line 298 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::SetElement().
Referenced by AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem().
void LinearSystem::AddToMatrixElement | ( | PetscInt | row, | |
PetscInt | col, | |||
double | value | |||
) |
Add the specified value to an entry of the matrix.
row | the row index | |
col | the column index | |
value | the value for this entry |
Definition at line 303 of file LinearSystem.cpp.
References PetscMatTools::AddToElement(), and mLhsMatrix.
void LinearSystem::AssembleFinalLinearSystem | ( | ) |
Call this before Solve().
This calls AssembleFinalLhsMatrix() and AssembleRhsVector().
Definition at line 308 of file LinearSystem.cpp.
References AssembleFinalLhsMatrix(), and AssembleRhsVector().
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem().
void LinearSystem::AssembleIntermediateLinearSystem | ( | ) |
Should be called before AddToMatrixElement.
This calls AssembleIntermediateLhsMatrix() and AssembleRhsVector().
Definition at line 314 of file LinearSystem.cpp.
References AssembleIntermediateLhsMatrix(), and AssembleRhsVector().
void LinearSystem::AssembleFinalLhsMatrix | ( | ) |
Sets up the PETSc matrix left-hand-side mLhsMatrix
Definition at line 320 of file LinearSystem.cpp.
References PetscMatTools::AssembleFinal(), and mLhsMatrix.
Referenced by AssembleFinalLinearSystem(), NonlinearElasticitySolver< DIM >::AssembleSystem(), CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem(), AbstractAssemblerSolverHybrid< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, INTERPOLATION_LEVEL >::SetupGivenLinearSystem(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), BasicMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), and BasicBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().
void LinearSystem::AssembleFinalPrecondMatrix | ( | ) |
Sets up the PETSc matrix used for preconditioning.
Definition at line 330 of file LinearSystem.cpp.
References PetscMatTools::AssembleFinal(), and mPrecondMatrix.
Referenced by MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().
void LinearSystem::AssembleIntermediateLhsMatrix | ( | ) |
Sets up the PETSc matrix left-hand-side mLhsMatrix
Definition at line 325 of file LinearSystem.cpp.
References PetscMatTools::AssembleIntermediate(), and mLhsMatrix.
Referenced by AssembleIntermediateLinearSystem(), NonlinearElasticitySolver< DIM >::AssembleSystem(), CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem(), AbstractAssemblerSolverHybrid< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, INTERPOLATION_LEVEL >::SetupGivenLinearSystem(), and MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().
void LinearSystem::AssembleRhsVector | ( | ) |
Sets up the PETSc vector right-hand-side mRhsVector
Definition at line 335 of file LinearSystem.cpp.
References PetscVecTools::Assemble(), and mRhsVector.
Referenced by AssembleFinalLinearSystem(), AssembleIntermediateLinearSystem(), NonlinearElasticitySolver< DIM >::AssembleSystem(), CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem(), AbstractAssemblerSolverHybrid< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, INTERPOLATION_LEVEL >::SetupGivenLinearSystem(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), BasicMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), and BasicBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().
void LinearSystem::SetMatrixIsSymmetric | ( | bool | isSymmetric = true |
) |
Force PETSc to treat the matrix in this linear system as symmetric from now on.
isSymmetric | whether the matrix is symmetric or not (defaults to true) |
Definition at line 553 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::SetOption().
Referenced by SimpleLinearEllipticSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and CellBasedSimulationWithPdesAssembler< DIM >::InitialiseForSolve().
bool LinearSystem::IsMatrixSymmetric | ( | ) |
Get whether PETSc considers the matrix in this linear system as symmetric or not.
Definition at line 577 of file LinearSystem.cpp.
References mLhsMatrix.
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem().
void LinearSystem::SetMatrixIsConstant | ( | bool | matrixIsConstant | ) |
Set mMatrixIsConstant.
matrixIsConstant | whether the matrix is constant |
Definition at line 588 of file LinearSystem.cpp.
References mMatrixIsConstant.
void LinearSystem::SetRelativeTolerance | ( | double | relativeTolerance | ) |
Set the relative tolerance.
relativeTolerance | the relative tolerance |
Definition at line 593 of file LinearSystem.cpp.
References mKspIsSetup, mKspSolver, mTolerance, and mUseAbsoluteTolerance.
Referenced by AbstractMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve().
void LinearSystem::SetAbsoluteTolerance | ( | double | absoluteTolerance | ) |
Set the absolute tolerance.
absoluteTolerance | the absolute tolerance |
Definition at line 603 of file LinearSystem.cpp.
References mKspIsSetup, mKspSolver, mTolerance, and mUseAbsoluteTolerance.
Referenced by OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve().
void LinearSystem::SetKspType | ( | const char * | kspType | ) |
Set the KSP solver type (see PETSc KSPSetType() for valid arguments).
kspType | the KSP solver type |
Definition at line 613 of file LinearSystem.cpp.
References mKspIsSetup, mKspSolver, and mKspType.
Referenced by AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem(), SimpleLinearEllipticSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve().
void LinearSystem::SetPcType | ( | const char * | pcType, | |
boost::shared_ptr< std::vector< PetscInt > > | pBathNodes = boost::shared_ptr<std::vector<PetscInt> >() | |||
) |
Set the preconditioner type (see PETSc PCSetType() for valid arguments).
pcType | the preconditioner type | |
pBathNodes | the list of nodes defining the bath |
Definition at line 623 of file LinearSystem.cpp.
References mKspIsSetup, mKspSolver, mpBathNodes, mpBlockDiagonalPC, mPcType, mpLDUFactorisationPC, mpTwoLevelsBlockDiagonalPC, and TERMINATE.
Referenced by OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve().
void LinearSystem::DisplayMatrix | ( | ) |
Display the left-hand side matrix.
Definition at line 350 of file LinearSystem.cpp.
References PetscMatTools::Display(), and mLhsMatrix.
void LinearSystem::DisplayRhs | ( | ) |
Display the right-hand side vector.
Definition at line 355 of file LinearSystem.cpp.
References PetscVecTools::Display(), and mRhsVector.
void LinearSystem::SetMatrixRow | ( | PetscInt | row, | |
double | value | |||
) |
Set all entries in a given row of a matrix to a certain value. This must be called by the process who owns the row, (but other processors will treat it as a null-op
row | the row index | |
value | the value to set each entry in this row |
Definition at line 360 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::SetRow().
Vec LinearSystem::GetMatrixRowDistributed | ( | unsigned | row_index | ) |
Returns the i-th row of the LHS matrix as a distributed PETSc Vec
row_index | the row index |
Definition at line 365 of file LinearSystem.cpp.
References PetscTools::CreateVec(), mLhsMatrix, mOwnershipRangeHi, mOwnershipRangeLo, and mSize.
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem().
void LinearSystem::ZeroMatrixRowsWithValueOnDiagonal | ( | std::vector< unsigned > & | rRows, | |
double | diagonalValue | |||
) |
Zero several rows of the matrix, putting a given value in the diagonal entries.
*Massively* less expensive than zeroing each matrix rowindividually
rRows | std::vector of rows to be zeroed | |
diagonalValue | value to put in the diagonal entries (of the zeroed rows) |
Definition at line 398 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::ZeroRowsWithValueOnDiagonal().
Referenced by AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::ApplyBoundaryConditions(), BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem().
void LinearSystem::ZeroMatrixRowsAndColumnsWithValueOnDiagonal | ( | std::vector< unsigned > & | rRowColIndices, | |
double | diagonalValue | |||
) |
Zero several rows and columns of the matrix, putting a given value on the diagonal.
rRowColIndices | A list of indices. All the rows with these indices, and all the columns with these indices, will be zeroed. | |
diagonalValue | value to put in the diagonal entries (of the zeroed rows) |
Definition at line 404 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::ZeroRowsAndColumnsWithValueOnDiagonal().
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem().
void LinearSystem::ZeroMatrixColumn | ( | PetscInt | col | ) |
Zero a column of the left-hand side matrix.
Unfortunately there is no equivalent method in Petsc, so this has to be done carefully to ensure that the sparsity structure of the matrix is not broken. Only owned entries which are non-zero are zeroed.
col | the column index |
Definition at line 409 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::ZeroColumn().
void LinearSystem::ZeroLhsMatrix | ( | ) |
Zero all entries of the left-hand side matrix.
Definition at line 419 of file LinearSystem.cpp.
References mLhsMatrix, and PetscMatTools::Zero().
Referenced by NonlinearElasticitySolver< DIM >::AssembleSystem(), CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem(), and ZeroLinearSystem().
void LinearSystem::ZeroRhsVector | ( | ) |
Zero all entries of the right-hand side vector.
Definition at line 414 of file LinearSystem.cpp.
References mRhsVector, and PetscVecTools::Zero().
Referenced by NonlinearElasticitySolver< DIM >::AssembleSystem(), CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem(), and ZeroLinearSystem().
void LinearSystem::ZeroLinearSystem | ( | ) |
Zero all entries of the left-hand side matrix and right-hand side vector.
Definition at line 424 of file LinearSystem.cpp.
References ZeroLhsMatrix(), and ZeroRhsVector().
Referenced by SimpleNewtonNonlinearSolver::Solve().
Vec LinearSystem::Solve | ( | Vec | lhsGuess = NULL |
) |
Solve the linear system.
lhsGuess | an optional initial guess for the solution (defaults to NULL) |
Definition at line 683 of file LinearSystem.cpp.
References PetscTools::AmMaster(), GenericEventHandler< 13, HeartEventHandler >::BeginEvent(), GenericEventHandler< 13, HeartEventHandler >::EndEvent(), EXCEPTION, mEigMax, mEigMin, mEvaluateNumItsEveryNSolves, mForceSpectrumReevaluation, mKspIsSetup, mKspSolver, mKspType, mLhsMatrix, mMatNullSpace, mMatrixIsConstant, mNonZerosUsed, mNumSolves, mpBathNodes, mpBlockDiagonalPC, mpConvergenceTestContext, mPcType, mpLDUFactorisationPC, mPrecondMatrix, mPrecondMatrixIsNotLhs, mpTwoLevelsBlockDiagonalPC, mRhsVector, mSize, mTolerance, mUseAbsoluteTolerance, mUseFixedNumberIterations, Timer::Print(), Timer::Reset(), and TERMINATE.
Referenced by AbstractStaticLinearPdeSolver< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Solve(), AbstractDynamicLinearPdeSolver< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Solve(), and SimpleNewtonNonlinearSolver::Solve().
void LinearSystem::SetRhsVectorElement | ( | PetscInt | row, | |
double | value | |||
) |
Set an element of the right-hand side vector to a given value.
row | the row index | |
value | the value to set this entry |
Definition at line 340 of file LinearSystem.cpp.
References mRhsVector, and PetscVecTools::SetElement().
Referenced by AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::ApplyBoundaryConditions(), BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem().
void LinearSystem::AddToRhsVectorElement | ( | PetscInt | row, | |
double | value | |||
) |
Add a value to an element of the right-hand side vector.
row | the row index | |
value | the value to set this entry |
Definition at line 345 of file LinearSystem.cpp.
References PetscVecTools::AddToElement(), and mRhsVector.
unsigned LinearSystem::GetSize | ( | ) | const |
Get method for mSize.
Definition at line 430 of file LinearSystem.cpp.
References mSize.
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem().
void LinearSystem::SetNullBasis | ( | Vec | nullbasis[], | |
unsigned | numberOfBases | |||
) |
Set the null basis of the linear system. In debug mode we test for orthonormality and throw EXCEPTIONs:
nullbasis | an array PETSc vectors containing orthogonal directions in the nullspace | |
numberOfBases | the number of directions (size of nullbasis array) |
Definition at line 435 of file LinearSystem.cpp.
References EXCEPTION, and mMatNullSpace.
Referenced by AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem().
void LinearSystem::RemoveNullSpace | ( | ) |
Remove the null space from the linear system.
Use for example if Dirichlet BC are applied to a singular system and, therefore, there's no null space anymore.
Definition at line 475 of file LinearSystem.cpp.
References mKspIsSetup, mKspSolver, and mMatNullSpace.
Referenced by BidomainProblem< DIM >::AtBeginningOfTimestep().
Vec & LinearSystem::rGetRhsVector | ( | ) |
Get access to the RHS vector directly. Shouldn't generally need to be called.
Definition at line 518 of file LinearSystem.cpp.
References mRhsVector.
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::CalculateResidualNorm(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::CheckCompatibilityCondition(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractAssemblerSolverHybrid< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, INTERPOLATION_LEVEL >::SetupGivenLinearSystem(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), BasicMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), BasicBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), SimpleNewtonNonlinearSolver::Solve(), and AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::TakeNewtonStep().
Vec LinearSystem::GetRhsVector | ( | ) | const |
Get access to the RHS vector for archiving
Definition at line 523 of file LinearSystem.cpp.
References mRhsVector.
Mat & LinearSystem::rGetLhsMatrix | ( | ) |
Get access to the LHS matrix directly. Shouldn't generally need to be called.
Definition at line 528 of file LinearSystem.cpp.
References mLhsMatrix.
Referenced by AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::AllocateMatrixMemory(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath(), AbstractAssemblerSolverHybrid< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM, INTERPOLATION_LEVEL >::SetupGivenLinearSystem(), OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), BasicMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), BasicBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem(), SimpleNewtonNonlinearSolver::Solve(), and AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::TakeNewtonStep().
Mat LinearSystem::GetLhsMatrix | ( | ) | const |
Get access to the LHS matrix for archiving
Definition at line 533 of file LinearSystem.cpp.
References mLhsMatrix.
Referenced by AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath().
Mat & LinearSystem::rGetPrecondMatrix | ( | ) |
Get access to the matrix used for preconditioning.
Definition at line 538 of file LinearSystem.cpp.
References EXCEPTION, mPrecondMatrix, and mPrecondMatrixIsNotLhs.
Referenced by MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().
Vec & LinearSystem::rGetDirichletBoundaryConditionsVector | ( | ) |
Get access to the dirichlet boundary conditions vector.
Should only be used by the BoundaryConditionsContainer.
Definition at line 548 of file LinearSystem.cpp.
References mDirichletBoundaryConditionsVector.
Referenced by BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem().
void LinearSystem::GetOwnershipRange | ( | PetscInt & | lo, | |
PetscInt & | hi | |||
) |
Get this process's ownership range of the contents of the system.
lo | lowest index owned by this process | |
hi | highest index owned by this process |
Definition at line 491 of file LinearSystem.cpp.
References mOwnershipRangeHi, and mOwnershipRangeLo.
Referenced by AbstractNonlinearElasticitySolver< COMPRESSIBILITY_TYPE, DIM >::AllocateMatrixMemory(), BoundaryConditionsContainer< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::ApplyDirichletToLinearProblem(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath().
double LinearSystem::GetMatrixElement | ( | PetscInt | row, | |
PetscInt | col | |||
) |
Return an element of the matrix. May only be called for elements you own.
row | the row index | |
col | the column index |
Definition at line 497 of file LinearSystem.cpp.
References PetscMatTools::GetElement(), and mLhsMatrix.
Referenced by AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath().
double LinearSystem::GetRhsVectorElement | ( | PetscInt | row | ) |
Return an element of the RHS vector. May only be called for elements you own.
row | the row index |
Definition at line 502 of file LinearSystem.cpp.
References PetscVecTools::GetElement(), and mRhsVector.
unsigned LinearSystem::GetNumIterations | ( | ) | const |
Return the number of iterations taken by the last Solve()
Definition at line 507 of file LinearSystem.cpp.
References mKspIsSetup, and mKspSolver.
void LinearSystem::AddLhsMultipleValues | ( | unsigned * | matrixRowAndColIndices, | |
c_matrix< double, MATRIX_SIZE, MATRIX_SIZE > & | rSmallMatrix | |||
) | [inline] |
Add multiple values to the matrix of linear system.
matrixRowAndColIndices | mapping from index of the ublas matrix (see param below) to index of the Petsc matrix of this linear system | |
rSmallMatrix | Ublas matrix containing the values to be added |
Definition at line 531 of file LinearSystem.hpp.
References PetscMatTools::AddMultipleValues(), and mLhsMatrix.
Referenced by NonlinearElasticitySolver< DIM >::AssembleSystem(), and CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem().
void LinearSystem::AddRhsMultipleValues | ( | unsigned * | vectorIndices, | |
c_vector< double, VECTOR_SIZE > & | smallVector | |||
) | [inline] |
Add multiple values to the RHS vector.
vectorIndices | mapping from index of the ublas vector (see param below) to index of the vector of this linear system | |
smallVector | Ublas vector containing the values to be added |
Definition at line 546 of file LinearSystem.hpp.
References PetscVecTools::AddMultipleValues(), and mRhsVector.
Referenced by NonlinearElasticitySolver< DIM >::AssembleSystem(), and CompressibleNonlinearElasticitySolver< DIM >::AssembleSystem().
void LinearSystem::SetPrecondMatrixIsDifferentFromLhs | ( | bool | precondIsDifferent = true |
) |
Set method for mPrecondMatrixIsNotLhs.
precondIsDifferent | whether the matrix used for preconditioning is the same as the LHS. |
Definition at line 1138 of file LinearSystem.cpp.
References mOwnershipRangeHi, mOwnershipRangeLo, mPrecondMatrix, mPrecondMatrixIsNotLhs, mRowPreallocation, mSize, NEVER_REACHED, and PetscTools::SetupMat().
Referenced by MatrixBasedMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().
void LinearSystem::SetUseFixedNumberIterations | ( | bool | useFixedNumberIterations = true , |
|
unsigned | evaluateNumItsEveryNSolves = UINT_MAX | |||
) |
Set method for mUseFixedNumberIterations
useFixedNumberIterations | whether to use fixed number of iterations | |
evaluateNumItsEveryNSolves | tells LinearSystem to perform a solve with convergence-based stop criteria every n solves to decide how many iterations perform for the next n-1 solves. Default is perfoming a single evaluation at the beginning of the simulation. |
Definition at line 1163 of file LinearSystem.cpp.
References mEvaluateNumItsEveryNSolves, and mUseFixedNumberIterations.
Referenced by OperatorSplittingMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), AbstractMonodomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve().
void LinearSystem::ResetKspSolver | ( | ) |
Method to regenerate all KSP objects, including the solver and the preconditioner (e.g. after changing the PDE time step when using time adaptivity).
Definition at line 1170 of file LinearSystem.cpp.
References mForceSpectrumReevaluation, mKspIsSetup, and mKspSolver.
Referenced by AbstractDynamicLinearPdeSolver< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::Solve().
friend class boost::serialization::access [friend] |
Needed for serialization.
Definition at line 148 of file LinearSystem.hpp.
Mat LinearSystem::mLhsMatrix [private] |
The left-hand side matrix.
Definition at line 69 of file LinearSystem.hpp.
Referenced by AddLhsMultipleValues(), AddToMatrixElement(), AssembleFinalLhsMatrix(), AssembleIntermediateLhsMatrix(), DisplayMatrix(), GetLhsMatrix(), GetMatrixElement(), GetMatrixRowDistributed(), IsMatrixSymmetric(), LinearSystem(), rGetLhsMatrix(), SetMatrixElement(), SetMatrixIsSymmetric(), SetMatrixRow(), Solve(), ZeroLhsMatrix(), ZeroMatrixColumn(), ZeroMatrixRowsAndColumnsWithValueOnDiagonal(), ZeroMatrixRowsWithValueOnDiagonal(), and ~LinearSystem().
Mat LinearSystem::mPrecondMatrix [private] |
The matrix used for preconditioning.
Definition at line 70 of file LinearSystem.hpp.
Referenced by AssembleFinalPrecondMatrix(), rGetPrecondMatrix(), SetPrecondMatrixIsDifferentFromLhs(), Solve(), and ~LinearSystem().
Vec LinearSystem::mRhsVector [private] |
The right-hand side vector.
Definition at line 71 of file LinearSystem.hpp.
Referenced by AddRhsMultipleValues(), AddToRhsVectorElement(), AssembleRhsVector(), DisplayRhs(), GetRhsVector(), GetRhsVectorElement(), LinearSystem(), rGetRhsVector(), SetRhsVectorElement(), Solve(), ZeroRhsVector(), and ~LinearSystem().
PetscInt LinearSystem::mSize [private] |
The size of the linear system.
Definition at line 72 of file LinearSystem.hpp.
Referenced by GetMatrixRowDistributed(), GetSize(), LinearSystem(), SetPrecondMatrixIsDifferentFromLhs(), and Solve().
PetscInt LinearSystem::mOwnershipRangeLo [private] |
Definition at line 78 of file LinearSystem.hpp.
Referenced by GetMatrixRowDistributed(), GetOwnershipRange(), LinearSystem(), and SetPrecondMatrixIsDifferentFromLhs().
PetscInt LinearSystem::mOwnershipRangeHi [private] |
Stores one more than the highest index stored locally.
Definition at line 79 of file LinearSystem.hpp.
Referenced by GetMatrixRowDistributed(), GetOwnershipRange(), LinearSystem(), and SetPrecondMatrixIsDifferentFromLhs().
MatNullSpace LinearSystem::mMatNullSpace [private] |
PETSc null matrix.
Definition at line 81 of file LinearSystem.hpp.
Referenced by RemoveNullSpace(), SetNullBasis(), Solve(), and ~LinearSystem().
bool LinearSystem::mDestroyMatAndVec [private] |
Whether we need to destroy the PETSc matrix and vector in our destructor
Definition at line 84 of file LinearSystem.hpp.
Referenced by ~LinearSystem().
KSP LinearSystem::mKspSolver [private] |
The PETSc linear solver object
Definition at line 86 of file LinearSystem.hpp.
Referenced by GetNumIterations(), RemoveNullSpace(), ResetKspSolver(), SetAbsoluteTolerance(), SetKspType(), SetPcType(), SetRelativeTolerance(), Solve(), and ~LinearSystem().
bool LinearSystem::mKspIsSetup [private] |
Used by Solve method to track whether KSP has been used.
Definition at line 87 of file LinearSystem.hpp.
Referenced by GetNumIterations(), RemoveNullSpace(), ResetKspSolver(), SetAbsoluteTolerance(), SetKspType(), SetPcType(), SetRelativeTolerance(), Solve(), and ~LinearSystem().
double LinearSystem::mNonZerosUsed [private] |
Yes, it really is stored as a double.
Definition at line 88 of file LinearSystem.hpp.
Referenced by serialize(), and Solve().
bool LinearSystem::mMatrixIsConstant [private] |
Whether the matrix is unchanged each time Solve() is called
Definition at line 89 of file LinearSystem.hpp.
Referenced by serialize(), SetMatrixIsConstant(), and Solve().
double LinearSystem::mTolerance [private] |
absolute or relative tolerance of the KSP solver
Definition at line 90 of file LinearSystem.hpp.
Referenced by serialize(), SetAbsoluteTolerance(), SetRelativeTolerance(), and Solve().
bool LinearSystem::mUseAbsoluteTolerance [private] |
Sets either absolute or relative tolerance of the KSP solver. Default is to false
Definition at line 95 of file LinearSystem.hpp.
Referenced by serialize(), SetAbsoluteTolerance(), SetRelativeTolerance(), and Solve().
std::string LinearSystem::mKspType [private] |
KSP solver type (see PETSc KSPSetType() )
Definition at line 96 of file LinearSystem.hpp.
Referenced by LinearSystem(), serialize(), SetKspType(), and Solve().
std::string LinearSystem::mPcType [private] |
Preconditioner type (see PETSc PCSetType() )
Definition at line 97 of file LinearSystem.hpp.
Referenced by LinearSystem(), serialize(), SetPcType(), and Solve().
Vec LinearSystem::mDirichletBoundaryConditionsVector [private] |
Storage for efficient application of Dirichlet BCs, see AbstractBoundaryConditionsContainer
Definition at line 99 of file LinearSystem.hpp.
Referenced by rGetDirichletBoundaryConditionsVector(), and ~LinearSystem().
PCBlockDiagonal* LinearSystem::mpBlockDiagonalPC [private] |
Definition at line 103 of file LinearSystem.hpp.
Referenced by SetPcType(), Solve(), and ~LinearSystem().
Stores a pointer to a purpose-build preconditioner
Definition at line 105 of file LinearSystem.hpp.
Referenced by SetPcType(), Solve(), and ~LinearSystem().
Stores a pointer to a purpose-build preconditioner
Definition at line 107 of file LinearSystem.hpp.
Referenced by SetPcType(), Solve(), and ~LinearSystem().
boost::shared_ptr<std::vector<PetscInt> > LinearSystem::mpBathNodes [private] |
Pointer to vector containing a list of bath nodes
Definition at line 110 of file LinearSystem.hpp.
Referenced by SetPcType(), and Solve().
bool LinearSystem::mPrecondMatrixIsNotLhs [private] |
Whether the matrix used for preconditioning is the same as the LHS
Definition at line 113 of file LinearSystem.hpp.
Referenced by rGetPrecondMatrix(), SetPrecondMatrixIsDifferentFromLhs(), Solve(), and ~LinearSystem().
unsigned LinearSystem::mRowPreallocation [private] |
The max number of nonzero entries expected on a LHS row
Definition at line 116 of file LinearSystem.hpp.
Referenced by LinearSystem(), and SetPrecondMatrixIsDifferentFromLhs().
bool LinearSystem::mUseFixedNumberIterations [private] |
Whether to use fixed number of iterations
Definition at line 119 of file LinearSystem.hpp.
Referenced by SetUseFixedNumberIterations(), and Solve().
unsigned LinearSystem::mEvaluateNumItsEveryNSolves [private] |
When using fixed number of iterations, a solve with residual-based stop criteria will be performed every mEvaluateNumItsEveryNSolves solves to decide how many iterations perform for the next mEvaluateNumItsEveryNSolves-1 solves
Definition at line 126 of file LinearSystem.hpp.
Referenced by SetUseFixedNumberIterations(), and Solve().
void* LinearSystem::mpConvergenceTestContext [private] |
Context for KSPDefaultConverged()
Definition at line 129 of file LinearSystem.hpp.
Referenced by Solve(), and ~LinearSystem().
unsigned LinearSystem::mNumSolves [private] |
Number of solves performed since the current object was created
Definition at line 132 of file LinearSystem.hpp.
Referenced by LinearSystem(), Solve(), and ~LinearSystem().
PetscReal LinearSystem::mEigMin [private] |
Preconditioned operator smallest eigenvalue
Definition at line 135 of file LinearSystem.hpp.
Referenced by Solve().
PetscReal LinearSystem::mEigMax [private] |
Preconditioned operator largest eigenvalue
Definition at line 138 of file LinearSystem.hpp.
Referenced by Solve().
bool LinearSystem::mForceSpectrumReevaluation [private] |
Under certain circunstances you have to reevaluate the spectrum before the k*n-th, k=0,1,..., iteration
Definition at line 141 of file LinearSystem.hpp.
Referenced by ResetKspSolver(), and Solve().