gradScheme< Type > Class Template Reference

Abstract base class for finite area calculus gradient schemes. More...

Inheritance diagram for gradScheme< Type >:

Collaboration diagram for gradScheme< Type >:

Public Member Functions
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const faMesh &mesh)
	Construct from mesh. More...
virtual	~gradScheme ()=default
	Destructor. More...
const faMesh &	mesh () const
	Return mesh reference. More...
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > >	calcGrad (const GeometricField< Type, faPatchField, areaMesh > &, const word &name) const =0
	Calculate and return the grad of the given field. More...
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > >	grad (const GeometricField< Type, faPatchField, areaMesh > &, const word &name) const
	Calculate and return the grad of the given field which may have been cached. More...
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > >	grad (const GeometricField< Type, faPatchField, areaMesh > &) const
	Calculate and return the grad of the given field with the default name which may have been cached. More...
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > >	grad (const tmp< GeometricField< Type, faPatchField, areaMesh >> &) const
	Calculate and return the grad of the given field with the default name which may have been cached. More...
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...
int	use_count () const noexcept
	Return the current reference count. More...
bool	unique () const noexcept
	Return true if the reference count is zero. More...
void	operator++ () noexcept
	Increment the reference count. More...
void	operator++ (int) noexcept
	Increment the reference count. More...
void	operator-- () noexcept
	Decrement the reference count. More...
void	operator-- (int) noexcept
	Decrement the reference count. More...

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

Detailed Description

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

Abstract base class for finite area calculus gradient schemes.

Source files

• faGradScheme.H
• faGradScheme.C
• faGradSchemes.C

Definition at line 60 of file faGradScheme.H.

Constructor & Destructor Documentation

gradScheme()

gradScheme ( const faMesh &  mesh )

inline

Construct from mesh.

Definition at line 101 of file faGradScheme.H.

~gradScheme()

virtual ~gradScheme ( )

virtualdefault

Destructor.

Member Function Documentation

declareRunTimeSelectionTable()

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

New()

tmp< gradScheme< Type > > New ( const faMesh &  mesh, Istream &  schemeData  )

static

Return a pointer to a new gradScheme created on freestore.

Definition at line 41 of file faGradScheme.C.

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

Referenced by Foam::fac::ngrad().

Here is the call graph for this function:

Here is the caller graph for this function:

mesh()

const faMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 130 of file faGradScheme.H.

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

Here is the caller graph for this function:

calcGrad()

virtual tmp< GeometricField <typename outerProduct<vector, Type>::type, faPatchField, areaMesh> > calcGrad ( const GeometricField< Type, faPatchField, areaMesh > &  , 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 gaussGrad< Type >, faceLimitedGrad< Type >, edgeLimitedGrad< Type >, and leastSquaresFaGrad< Type >.

grad() [1/3]

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

Calculate and return the grad of the given field which may have been cached.

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

Here is the caller graph for this function:

grad() [2/3]

tmp< GeometricField <typename outerProduct<vector, Type>::type, faPatchField, areaMesh> > grad

(

const GeometricField< Type, faPatchField, areaMesh > &

)

const

Calculate and return the grad of the given field with the default name which may have been cached.

grad() [3/3]

tmp< GeometricField <typename outerProduct<vector, Type>::type, faPatchField, areaMesh> > grad

(

const tmp< GeometricField< Type, faPatchField, areaMesh >> &

)

const

Calculate and return the grad of the given field with the default name which may have been cached.

---

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

• src/finiteArea/finiteArea/gradSchemes/faGradScheme/faGradScheme.H
• src/finiteArea/finiteArea/gradSchemes/faGradScheme/faGradScheme.C