| Cantera 3.0.0

Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
MultiJac Class Reference
One-Dimensional Reacting Flows » Utilities | Derivative Calculations

Class MultiJac evaluates the Jacobian of a system of equations defined by a residual function supplied by an instance of class OneDim. More...

`#include <MultiJac.h>`

Inheritance diagram for MultiJac:
[legend]

## Detailed Description

Class MultiJac evaluates the Jacobian of a system of equations defined by a residual function supplied by an instance of class OneDim.

The residual function may consist of several linked 1D domains, with different variables in each domain.

Definition at line 23 of file MultiJac.h.

## Public Member Functions
| MultiJac (OneDim &r)
void | eval (double *x0, double *resid0, double rdt)
| Evaluate the Jacobian at x0.
double | elapsedTime () const
| Elapsed CPU time spent computing the Jacobian.
int | nEvals () const
| Number of Jacobian evaluations.
int | age () const
| Number of times 'incrementAge' has been called since the last evaluation.
void | incrementAge ()
| Increment the Jacobian age.
void | updateTransient (double rdt, integer *mask)
void | setAge (int age)
| Set the Jacobian age.
vector< int > & | transientMask ()
void | incrementDiagonal (int j, double d)
Public Member Functions inherited from BandMatrix
| BandMatrix ()
| Base Constructor.
| BandMatrix (size_t n, size_t kl, size_t ku, double v=0.0)
| Creates a banded matrix and sets all elements to zero.
| BandMatrix (const BandMatrix &y)
BandMatrix & | operator= (const BandMatrix &y)
void | resize (size_t n, size_t kl, size_t ku, double v=0.0)
| Resize the matrix problem.
void | bfill (double v=0.0)
| Fill or zero the matrix.
double & | operator() (size_t i, size_t j) override
| Index into the (i,j) element.
double | operator() (size_t i, size_t j) const override
| Constant Index into the (i,j) element.
double & | value (size_t i, size_t j)
| Return a changeable reference to element (i,j).
double | value (size_t i, size_t j) const
| Return the value of element (i,j).
size_t | index (size_t i, size_t j) const
| Returns the location in the internal 1D array corresponding to the (i,j) element in the banded array.
double | _value (size_t i, size_t j) const
| Return the value of the (i,j) element for (i,j) within the bandwidth.
size_t | nRows () const override
| Return the number of rows in the matrix.
size_t | nColumns () const
| Number of columns.
size_t | nSubDiagonals () const
| Number of subdiagonals.
size_t | nSuperDiagonals () const
| Number of superdiagonals.
size_t | ldim () const
| Return the number of rows of storage needed for the band storage.
void | mult (const double *b, double *prod) const override
| Multiply A*b and write result to `prod`.
void | leftMult (const double *const b, double *const prod) const override
| Multiply b*A and write result to prod.
int | factor () override
| Perform an LU decomposition, the LAPACK routine DGBTRF is used.
int | solve (const double *const b, double *const x)
| Solve the matrix problem Ax = b.
int | solve (double *b, size_t nrhs=1, size_t ldb=0) override
| Solve the matrix problem Ax = b.
vector< double >::iterator | begin () override
| Returns an iterator for the start of the band storage data.
vector< double >::iterator | end ()
| Returns an iterator for the end of the band storage data.
vector< double >::const_iterator | begin () const override
| Returns a const iterator for the start of the band storage data.
vector< double >::const_iterator | end () const
| Returns a const iterator for the end of the band storage data.
void | zero () override
| Zero the matrix elements.
double | rcond (double a1norm) override
| Returns an estimate of the inverse of the condition number for the matrix.
int | factorAlgorithm () const override
| Returns the factor algorithm used.
double | oneNorm () const override
| Returns the one norm of the matrix.
double * | ptrColumn (size_t j) override
| Return a pointer to the top of column j.
double *const * | colPts () override
| Return a vector of const pointers to the columns.
size_t | checkRows (double &valueSmall) const override
| Check to see if we have any zero rows in the Jacobian.
size_t | checkColumns (double &valueSmall) const override
| Check to see if we have any zero columns in the Jacobian.
int | info () const
| LAPACK "info" flag after last factor/solve operation.
Public Member Functions inherited from GeneralMatrix
| GeneralMatrix ()=default
| Base Constructor.
virtual int | factorQR ()
| Factors the A matrix using the QR algorithm, overwriting A.
virtual double | rcondQR ()
| Returns an estimate of the inverse of the condition number for the matrix.
virtual void | useFactorAlgorithm (int fAlgorithm)
| Change the way the matrix is factored.
virtual void | clearFactorFlag ()
| clear the factored flag
virtual bool | factored () const
| true if the current factorization is up to date with the matrix

