Cantera  2.1.2
GeneralMatrix Class Referenceabstract

Generic matrix. More...

#include <GeneralMatrix.h>

Inheritance diagram for GeneralMatrix:
[legend]

## Public Member Functions

GeneralMatrix (int matType)
Base Constructor. More...

GeneralMatrix (const GeneralMatrix &right)
Copy Constructor. More...

GeneralMatrixoperator= (const GeneralMatrix &right)
Assignment operator. More...

virtual ~GeneralMatrix ()
Destructor. Does nothing. More...

virtual GeneralMatrixduplMyselfAsGeneralMatrix () const =0
Duplicator member function. More...

virtual void zero ()=0
Zero the matrix elements. More...

virtual void mult (const doublereal *b, doublereal *prod) const =0
Multiply A*b and write result to prod. More...

virtual void leftMult (const doublereal *const b, doublereal *const prod) const =0
Multiply b*A and write result to prod. More...

virtual int factor ()=0
Factors the A matrix, overwriting A. More...

virtual int factorQR ()=0
Factors the A matrix using the QR algorithm, overwriting A. More...

virtual doublereal rcondQR ()=0
Returns an estimate of the inverse of the condition number for the matrix. More...

virtual doublereal rcond (doublereal a1norm)=0
Returns an estimate of the inverse of the condition number for the matrix. More...

virtual void useFactorAlgorithm (int fAlgorithm)=0
Change the way the matrix is factored. More...

virtual int factorAlgorithm () const =0
Return the factor algorithm used. More...

virtual doublereal oneNorm () const =0
Calculate the one norm of the matrix. More...

virtual size_t nRows () const =0
Return the number of rows in the matrix. More...

virtual size_t nRowsAndStruct (size_t *const iStruct=0) const =0
Return the size and structure of the matrix. More...

virtual void clearFactorFlag ()=0
clear the factored flag More...

virtual int solve (doublereal *b)=0
Solves the Ax = b system returning x in the b spot. More...

virtual bool factored () const =0
true if the current factorization is up to date with the matrix More...

virtual doublereal * ptrColumn (size_t j)=0
Return a pointer to the top of column j, columns are assumed to be contiguous in memory. More...

virtual doublereal & operator() (size_t i, size_t j)=0
Index into the (i,j) element. More...

virtual doublereal operator() (size_t i, size_t j) const =0
Constant Index into the (i,j) element. More...

virtual void copyData (const GeneralMatrix &y)=0
Copy the data from one array into another without doing any checking. More...

virtual vector_fp::iterator begin ()=0
Return an iterator pointing to the first element. More...

virtual vector_fp::const_iterator begin () const =0
Return a const iterator pointing to the first element. More...

virtual doublereal *const * colPts ()=0
Return a vector of const pointers to the columns. More...

virtual size_t checkRows (doublereal &valueSmall) const =0
Check to see if we have any zero rows in the jacobian. More...

virtual size_t checkColumns (doublereal &valueSmall) const =0
Check to see if we have any zero columns in the jacobian. More...

## Public Attributes

int matrixType_
Matrix type. More...

## Detailed Description

Generic matrix.

Definition at line 23 of file GeneralMatrix.h.

## Constructor & Destructor Documentation

 GeneralMatrix ( int matType )

Base Constructor.

Parameters
 matType Matrix type 0 full 1 banded

Definition at line 18 of file GeneralMatrix.cpp.

 GeneralMatrix ( const GeneralMatrix & right )

Copy Constructor.

Definition at line 23 of file GeneralMatrix.cpp.

 ~GeneralMatrix ( )
virtual

Destructor. Does nothing.

Definition at line 37 of file GeneralMatrix.cpp.

## Member Function Documentation

 GeneralMatrix & operator= ( const GeneralMatrix & right )

Assignment operator.

Definition at line 28 of file GeneralMatrix.cpp.

References GeneralMatrix::matrixType_.

Referenced by SquareMatrix::operator=(), and BandMatrix::operator=().

 virtual GeneralMatrix* duplMyselfAsGeneralMatrix ( ) const
pure virtual

Duplicator member function.

This function will duplicate the matrix given a generic GeneralMatrix

Returns
Returns a pointer to the malloced object

Implemented in BandMatrix, and SquareMatrix.

 virtual void zero ( )
pure virtual

Zero the matrix elements.

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual void mult ( const doublereal * b, doublereal * prod ) const
pure virtual

Multiply A*b and write result to prod.

Parameters
 b Vector to do the rh multiplication prod OUTPUT vector to receive the result

Implemented in BandMatrix.

 virtual void leftMult ( const doublereal *const b, doublereal *const prod ) const
pure virtual

Multiply b*A and write result to prod.

Parameters
 b Vector to do the lh multiplication prod OUTPUT vector to receive the result

Implemented in BandMatrix, and SquareMatrix.

 virtual int factor ( )
pure virtual

