FreeFOAM The Cross-Platform CFD Toolkit
errorEstimate< Type > Class Template Reference

Residual error estimation. More...

#include <errorEstimation/errorEstimate.H>


Detailed Description

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

Residual error estimation.

Source files

Definition at line 51 of file errorEstimate.H.

+ Inheritance diagram for errorEstimate< Type >:
+ Collaboration diagram for errorEstimate< Type >:

List of all members.

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 > &)
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 63 of file errorEstimate.C.

errorEstimate ( const errorEstimate< Type > &  ee)

Construct as copy.

Definition at line 79 of file errorEstimate.C.

Definition at line 92 of file errorEstimate.C.


Member Function Documentation

ClassName ( "errorEstimate< Type >"  )
const GeometricField<Type, fvPatchField, volMesh>& psi ( ) const
inline

Return field.

Definition at line 107 of file errorEstimate.H.

Referenced by Foam::checkMethod().

const dimensionSet& dimensions ( ) const
inline

Return residual dimensions.

Definition at line 113 of file errorEstimate.H.

Referenced by Foam::checkMethod().

Field<Type>& res ( )
inline

Definition at line 120 of file errorEstimate.H.

const Field<Type>& res ( ) const
inline

Definition at line 125 of file errorEstimate.H.

void operator= ( const errorEstimate< Type > &  rhs)

Definition at line 197 of file errorEstimate.C.

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

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

Definition at line 224 of file errorEstimate.C.

void negate ( )

Definition at line 232 of file errorEstimate.C.

void operator+= ( const errorEstimate< Type > &  eev)

Definition at line 239 of file errorEstimate.C.

References Foam::checkMethod().

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

Definition at line 252 of file errorEstimate.C.

void operator-= ( const errorEstimate< Type > &  eev)

Definition at line 262 of file errorEstimate.C.

References Foam::checkMethod().

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

Definition at line 273 of file errorEstimate.C.

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

Definition at line 282 of file errorEstimate.C.

References Foam::checkMethod().

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

Definition at line 293 of file errorEstimate.C.

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

Definition at line 304 of file errorEstimate.C.

References Foam::checkMethod().

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

Definition at line 315 of file errorEstimate.C.

void operator+= ( const dimensioned< Type > &  su)

Definition at line 326 of file errorEstimate.C.

void operator-= ( const dimensioned< Type > &  su)

Definition at line 336 of file errorEstimate.C.

void operator*= ( const volScalarField vsf)

Definition at line 346 of file errorEstimate.C.

void operator*= ( const tmp< volScalarField > &  tvsf)

Definition at line 358 of file errorEstimate.C.

void operator*= ( const dimensioned< scalar > &  ds)

Definition at line 369 of file errorEstimate.C.


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