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

#include <faGradScheme.H>

Inheritance diagram for gradScheme< Type >:

[legend]

Collaboration diagram for gradScheme< Type >:

Public Member Functions
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const gradScheme &)=delete
	No copy construct.
void	operator= (const gradScheme &)=delete
	No copy assignment.
	gradScheme (const faMesh &mesh)
	Construct from mesh.
virtual	~gradScheme ()=default
	Destructor.
const faMesh &	mesh () const noexcept
	Return mesh reference.
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.
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.
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.
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.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

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

Detailed Description

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

Abstract base class for finite area calculus gradient schemes.

Source files

Definition at line 58 of file faGradScheme.H.

Constructor & Destructor Documentation

◆ gradScheme() [1/2]

template<class Type>

gradScheme ( const gradScheme< Type > & )

delete

No copy construct.

References gradScheme().

Referenced by declareRunTimeSelectionTable(), edgeLimitedGrad< Type >::edgeLimitedGrad(), faceLimitedGrad< Type >::faceLimitedGrad(), gaussGrad< Type >::gaussGrad(), gaussGrad< Type >::gaussGrad(), gradScheme(), leastSquaresFaGrad< Type >::leastSquaresFaGrad(), leastSquaresFaGrad< Type >::leastSquaresFaGrad(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gradScheme() [2/2]

template<class Type>

gradScheme ( const faMesh & mesh )

inline

Construct from mesh.

Definition at line 102 of file faGradScheme.H.

References mesh().

Here is the call graph for this function:

◆ ~gradScheme()

template<class Type>

virtual ~gradScheme ( )

virtualdefault

Destructor.

Member Function Documentation

◆ declareRunTimeSelectionTable()

template<class Type>

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

References gradScheme(), and mesh().

Here is the call graph for this function:

◆ operator=()

template<class Type>

void operator= ( const gradScheme< Type > & )

delete

No copy assignment.

References gradScheme().

Here is the call graph for this function:

◆ New()

template<class Type>

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

static

Return a pointer to a new gradScheme created on freestore.

Definition at line 39 of file faGradScheme.C.

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

Referenced by edgeLimitedGrad< Type >::edgeLimitedGrad(), faceLimitedGrad< Type >::faceLimitedGrad(), Foam::fac::grad(), and Foam::fac::ngrad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mesh()

template<class Type>

const faMesh & mesh ( ) const

inlinenoexcept

Return mesh reference.

Definition at line 131 of file faGradScheme.H.

References Foam::noexcept.

Referenced by leastSquaresFaGrad< Type >::calcGrad(), declareRunTimeSelectionTable(), edgeLimitedGrad< Type >::edgeLimitedGrad(), faceLimitedGrad< Type >::faceLimitedGrad(), gaussGrad< Type >::gaussGrad(), gaussGrad< Type >::gaussGrad(), gradScheme(), leastSquaresFaGrad< Type >::leastSquaresFaGrad(), leastSquaresFaGrad< Type >::leastSquaresFaGrad(), and New().

Here is the caller graph for this function:

◆ calcGrad()

template<class Type>

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 edgeLimitedGrad< Type >, faceLimitedGrad< Type >, gaussGrad< Type >, and leastSquaresFaGrad< Type >.

References Foam::name().

Referenced by grad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ grad() [1/3]

template<class Type>

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

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

Definition at line 92 of file faGradScheme.C.

References solution::cachePrintMessage(), calcGrad(), mesh, Foam::name(), and regIOobject::store().

Referenced by grad(), grad(), and leastSquaresEdgeInterpolation< Type >::interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ grad() [2/3]

template<class Type>

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

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

Definition at line 155 of file faGradScheme.C.

References grad(), and IOobject::name().

Here is the call graph for this function:

◆ grad() [3/3]

template<class Type>

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

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

Definition at line 174 of file faGradScheme.C.

References grad().

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ gradScheme() [1/2]

◆ gradScheme() [2/2]

◆ ~gradScheme()

Member Function Documentation

◆ declareRunTimeSelectionTable()

◆ operator=()

◆ New()

◆ mesh()

◆ calcGrad()

◆ grad() [1/3]

◆ grad() [2/3]

◆ grad() [3/3]