gradScheme< Type > Class Template Reference

Abstract base class for gradient schemes. More...

Inheritance diagram for gradScheme< Type >:

[legend]

Collaboration diagram for gradScheme< Type >:

[legend]

List of all members.

Public Member Functions
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const fvMesh &mesh)
	Construct from mesh.
virtual	~gradScheme ()
const fvMesh &	mesh () const
	Return mesh reference.
virtual tmp< GeometricField < typename outerProduct < vector, Type >::type, fvPatchField, volMesh > >	grad (const GeometricField< Type, fvPatchField, volMesh > &) const =0
	Calculate and return the grad of the given field.
Static Public Member Functions
static tmp< gradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new gradScheme created on freestore.

---

Detailed Description

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

Abstract base class for gradient schemes.

Source files

• gradScheme.H
• gradScheme.C

Definition at line 56 of file gradScheme.H.

---

Constructor & Destructor Documentation

gradScheme

(

const fvMesh &

mesh

)

[inline]

Construct from mesh.

Definition at line 95 of file gradScheme.H.

~gradScheme

(

)

[inline, virtual]

Definition at line 87 of file gradScheme.C.

---

Member Function Documentation

virtual const word& type

(

)

const [pure virtual]

Runtime type information.

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

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

Return a pointer to a new gradScheme created on freestore.

Definition at line 39 of file gradScheme.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 119 of file gradScheme.H.

virtual tmp< GeometricField <typename outerProduct<vector, Type>::type, fvPatchField, volMesh> > grad

(

const GeometricField< Type, fvPatchField, volMesh > &

)

const [pure virtual]

Calculate and return the grad of the given field.

Implemented in extendedLeastSquaresGrad< Type >, fourthGrad< Type >, gaussGrad< Type >, leastSquaresGrad< Type >, cellLimitedGrad< Type >, cellMDLimitedGrad< Type >, faceLimitedGrad< Type >, and faceMDLimitedGrad< Type >.

---

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

• src/finiteVolume/finiteVolume/gradSchemes/gradScheme/gradScheme.H
• src/finiteVolume/finiteVolume/gradSchemes/gradScheme/gradScheme.C