gradScheme< Type > Class Template Reference

Abstract base class for gradient schemes. More...

Inheritance diagram for gradScheme< Type >:

Collaboration diagram for gradScheme< Type >:

Public Member Functions
virtual const word &	type () const =0
	Runtime type information. More...
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const fvMesh &mesh)
	Construct from mesh. More...
	gradScheme (const gradScheme &)=delete
	Disallow default bitwise copy construction. More...
virtual	~gradScheme ()
	Destructor. More...
const fvMesh &	mesh () const
	Return mesh reference. More...
virtual tmp< VolField< typename outerProduct< vector, Type >::type > >	calcGrad (const VolField< Type > &, const word &name) const =0
	Calculate and return the grad of the given field. More...
tmp< VolField< typename outerProduct< vector, Type >::type > >	grad (const VolField< Type > &, const word &name) const
	Calculate and return the grad of the given field. More...
tmp< VolField< typename outerProduct< vector, Type >::type > >	grad (const VolField< Type > &) const
	Calculate and return the grad of the given field. More...
tmp< VolField< typename outerProduct< vector, Type >::type > >	grad (const tmp< VolField< Type >> &) const
	Calculate and return the grad of the given field. More...
void	operator= (const gradScheme &)=delete
	Disallow default bitwise assignment. More...
Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...
bool	unique () const
	Return true if the reference count is zero. More...
void	operator++ ()
	Increment the reference count. More...
void	operator++ (int)
	Increment the reference count. More...
void	operator-- ()
	Decrement the reference count. More...
void	operator-- (int)
	Decrement the reference count. More...
void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Static Public Member Functions
static tmp< gradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new gradScheme created on freestore. More...

Additional Inherited Members
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...
	refCount (const refCount &)=delete
	Disallow copy. More...

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 60 of file gradScheme.H.

Constructor & Destructor Documentation

gradScheme() [1/2]

gradScheme ( const fvMesh &  mesh )

inline

Construct from mesh.

Definition at line 90 of file gradScheme.H.

gradScheme() [2/2]

gradScheme ( const gradScheme< Type > &  )

delete

Disallow default bitwise copy construction.

~gradScheme()

~gradScheme

virtual

Destructor.

Definition at line 78 of file gradScheme.C.

Member Function Documentation

type()

virtual const word& type ( ) const

pure virtual

Runtime type information.

declareRunTimeSelectionTable()

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

New()

Foam::tmp< Foam::fv::gradScheme< Type > > New ( const fvMesh &  mesh, Istream &  schemeData  )

static

Return a pointer to a new gradScheme created on freestore.

Definition at line 33 of file gradScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, and Foam::nl.

Referenced by Foam::fvc::grad().

Here is the call graph for this function:

Here is the caller graph for this function:

mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 116 of file gradScheme.H.

Referenced by gaussGrad< Type >::gaussGrad().

Here is the caller graph for this function:

calcGrad()

virtual tmp<VolField<typename outerProduct<vector, Type>::type> > calcGrad ( const VolField< Type > &  , const word &  name  ) const

pure virtual

Calculate and return the grad of the given field.

Used by grad either to recalculate the cached gradient when it is out of date with respect to the field or when it is not cached.

Implemented in faceMDLimitedGrad< Type >, faceLimitedGrad< Type >, cellMDLimitedGrad< Type >, cellLimitedGrad< Type, Limiter >, LeastSquaresGrad< Type, Stencil >, leastSquaresGrad< Type >, gaussGrad< Type >, fourthGrad< Type >, and filmGaussGrad< Type >.

grad() [1/3]

tmp<VolField<typename outerProduct<vector, Type>::type> > grad	(	const VolField< Type > &	,
		const word &	name
	)		const

Calculate and return the grad of the given field.

which may have been cached

Referenced by faceLimitedGrad< Type >::calcGrad().

Here is the caller graph for this function:

grad() [2/3]

tmp<VolField<typename outerProduct<vector, Type>::type> > grad

(

const VolField< Type > &

)

const

Calculate and return the grad of the given field.

with the default name which may have been cached

grad() [3/3]

tmp<VolField<typename outerProduct<vector, Type>::type> > grad

(

const tmp< VolField< Type >> &

)

const

Calculate and return the grad of the given field.

with the default name which may have been cached

operator=()

void operator= ( const gradScheme< Type > &  )

delete

Disallow default bitwise assignment.

---

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