OpenFOAM logo
Open Source CFD Toolkit

errorEstimate Class Template Reference

Inheritance diagram for errorEstimate:

Inheritance graph
[legend]
Collaboration diagram for errorEstimate:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::errorEstimate< Type >


Public Member Functions

 ClassName ("errorEstimate")
 errorEstimate (const GeometricField< Type, fvPatchField, volMesh > &psi, const dimensionSet &ds, const Field< Type > &res, const scalarField &norm)
 Construct from components.
 errorEstimate (const errorEstimate< Type > &)
 Construct as copy.
 ~errorEstimate ()
const GeometricField< Type,
fvPatchField, volMesh > & 
psi () const
 Return field.
const dimensionSetdimensions () const
 Return residual dimensions.
Field< Type > & res ()
const Field< Type > & res () const
tmp< GeometricField< Type,
fvPatchField, volMesh > > 
residual () const
 Cell residual (volume intensive).
tmp< volScalarFieldnormFactor () const
 Normalisation factor.
tmp< GeometricField< Type,
fvPatchField, volMesh > > 
error () const
 Error estimate.
void operator= (const errorEstimate< Type > &)
void operator= (const tmp< errorEstimate< Type > > &)
void negate ()
void operator+= (const errorEstimate< Type > &)
void operator+= (const tmp< errorEstimate< Type > > &)
void operator-= (const errorEstimate< Type > &)
void operator-= (const tmp< errorEstimate< Type > > &)
void operator+= (const GeometricField< Type, fvPatchField, volMesh > &)
void operator+= (const tmp< GeometricField< Type, fvPatchField, volMesh > > &)
void operator-= (const GeometricField< Type, fvPatchField, volMesh > &)
void operator-= (const tmp< GeometricField< Type, fvPatchField, volMesh > > &)
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator *= (const volScalarField &)
void operator *= (const tmp< volScalarField > &)
void operator *= (const dimensioned< scalar > &)

Constructor & Destructor Documentation

errorEstimate const GeometricField< Type, fvPatchField, volMesh > &  psi,
const dimensionSet ds,
const Field< Type > &  res,
const scalarField norm
 

Construct from components.

errorEstimate const errorEstimate< Type > &   ) 
 

Construct as copy.

~errorEstimate  ) 
 


Member Function Documentation

ClassName "errorEstimate< Type >"   ) 
 

const dimensionSet& dimensions  )  const [inline]
 

Return residual dimensions.

Definition at line 120 of file errorEstimate.H.

tmp<GeometricField<Type, fvPatchField, volMesh> > error  )  const
 

Error estimate.

void negate  ) 
 

tmp<volScalarField> normFactor  )  const
 

Normalisation factor.

void operator *= const dimensioned< scalar > &   ) 
 

void operator *= const tmp< volScalarField > &   ) 
 

void operator *= const volScalarField  ) 
 

void operator+= const dimensioned< Type > &   ) 
 

void operator+= const tmp< GeometricField< Type, fvPatchField, volMesh > > &   ) 
 

void operator+= const GeometricField< Type, fvPatchField, volMesh > &   ) 
 

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

void operator+= const errorEstimate< Type > &   ) 
 

void operator-= const dimensioned< Type > &   ) 
 

void operator-= const tmp< GeometricField< Type, fvPatchField, volMesh > > &   ) 
 

void operator-= const GeometricField< Type, fvPatchField, volMesh > &   ) 
 

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

void operator-= const errorEstimate< Type > &   ) 
 

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

void operator= const errorEstimate< Type > &   ) 
 

const GeometricField<Type, fvPatchField, volMesh>& psi  )  const [inline]
 

Return field.

Definition at line 114 of file errorEstimate.H.

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

Definition at line 132 of file errorEstimate.H.

References Foam::volScalarField.

Field<Type>& res  )  [inline]
 

Definition at line 127 of file errorEstimate.H.

tmp<GeometricField<Type, fvPatchField, volMesh> > residual  )  const
 

Cell residual (volume intensive).


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