errorEstimate< Type > Class Template Reference

Residual error estimation. More...

Inheritance diagram for errorEstimate< Type >:

[legend]

Collaboration diagram for errorEstimate< Type >:

[legend]

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 dimensionSet &	dimensions () const
	Return residual dimensions.
Field< Type > &	res ()
const Field< Type > &	res () const
tmp< GeometricField< Type, fvPatchField, volMesh > >	residual () const
	Cell residual (volume intensive).
tmp< volScalarField >	normFactor () 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 > &)

---

Detailed Description

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

Residual error estimation.

Source files

• errorEstimate.H
• errorEstimate.C

Definition at line 46 of file errorEstimate.H.

---

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 55 of file errorEstimate.C.

errorEstimate

(

const errorEstimate< Type > &

ee

)

[inline]

Construct as copy.

Definition at line 71 of file errorEstimate.C.

~errorEstimate

(

)

[inline]

Definition at line 84 of file errorEstimate.C.

---

Member Function Documentation

ClassName

(

"errorEstimate< Type >"

)

const GeometricField<Type, fvPatchField, volMesh>& psi

(

)

const [inline]

Return field.

Definition at line 102 of file errorEstimate.H.

const dimensionSet& dimensions

(

)

const [inline]

Return residual dimensions.

Definition at line 108 of file errorEstimate.H.

Field<Type>& res

(

)

[inline]

Definition at line 115 of file errorEstimate.H.

const Field<Type>& res

(

)

const [inline]

Definition at line 120 of file errorEstimate.H.

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > residual

(

)

const [inline]

Cell residual (volume intensive).

Definition at line 92 of file errorEstimate.C.

Foam::tmp< Foam::volScalarField > normFactor

(

)

const [inline]

Normalisation factor.

Definition at line 124 of file errorEstimate.C.

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > error

(

)

const [inline]

Error estimate.

Definition at line 156 of file errorEstimate.C.

void operator=

(

const errorEstimate< Type > &

rhs

)

[inline]

Definition at line 189 of file errorEstimate.C.

Referenced by errorEstimate< Type >::negate().

Here is the caller graph for this function:

void operator=

(

const tmp< errorEstimate< Type > > &

teev

)

[inline]

Definition at line 216 of file errorEstimate.C.

void negate

(

)

[inline]

Definition at line 224 of file errorEstimate.C.

References errorEstimate< Type >::operator=().

Here is the call graph for this function:

void operator+=

(

const errorEstimate< Type > &

eev

)

[inline]

Definition at line 231 of file errorEstimate.C.

References Field< Type >::negate().

Here is the call graph for this function:

void operator+=

(

const tmp< errorEstimate< Type > > &

teev

)

[inline]

Definition at line 244 of file errorEstimate.C.

void operator-=

(

const errorEstimate< Type > &

eev

)

[inline]

Definition at line 254 of file errorEstimate.C.

Referenced by errorEstimate< Type >::operator+=().

Here is the caller graph for this function:

void operator-=

(

const tmp< errorEstimate< Type > > &

teev

)

[inline]

Definition at line 265 of file errorEstimate.C.

void operator+=

(

const GeometricField< Type, fvPatchField, volMesh > &

su

)

[inline]

Definition at line 274 of file errorEstimate.C.

References errorEstimate< Type >::operator-=().

Here is the call graph for this function:

void operator+=

(

const tmp< GeometricField< Type, fvPatchField, volMesh > > &

tsu

)

[inline]

Definition at line 285 of file errorEstimate.C.

References Foam::checkMethod().

Here is the call graph for this function:

void operator-=

(

const GeometricField< Type, fvPatchField, volMesh > &

su

)

[inline]

Definition at line 296 of file errorEstimate.C.

void operator-=

(

const tmp< GeometricField< Type, fvPatchField, volMesh > > &

tsu

)

[inline]

Definition at line 307 of file errorEstimate.C.

References Foam::checkMethod().

Here is the call graph for this function:

void operator+=

(

const dimensioned< Type > &

su

)

[inline]

Definition at line 318 of file errorEstimate.C.

void operator-=

(

const dimensioned< Type > &

su

)

[inline]

Definition at line 328 of file errorEstimate.C.

void operator*=

(

const volScalarField &

vsf

)

[inline]

Definition at line 338 of file errorEstimate.C.

void operator*=

(

const tmp< volScalarField > &

tvsf

)

[inline]

Definition at line 350 of file errorEstimate.C.

void operator*=

(

const dimensioned< scalar > &

ds

)

[inline]

Definition at line 361 of file errorEstimate.C.

---

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

• src/errorEstimation/errorEstimate/errorEstimate.H
• src/errorEstimation/errorEstimate/errorEstimate.C