Factors the A matrix, overwriting A.

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual int factorQR ( )
pure virtual

Factors the A matrix using the QR algorithm, overwriting A.

we set m_factored to 2 to indicate the matrix is now QR factored

Returns
Returns the info variable from lapack

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual doublereal rcondQR ( )
pure virtual

Returns an estimate of the inverse of the condition number for the matrix.

The matrix must have been previously factored using the QR algorithm

Returns
returns the inverse of the condition number

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual doublereal rcond ( doublereal a1norm )
pure virtual

Returns an estimate of the inverse of the condition number for the matrix.

The matrix must have been previously factored using the LU algorithm

Parameters
 a1norm Norm of the matrix
Returns
returns the inverse of the condition number

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual void useFactorAlgorithm ( int fAlgorithm )
pure virtual

Change the way the matrix is factored.

Parameters
 fAlgorithm integer 0 LU factorization 1 QR factorization

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual int factorAlgorithm ( ) const
pure virtual

Return the factor algorithm used.

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual doublereal oneNorm ( ) const
pure virtual

Calculate the one norm of the matrix.

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::doAffineNewtonSolve().

 virtual size_t nRows ( ) const
pure virtual

Return the number of rows in the matrix.

Implemented in BandMatrix, and SquareMatrix.

 virtual size_t nRowsAndStruct ( size_t *const iStruct = 0 ) const
pure virtual

Return the size and structure of the matrix.

Parameters
 iStruct OUTPUT Pointer to a vector of ints that describe the structure of the matrix.
Returns
returns the number of rows and columns in the matrix.

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::beuler_jac(), and NonlinearSolver::scaleMatrix().

 virtual void clearFactorFlag ( )
pure virtual

clear the factored flag

Implemented in BandMatrix, and SquareMatrix.

Referenced by BEulerInt::beuler_jac(), and NonlinearSolver::beuler_jac().

 virtual int solve ( doublereal * b )
pure virtual

Solves the Ax = b system returning x in the b spot.

Parameters
 b Vector for the rhs of the equation system

Implemented in BandMatrix, and SquareMatrix.

 virtual bool factored ( ) const
pure virtual

true if the current factorization is up to date with the matrix

Implemented in BandMatrix, and SquareMatrix.

 virtual doublereal* ptrColumn ( size_t j )
pure virtual

Return a pointer to the top of column j, columns are assumed to be contiguous in memory.

Parameters
 j Value of the column
Returns
Returns a pointer to the top of the column

Implemented in BandMatrix, and SquareMatrix.

 virtual doublereal& operator() ( size_t i, size_t j )
pure virtual

Index into the (i,j) element.

Parameters
 i row j column

Returns a changeable reference to the matrix entry

Implemented in SquareMatrix, and BandMatrix.

 virtual doublereal operator() ( size_t i, size_t j ) const
pure virtual

Constant Index into the (i,j) element.

Parameters
 i row j column

Returns an unchangeable reference to the matrix entry

Implemented in SquareMatrix, and BandMatrix.

 virtual void copyData ( const GeneralMatrix & y )
pure virtual

Copy the data from one array into another without doing any checking.

This differs from the assignment operator as no resizing is done and memcpy() is used.

Parameters
 y Array to be copied

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::beuler_jac().

 virtual vector_fp::iterator begin ( )
pure virtual

Return an iterator pointing to the first element.

We might drop this later

Implemented in BandMatrix, and SquareMatrix.

 virtual vector_fp::const_iterator begin ( ) const
pure virtual

Return a const iterator pointing to the first element.

We might drop this later

Implemented in BandMatrix, and SquareMatrix.

 virtual doublereal* const* colPts ( )
pure virtual

Return a vector of const pointers to the columns.

Note the value of the pointers are protected by their being const. However, the value of the matrix is open to being changed.

Returns
returns a vector of pointers to the top of the columns of the matrices.

Implemented in BandMatrix.

Referenced by ResidJacEval::evalJacobian().

 virtual size_t checkRows ( doublereal & valueSmall ) const
pure virtual

Check to see if we have any zero rows in the jacobian.

This utility routine checks to see if any rows are zero. The smallest row is returned along with the largest coefficient in that row

Parameters
 valueSmall OUTPUT value of the largest coefficient in the smallest row
Returns
index of the row that is most nearly zero

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::beuler_jac().

 virtual size_t checkColumns ( doublereal & valueSmall ) const
pure virtual

Check to see if we have any zero columns in the jacobian.

This utility routine checks to see if any columns are zero. The smallest column is returned along with the largest coefficient in that column

Parameters
 valueSmall OUTPUT value of the largest coefficient in the smallest column
Returns
index of the column that is most nearly zero

Implemented in BandMatrix, and SquareMatrix.

Referenced by NonlinearSolver::beuler_jac().

## Member Data Documentation

 int matrixType_

Matrix type.

0 Square 1 Banded

Definition at line 219 of file GeneralMatrix.h.

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