PreconditionerBase.h Source File#
PreconditionerBase.h
Go to the documentation of this file.
An error indicating that an unimplemented function has been called.
Definition ctexceptions.h:195
PreconditionerBase serves as an abstract type to extend different preconditioners.
Definition PreconditionerBase.h:31
virtual void setGamma(double gamma)
Set gamma used in preconditioning.
Definition PreconditionerBase.h:100
string preconditionerSide() const
Get preconditioner application side for CVODES.
Definition PreconditionerBase.h:54
virtual void setup()
Perform preconditioner specific post-reactor setup operations such as factorize.
Definition PreconditionerBase.h:71
virtual void solve(const size_t stateSize, double *rhs_vector, double *output)
Solve a linear system Ax=b where A is the preconditioner.
Definition PreconditionerBase.h:66
virtual void stateAdjustment(vector< double > &state)
Adjust the state vector based on the preconditioner, e.g., Adaptive preconditioning uses a strictly p...
Definition PreconditionerBase.h:49
bool m_init
bool saying whether or not the preconditioner is initialized
Definition PreconditionerBase.h:123
virtual void initialize(size_t networkSize)
Called during setup for any processes that need to be completed prior to setup functions used in sund...
Definition PreconditionerBase.h:83
virtual void setAbsoluteTolerance(double atol)
Set the absolute tolerance in the solver outside of the network initialization.
Definition PreconditionerBase.h:111
virtual void setValue(size_t row, size_t col, double value)
Set a value at the specified row and column of the jacobian triplet vector.
Definition PreconditionerBase.h:41
virtual void updatePreconditioner()
Transform Jacobian vector and write into preconditioner, P = (I - gamma * J)
Definition PreconditionerBase.h:94
Definitions for the classes that are thrown when Cantera experiences an error condition (also contain...
PreconditionerSide
Specifies the side of the system on which the preconditioner is applied.
Definition PreconditionerBase.h:22
Generated by