Abstract base class for lnGrad schemes. More...

#include <lnGradScheme.H>

Inheritance diagram for lnGradScheme< Type >:

[legend]

Collaboration diagram for lnGradScheme< Type >:

Public Member Functions
	declareRunTimeSelectionTable (tmp, lnGradScheme, Mesh,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
	lnGradScheme (const lnGradScheme &)=delete
	No copy construct.
void	operator= (const lnGradScheme &)=delete
	No copy assignment.
	lnGradScheme (const faMesh &mesh)
	Construct from mesh.
virtual	~lnGradScheme ()
	Destructor.
const faMesh &	mesh () const noexcept
	Return mesh reference.
virtual tmp< edgeScalarField >	deltaCoeffs (const GeometricField< Type, faPatchField, areaMesh > &) 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, faePatchField, edgeMesh > >	correction (const GeometricField< Type, faPatchField, areaMesh > &) const
	Return the explicit correction to the lnGrad.
virtual tmp< GeometricField< Type, faePatchField, edgeMesh > >	lnGrad (const GeometricField< Type, faPatchField, areaMesh > &) const
	Return the lnGrad of the given cell field.
tmp< GeometricField< Type, faePatchField, edgeMesh > >	lnGrad (const tmp< GeometricField< Type, faPatchField, areaMesh > > &) const
	Return the lnGrad of the given tmp cell field.
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< lnGradScheme< Type > >	New (const faMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme.
static tmp< GeometricField< Type, faePatchField, edgeMesh > >	lnGrad (const GeometricField< Type, faPatchField, areaMesh > &, const tmp< edgeScalarField > &, const word &snGradName="lnGrad")
	Return the lnGrad of the given cell field.

Detailed Description

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

Abstract base class for lnGrad schemes.

Source files

Definition at line 57 of file lnGradScheme.H.

Constructor & Destructor Documentation

◆ lnGradScheme() [1/2]

template<class Type>

lnGradScheme ( const lnGradScheme< Type > & )

delete

No copy construct.

References lnGradScheme().

Referenced by correctedLnGrad< Type >::correctedLnGrad(), correctedLnGrad< Type >::correctedLnGrad(), declareRunTimeSelectionTable(), fourthLnGrad< Type >::fourthLnGrad(), fourthLnGrad< Type >::fourthLnGrad(), limitedLnGrad< Type >::limitedLnGrad(), limitedLnGrad< Type >::limitedLnGrad(), lnGradScheme(), operator=(), uncorrectedLnGrad< Type >::uncorrectedLnGrad(), and uncorrectedLnGrad< Type >::uncorrectedLnGrad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lnGradScheme() [2/2]

template<class Type>

lnGradScheme ( const faMesh & mesh )

inline

Construct from mesh.

Definition at line 101 of file lnGradScheme.H.

References mesh().

Here is the call graph for this function:

◆ ~lnGradScheme()

template<class Type>

~lnGradScheme ( )

virtual

Destructor.

Definition at line 84 of file lnGradScheme.C.

Member Function Documentation

◆ declareRunTimeSelectionTable()

template<class Type>

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

References lnGradScheme(), and mesh().

Here is the call graph for this function:

◆ operator=()

template<class Type>

void operator= ( const lnGradScheme< Type > & )

delete

No copy assignment.

References lnGradScheme().

Here is the call graph for this function:

◆ New()

template<class Type>

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

static

Return new tmp interpolation scheme.

Definition at line 40 of file lnGradScheme.C.

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

Referenced by correctedLnGrad< Type >::correction(), and Foam::fac::lnGrad().

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 130 of file lnGradScheme.H.

References Foam::noexcept.

Here is the caller graph for this function:

◆ lnGrad() [1/3]

template<class Type>

tmp< GeometricField< Type, faePatchField, edgeMesh > > lnGrad	(	const GeometricField< Type, faPatchField, areaMesh > &	vf,
		const tmp< edgeScalarField > &	tdeltaCoeffs,
		const word &	snGradName = "lnGrad" )