snGradScheme< Type > Class Template Reference

Abstract base class for snGrad schemes. More...

Inheritance diagram for snGradScheme< Type >:

[legend]

Collaboration diagram for snGradScheme< Type >:

[legend]

List of all members.

Public Member Functions
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (tmp, snGradScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	snGradScheme (const fvMesh &mesh)
	Construct from mesh.
virtual	~snGradScheme ()
const fvMesh &	mesh () const
	Return mesh reference.
virtual tmp< surfaceScalarField >	deltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) const =0
	Return the interpolation weighting factors for the given field.
virtual bool	corrected () const
	Return true if this scheme uses an explicit correction.
virtual tmp< GeometricField < Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the explicit correction to the snGrad.
virtual tmp< GeometricField < Type, fvsPatchField, surfaceMesh > >	snGrad (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the snGrad of the given cell field.
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	snGrad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Return the snGrad of the given tmp cell field.
Static Public Member Functions
static tmp< snGradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme.
static tmp< GeometricField < Type, fvsPatchField, surfaceMesh > >	snGrad (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")
	Return the snGrad of the given cell field with the given deltaCoeffs.

---

Detailed Description

template<class Type>
class Foam::fv::snGradScheme< Type >

Abstract base class for snGrad schemes.

Source files

• snGradScheme.H
• snGradScheme.C

Definition at line 56 of file snGradScheme.H.

---

Constructor & Destructor Documentation

snGradScheme

(

const fvMesh &

mesh

)

[inline]

Construct from mesh.

Definition at line 93 of file snGradScheme.H.

~snGradScheme

(

)

[inline, virtual]

Definition at line 88 of file snGradScheme.C.

---

Member Function Documentation

virtual const word& type

(

)

const [pure virtual]

Runtime type information.

declareRunTimeSelectionTable	(	tmp	,
		snGradScheme< Type >	,
		Mesh	,
		(const fvMesh &mesh, Istream &schemeData)	,
		(mesh, schemeData)
	)

tmp< snGradScheme< Type > > New	(	const fvMesh &	mesh,
		Istream &	schemeData
	)			[inline, static]

Return new tmp interpolation scheme.

Definition at line 38 of file snGradScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and mesh.

Here is the call graph for this function:

const fvMesh& mesh

(

)

const [inline]

Return mesh reference.

Definition at line 117 of file snGradScheme.H.

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad	(	const GeometricField< Type, fvPatchField, volMesh > &	vf,
		const tmp< surfaceScalarField > &	tdeltaCoeffs,
		const word &	snGradName = "snGrad"
	)			[inline, static]

Return the snGrad of the given cell field with the given deltaCoeffs.

Definition at line 97 of file snGradScheme.C.

Referenced by snGradScheme< Type >::snGrad().

Here is the caller graph for this function:

virtual tmp<surfaceScalarField> deltaCoeffs

(

const GeometricField< Type, fvPatchField, volMesh > &

)

const [pure virtual]

Return the interpolation weighting factors for the given field.

Implemented in correctedSnGrad< Type >, limitedSnGrad< Type >, quadraticFitSnGrad< Type >, and uncorrectedSnGrad< Type >.

Referenced by snGradScheme< Type >::snGrad().

Here is the caller graph for this function:

virtual bool corrected

(

)

const [inline, virtual]

Return true if this scheme uses an explicit correction.

Reimplemented in correctedSnGrad< Type >, limitedSnGrad< Type >, quadraticFitSnGrad< Type >, and uncorrectedSnGrad< Type >.

Definition at line 139 of file snGradScheme.H.

Referenced by snGradScheme< Type >::snGrad().

Here is the caller graph for this function:

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction

(

const GeometricField< Type, fvPatchField, volMesh > &

)

const [inline, virtual]

Return the explicit correction to the snGrad.

for the given field

Reimplemented in correctedSnGrad< Type >, limitedSnGrad< Type >, quadraticFitSnGrad< Type >, and uncorrectedSnGrad< Type >.

Definition at line 149 of file snGradScheme.H.

Referenced by snGradScheme< Type >::snGrad().

Here is the caller graph for this function:

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad

(

const GeometricField< Type, fvPatchField, volMesh > &

vf

)

const [inline, virtual]

Return the snGrad of the given cell field.

Return the face-snGrad of the given cell field.

with explicit correction

Definition at line 153 of file snGradScheme.C.

References snGradScheme< Type >::corrected(), snGradScheme< Type >::correction(), snGradScheme< Type >::deltaCoeffs(), and snGradScheme< Type >::snGrad().

Here is the call graph for this function:

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad

(

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

tvf

)

const [inline]

Return the snGrad of the given tmp cell field.

Return the face-snGrad of the given cell field.

with explicit correction

Definition at line 176 of file snGradScheme.C.

References Foam::fvc::snGrad().

Here is the call graph for this function:

---

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

• src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H
• src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.C