## Protected Attributes
OneDim * | m_resid
| Residual evaluator for this Jacobian.
vector< double > | m_r1
double | m_rtol = 1e-5
double | m_atol = sqrt(std::numeric_limits<double>::epsilon())
double | m_elapsed = 0.0
vector< double > | m_ssdiag
vector< int > | m_mask
int | m_nevals = 0
int | m_age = 100000
size_t | m_size
size_t | m_points
Protected Attributes inherited from BandMatrix
vector< double > | data
| Matrix data.
vector< double > | ludata
| Factorized data.
size_t | m_n = 0
| Number of rows and columns of the matrix.
size_t | m_kl = 0
| Number of subdiagonals of the matrix.
size_t | m_ku = 0
| Number of super diagonals of the matrix.
double | m_zero = 0
| value of zero
unique_ptr< PivData > | m_ipiv
| Pivot vector.
vector< double * > | m_colPtrs
| Vector of column pointers.
vector< double * > | m_lu_col_ptrs
vector< int > | iwork_
| Extra work array needed - size = n.
vector< double > | work_
| Extra dp work array needed - size = 3n.
int | m_info = 0
Protected Attributes inherited from GeneralMatrix
int | m_factored = false
| Indicates whether the matrix is factored.

## Constructor & Destructor Documentation

## ◆ MultiJac()

MultiJac | ( | OneDim & | r | ) |

Definition at line 12 of file MultiJac.cpp.

## Member Function Documentation

## ◆ eval()

void eval | ( | double * | x0,
|  | double * | resid0,
|  | double | rdt
| ) |  |

Evaluate the Jacobian at x0.

The unperturbed residual function is resid0, which must be supplied on input. The third parameter 'rdt' is the reciprocal of the time step. If zero, the steady-state Jacobian is evaluated.

Definition at line 36 of file MultiJac.cpp.

## ◆ elapsedTime()

double elapsedTime | ( |  | ) | const
| inline

Elapsed CPU time spent computing the Jacobian.

Definition at line 37 of file MultiJac.h.

## ◆ nEvals()

int nEvals | ( |  | ) | const
| inline

Number of Jacobian evaluations.

Definition at line 42 of file MultiJac.h.

## ◆ age()

int age | ( |  | ) | const
| inline

Number of times 'incrementAge' has been called since the last evaluation.

Definition at line 47 of file MultiJac.h.

## ◆ incrementAge()

void incrementAge | ( |  | ) |
| inline

Increment the Jacobian age.

Definition at line 52 of file MultiJac.h.

## ◆ updateTransient()

void updateTransient | ( | double | rdt,
|  | integer * | mask
| ) |  |

Definition at line 23 of file MultiJac.cpp.

## ◆ setAge()

void setAge | ( | int | age | ) |
| inline

Set the Jacobian age.

Definition at line 59 of file MultiJac.h.

## ◆ transientMask()

vector< int > & transientMask | ( |  | ) |
| inline

Definition at line 63 of file MultiJac.h.

## ◆ incrementDiagonal()

void incrementDiagonal | ( | int | j,
|  | double | d
| ) |  |

Definition at line 30 of file MultiJac.cpp.

## Member Data Documentation

## ◆ m_resid

OneDim* m_resid
| protected

Residual evaluator for this Jacobian.

This is a pointer to the residual evaluator. This object isn't owned by this Jacobian object.

Definition at line 75 of file MultiJac.h.

## ◆ m_r1

vector<double> m_r1
| protected

Definition at line 77 of file MultiJac.h.

## ◆ m_rtol

double m_rtol = 1e-5
| protected

Definition at line 78 of file MultiJac.h.

## ◆ m_atol

double m_atol = sqrt(std::numeric_limits<double>::epsilon())
| protected

Definition at line 79 of file MultiJac.h.

## ◆ m_elapsed

double m_elapsed = 0.0
| protected

Definition at line 80 of file MultiJac.h.

## ◆ m_ssdiag

vector<double> m_ssdiag
| protected

Definition at line 81 of file MultiJac.h.

## ◆ m_mask

vector<int> m_mask
| protected

Definition at line 82 of file MultiJac.h.

## ◆ m_nevals

int m_nevals = 0
| protected

Definition at line 83 of file MultiJac.h.

## ◆ m_age

int m_age = 100000
| protected

Definition at line 84 of file MultiJac.h.

## ◆ m_size

size_t m_size
| protected

Definition at line 85 of file MultiJac.h.

## ◆ m_points

size_t m_points
| protected

Definition at line 86 of file MultiJac.h.

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

- MultiJac.h
- MultiJac.cpp