simpleMatrix< Type > Class Template Reference

A simple square matrix solver with scalar coefficients. More...

Inheritance diagram for simpleMatrix< Type >:
Collaboration diagram for simpleMatrix< Type >:

Public Member Functions

 simpleMatrix (const label)
 Construct given size. More...
 
 simpleMatrix (const label, const scalar, const Type &)
 Construct given size and initial values for coefficients and source. More...
 
 simpleMatrix (const scalarSquareMatrix &, const Field< Type > &)
 Construct from components. More...
 
 simpleMatrix (Istream &)
 Construct from Istream. More...
 
 simpleMatrix (const simpleMatrix< Type > &)
 Construct as copy. More...
 
Field< Type > & source ()
 Return access to the source. More...
 
const Field< Type > & source () const
 Return const-access to the source. More...
 
Field< Type > solve () const
 Solve the matrix using Gaussian elimination with pivoting. More...
 
Field< Type > LUsolve () const
 Solve the matrix using LU decomposition with pivoting. More...
 
void operator= (const simpleMatrix< Type > &)
 

Friends

Ostreamoperator (Ostream &, const simpleMatrix< Type > &)
 

Detailed Description

template<class Type>
class Foam::simpleMatrix< Type >

A simple square matrix solver with scalar coefficients.

Source files

Definition at line 48 of file simpleMatrix.H.

Constructor & Destructor Documentation

simpleMatrix ( const label  mSize)

Construct given size.

Note: this does not initialise the coefficients or the source.

Definition at line 31 of file simpleMatrix.C.

simpleMatrix ( const label  mSize,
const scalar  coeffVal,
const Type &  sourceVal 
)

Construct given size and initial values for coefficients and source.

Definition at line 40 of file simpleMatrix.C.

simpleMatrix ( const scalarSquareMatrix matrix,
const Field< Type > &  source 
)

Construct from components.

Definition at line 53 of file simpleMatrix.C.

simpleMatrix ( Istream is)

Construct from Istream.

Definition at line 64 of file simpleMatrix.C.

simpleMatrix ( const simpleMatrix< Type > &  )

Construct as copy.

Member Function Documentation

Field<Type>& source ( )
inline

Return access to the source.

Definition at line 98 of file simpleMatrix.H.

References simpleMatrix< Type >::source().

Referenced by EulerImplicit< ChemistryModel >::solve(), and simpleMatrix< Type >::source().

Here is the call graph for this function:

Here is the caller graph for this function:

const Field<Type>& source ( ) const
inline

Return const-access to the source.

Definition at line 104 of file simpleMatrix.H.

References simpleMatrix< Type >::source().

Here is the call graph for this function:

Foam::Field< Type > solve ( ) const

Solve the matrix using Gaussian elimination with pivoting.

and return the solution

Definition at line 74 of file simpleMatrix.C.

References Foam::solve().

Here is the call graph for this function:

Foam::Field< Type > LUsolve ( ) const

Solve the matrix using LU decomposition with pivoting.

and return the solution

Definition at line 86 of file simpleMatrix.C.

References Foam::LUsolve().

Referenced by EulerImplicit< ChemistryModel >::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const simpleMatrix< Type > &  m)

Definition at line 100 of file simpleMatrix.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and n.

Here is the call graph for this function:

Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const simpleMatrix< Type > &   
)
friend

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