Loading [MathJax]/extensions/tex2jax.js
Cantera  3.2.0a1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PreconditionerBase Class Reference

#include <SystemJacobian.h>

Inheritance diagram for PreconditionerBase:
[legend]

Detailed Description

Deprecated:
To be removed after Cantera 3.2. Renamed to SystemJacobian.

Definition at line 229 of file SystemJacobian.h.

Additional Inherited Members

- Public Member Functions inherited from SystemJacobian
virtual const string type () const =0
 Derived type, corresponding to names registered with SystemJacobianFactory.
 
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.
 
virtual void stateAdjustment (vector< double > &state)
 Adjust the state vector based on the preconditioner, e.g., Adaptive preconditioning uses a strictly positive composition when preconditioning which is handled by this function.
 
string preconditionerSide () const
 Get preconditioner application side for CVODES.
 
virtual void setPreconditionerSide (const string &preconSide)
 For iterative solvers, set the side where the preconditioner is applied.
 
virtual void updatePreconditioner ()
 Transform Jacobian vector and write into preconditioner, P = (I - gamma * J)
 
virtual void updateTransient (double rdt, int *mask)
 Update the diagonal terms in the Jacobian by using the transient mask \( \alpha \).
 
virtual void solve (const size_t stateSize, double *rhs_vector, double *output)
 Solve a linear system using the system matrix M
 
virtual void setup ()
 Perform preconditioner specific post-reactor setup operations such as factorize.
 
virtual void reset ()
 Reset parameters as needed.
 
virtual void initialize (size_t networkSize)
 Called during setup for any processes that need to be completed prior to setup functions used in sundials.
 
virtual void setBandwidth (size_t bw)
 Used to provide system bandwidth for implementations that use banded matrix storage.
 
virtual void printPreconditioner ()
 Print preconditioner contents.
 
virtual void setGamma (double gamma)
 Set gamma used in preconditioning.
 
virtual double gamma ()
 Get gamma used in preconditioning.
 
virtual void setAbsoluteTolerance (double atol)
 Set the absolute tolerance in the solver outside of the network initialization.
 
virtual int info () const
 Get latest status of linear solver.
 
double elapsedTime () const
 Elapsed CPU time spent computing the Jacobian elements.
 
void updateElapsed (double evalTime)
 Increase the elapsed time by the specified time.
 
int nEvals () const
 Number of Jacobian evaluations.
 
void incrementEvals ()
 Increment the number of times the Jacobian has been evaluated.
 
int age () const
 Number of times 'incrementAge' has been called since the last evaluation.
 
void incrementAge ()
 Increment the Jacobian age.
 
void setAge (int age)
 Set the Jacobian age.
 
void clearStats ()
 Clear collected stats about number of Jacobian evaluations, CPU time spent on Jacobian updates, and the number of Newton steps that have been taken since updating the Jacobian.
 
- Protected Member Functions inherited from SystemJacobian
virtual void factorize ()
 Factorize the system matrix.
 
- Protected Attributes inherited from SystemJacobian
size_t m_dim
 Dimension of the system.
 
double m_gamma = 1.0
 gamma value used in M = I - gamma*J
 
bool m_init = false
 bool saying whether or not the system is initialized
 
double m_atol = 0
 Absolute tolerance of the ODE solver.
 
double m_elapsed = 0.0
 Elapsed CPU time taken to compute the Jacobian.
 
int m_nevals = 0
 Number of Jacobian evaluations.
 
int m_age = 100000
 Age of the Jacobian (times incrementAge() has been called)
 
string m_precon_side = "none"
 For iterative solvers, side of the system to apply the preconditioner on.
 

Constructor & Destructor Documentation

◆ PreconditionerBase()

PreconditionerBase ( )
inlineprivate

Definition at line 231 of file SystemJacobian.h.


The documentation for this class was generated from the following file: