OpenFOAM logo
Open Source CFD Toolkit

faMatrix Class Template Reference

Inheritance diagram for faMatrix:

Inheritance graph
[legend]
Collaboration diagram for faMatrix:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::faMatrix< Type >


Public Types

typedef GeometricField< Type,
faPatchField, edgeMesh > * 
edgeTypeFieldPtr
 Declare return type of the faceFluxCorrectionPtr() function.

Public Member Functions

 ClassName ("faMatrix")
 faMatrix (GeometricField< Type, faPatchField, areaMesh > &, const dimensionSet &)
 Construct given a field to solve for.
 faMatrix (const faMatrix< Type > &)
 Construct as copy.
 faMatrix (GeometricField< Type, faPatchField, areaMesh > &, Istream &)
 Construct from Istream given field to solve for.
virtual ~faMatrix ()
const GeometricField< Type,
faPatchField, areaMesh > & 
psi () const
GeometricField< Type, faPatchField,
areaMesh > & 
psi ()
const dimensionSetdimensions () const
Field< Type > & source ()
const Field< Type > & source () const
FieldField< Field, Type > & internalCoeffs ()
 faBoundary scalar field containing pseudo-matrix coeffs
FieldField< Field, Type > & boundaryCoeffs ()
 faBoundary scalar field containing pseudo-matrix coeffs
edgeTypeFieldPtrfaceFluxCorrectionPtr ()
 Return pointer to face-flux non-orthogonal correction field.
bool needReference ()
 Does the matrix need a reference level for solution.
void setReference (const label cell, const Type &value)
 Set reference level for solution.
void setComponentReference (const label patchi, const label facei, const direction cmpt, const scalar value)
 Set reference level for a component of the solution.
void relax (const scalar alpha)
 Relax matrix (for steady-state solution).
void relax ()
 Relax matrix (for steadty-state solution).
lduMatrix::solverPerformance solve (Istream &)
 Solve returning the solution statistics.
lduMatrix::solverPerformance solve ()
 Solve returning the solution statistics.
tmp< Field< Type > > residual () const
 Return the matrix residual.
tmp< scalarFieldD () const
 Return the matrix diagonal.
tmp< areaScalarFieldA () const
 Return the central coefficient.
tmp< GeometricField< Type,
faPatchField, areaMesh > > 
H () const
 Return the H operation source.
tmp< GeometricField< Type,
faPatchField, edgeMesh > > 
flux () const
 Return the face-flux field from the matrix.
void operator= (const faMatrix< Type > &)
void operator= (const tmp< faMatrix< Type > > &)
void negate ()
void operator+= (const faMatrix< Type > &)
void operator+= (const tmp< faMatrix< Type > > &)
void operator-= (const faMatrix< Type > &)
void operator-= (const tmp< faMatrix< Type > > &)
void operator+= (const GeometricField< Type, faPatchField, areaMesh > &)
void operator+= (const tmp< GeometricField< Type, faPatchField, areaMesh > > &)
void operator-= (const GeometricField< Type, faPatchField, areaMesh > &)
void operator-= (const tmp< GeometricField< Type, faPatchField, areaMesh > > &)
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator *= (const areaScalarField &)
void operator *= (const tmp< areaScalarField > &)
void operator *= (const dimensioned< scalar > &)
tmp< Field< Type > > operator & (const Field< Type > &) const
tmp< Field< Type > > operator & (const tmp< Field< Type > > &) const
template<>
void setComponentReference (const label patchi, const label facei, const direction, const scalar value)
template<>
lduMatrix::solverPerformance solve (Istream &)
template<>
tmp< scalarFieldresidual () const
template<>
tmp< areaScalarFieldH () const
template<>
tmp< scalarFieldoperator & (const scalarField &) const
template<>
tmp< scalarFieldoperator & (const tmp< scalarField > &) const

Friends

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

Member Typedef Documentation

typedef GeometricField<Type, faPatchField, edgeMesh>* edgeTypeFieldPtr
 

Declare return type of the faceFluxCorrectionPtr() function.

Definition at line 242 of file faMatrix.H.

Referenced by faMatrix::internalCoeffs().


Constructor & Destructor Documentation

faMatrix GeometricField< Type, faPatchField, areaMesh > &  ,
const dimensionSet
 

Construct given a field to solve for.

faMatrix const faMatrix< Type > &   ) 
 

Construct as copy.

faMatrix GeometricField< Type, faPatchField, areaMesh > &  ,
Istream
 

Construct from Istream given field to solve for.

virtual ~faMatrix  )  [virtual]
 


Member Function Documentation

tmp<areaScalarField> A  )  const
 

Return the central coefficient.

FieldField<Field, Type>& boundaryCoeffs  )  [inline]
 

faBoundary scalar field containing pseudo-matrix coeffs

for boundary cells

Definition at line 234 of file faMatrix.H.

ClassName "faMatrix< Type >"   ) 
 

tmp<scalarField> D  )  const
 

Return the matrix diagonal.

const dimensionSet& dimensions  )  const [inline]
 

Definition at line 206 of file faMatrix.H.

edgeTypeFieldPtr& faceFluxCorrectionPtr  )  [inline]
 

Return pointer to face-flux non-orthogonal correction field.

Definition at line 245 of file faMatrix.H.

References Foam::areaScalarField, Foam::direction, and Foam::label.

tmp<GeometricField<Type, faPatchField, edgeMesh> > flux  )  const
 

Return the face-flux field from the matrix.

tmp< areaScalarField > H  )  const
 

tmp<GeometricField<Type, faPatchField, areaMesh> > H  )  const
 

Return the H operation source.

FieldField<Field, Type>& internalCoeffs  )  [inline]
 

faBoundary scalar field containing pseudo-matrix coeffs

for internal cells

Definition at line 225 of file faMatrix.H.

References faMatrix::edgeTypeFieldPtr.

bool needReference  ) 
 

Does the matrix need a reference level for solution.

void negate  ) 
 

Reimplemented from lduMatrix.

tmp< scalarField > operator & const tmp< scalarField > &   )  const
 

tmp< scalarField > operator & const scalarField  )  const
 

tmp<Field<Type> > operator & const tmp< Field< Type > > &   )  const
 

tmp<Field<Type> > operator & const Field< Type > &   )  const
 

void operator *= const dimensioned< scalar > &   ) 
 

void operator *= const tmp< areaScalarField > &   ) 
 

void operator *= const areaScalarField  ) 
 

void operator+= const dimensioned< Type > &   ) 
 

void operator+= const tmp< GeometricField< Type, faPatchField, areaMesh > > &   ) 
 

void operator+= const GeometricField< Type, faPatchField, areaMesh > &   ) 
 

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

void operator+= const faMatrix< Type > &   ) 
 

void operator-= const dimensioned< Type > &   ) 
 

void operator-= const tmp< GeometricField< Type, faPatchField, areaMesh > > &   ) 
 

void operator-= const GeometricField< Type, faPatchField, areaMesh > &   ) 
 

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

void operator-= const faMatrix< Type > &   ) 
 

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

void operator= const faMatrix< Type > &   ) 
 

GeometricField<Type, faPatchField, areaMesh>& psi  )  [inline]
 

Definition at line 201 of file faMatrix.H.

const GeometricField<Type, faPatchField, areaMesh>& psi  )  const [inline]
 

Definition at line 196 of file faMatrix.H.

void relax  ) 
 

Relax matrix (for steadty-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  )  const
 

tmp<Field<Type> > residual  )  const
 

Return the matrix residual.

void setComponentReference const label  patchi,
const label  facei,
const   direction,
const scalar  value
 

void setComponentReference const label  patchi,
const label  facei,
const direction  cmpt,
const scalar  value
 

Set reference level for a component of the solution.

on a given patch face

void setReference const label  cell,
const Type &  value
 

Set reference level for solution.

lduMatrix::solverPerformance solve Istream  ) 
 

lduMatrix::solverPerformance solve  ) 
 

Solve returning the solution statistics.

Solver controls read from faSolution

lduMatrix::solverPerformance solve Istream  ) 
 

Solve returning the solution statistics.

Solver controls read Istream

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

Definition at line 216 of file faMatrix.H.

Field<Type>& source  )  [inline]
 

Definition at line 211 of file faMatrix.H.


Friends And Related Function Documentation

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


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