OpenFOAM logo
Open Source CFD Toolkit

tetFemMatrix Class Template Reference

Inheritance diagram for tetFemMatrix:

Inheritance graph
[legend]
Collaboration diagram for tetFemMatrix:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::tetFemMatrix< Type >


Public Member Functions

 ClassName ("tetFemMatrix")
 tetFemMatrix (GeometricField< Type, tetPolyPatchField, tetPointMesh > &, const dimensionSet &)
 Construct given a field to solve for.
 tetFemMatrix (const tetFemMatrix< Type > &)
 Construct as copy.
 tetFemMatrix (GeometricField< Type, tetPolyPatchField, tetPointMesh > &, Istream &)
 Construct from Istream given field to solve for.
virtual ~tetFemMatrix ()
const GeometricField< Type,
tetPolyPatchField, tetPointMesh > & 
psi () const
GeometricField< Type, tetPolyPatchField,
tetPointMesh > & 
psi ()
const dimensionSetdimensions () const
Field< Type > & source ()
const Field< Type > & source () const
void addConstraint (const label vertex, const Type &value)
 Set reference level for solution.
void relax (const scalar alpha)
 Relax matrix (for steady-state solution).
void relax ()
 Relax matrix (for steady-state solution).
void check ()
 Check matrix for diagonal dominance.
lduMatrix::solverPerformance solve ()
 Solve returning the solution statistics.
tmp< Field< Type > > residual ()
 Return the matrix residual.
void operator= (const tetFemMatrix< Type > &)
void operator= (const tmp< tetFemMatrix< Type > > &)
void negate ()
void operator+= (const tetFemMatrix< Type > &)
void operator+= (const tmp< tetFemMatrix< Type > > &)
void operator-= (const tetFemMatrix< Type > &)
void operator-= (const tmp< tetFemMatrix< Type > > &)
void operator+= (const GeometricField< Type, tetPolyPatchField, elementMesh > &)
void operator+= (const tmp< GeometricField< Type, tetPolyPatchField, elementMesh > > &)
void operator-= (const GeometricField< Type, tetPolyPatchField, elementMesh > &)
void operator-= (const tmp< GeometricField< Type, tetPolyPatchField, elementMesh > > &)
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator *= (const dimensioned< scalar > &)
template<>
lduMatrix::solverPerformance solve ()
template<>
tmp< scalarFieldresidual ()

Friends

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

Constructor & Destructor Documentation

tetFemMatrix GeometricField< Type, tetPolyPatchField, tetPointMesh > &  ,
const dimensionSet
 

Construct given a field to solve for.

tetFemMatrix const tetFemMatrix< Type > &   ) 
 

Construct as copy.

tetFemMatrix GeometricField< Type, tetPolyPatchField, tetPointMesh > &  ,
Istream
 

Construct from Istream given field to solve for.

virtual ~tetFemMatrix  )  [virtual]
 


Member Function Documentation

void addConstraint const label  vertex,
const Type &  value
 

Set reference level for solution.

bool needReference();

void check  ) 
 

Check matrix for diagonal dominance.

ClassName "tetFemMatrix< Type >"   ) 
 

const dimensionSet& dimensions  )  const [inline]
 

Definition at line 200 of file tetFemMatrix.H.

void negate  ) 
 

Reimplemented from lduMatrix.

void operator *= const dimensioned< scalar > &   ) 
 

void operator+= const dimensioned< Type > &   ) 
 

void operator+= const tmp< GeometricField< Type, tetPolyPatchField, elementMesh > > &   ) 
 

void operator+= const GeometricField< Type, tetPolyPatchField, elementMesh > &   ) 
 

void operator+= const tmp< tetFemMatrix< Type > > &   ) 
 

void operator+= const tetFemMatrix< Type > &   ) 
 

void operator-= const dimensioned< Type > &   ) 
 

void operator-= const tmp< GeometricField< Type, tetPolyPatchField, elementMesh > > &   ) 
 

void operator-= const GeometricField< Type, tetPolyPatchField, elementMesh > &   ) 
 

void operator-= const tmp< tetFemMatrix< Type > > &   ) 
 

void operator-= const tetFemMatrix< Type > &   ) 
 

void operator= const tmp< tetFemMatrix< Type > > &   ) 
 

void operator= const tetFemMatrix< Type > &   ) 
 

GeometricField<Type, tetPolyPatchField, tetPointMesh>& psi  )  [inline]
 

Definition at line 195 of file tetFemMatrix.H.

const GeometricField<Type, tetPolyPatchField, tetPointMesh>& psi  )  const [inline]
 

Definition at line 190 of file tetFemMatrix.H.

void relax  ) 
 

Relax matrix (for steady-state solution).

alpha is read from controlDict

void relax const scalar  alpha  ) 
 

Relax matrix (for steady-state solution).

alpha = 1 : diagonally equal alpha < 1 : ,, dominant alpha = 0 : do nothing

tmp< scalarField > residual  ) 
 

tmp<Field<Type> > residual  ) 
 

Return the matrix residual.

lduMatrix::solverPerformance solve  ) 
 

lduMatrix::solverPerformance solve  ) 
 

Solve returning the solution statistics.

Convergence tolerance read from controlDict

const Field<Type>& source  )  const [inline]
 

Definition at line 210 of file tetFemMatrix.H.

References Foam::label.

Field<Type>& source  )  [inline]
 

Definition at line 205 of file tetFemMatrix.H.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const tetFemMatrix< Type > & 
[friend]
 


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org