Abstract base class for lnGrad schemes. More...

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 faMesh &mesh)
	Construct from mesh. More...

virtual	~lnGradScheme ()
	Destructor. More...

const faMesh &	mesh () const
	Return mesh reference. More...

virtual tmp< edgeScalarField >	deltaCoeffs (const GeometricField< Type, faPatchField, areaMesh > &) const =0
	Return the interpolation weighting factors for the given field. More...

virtual bool	corrected () const
	Return true if this scheme uses an explicit correction. More...

virtual tmp< GeometricField< Type, faePatchField, edgeMesh > >	correction (const GeometricField< Type, faPatchField, areaMesh > &) const
	Return the explicit correction to the lnGrad. More...

virtual tmp< GeometricField< Type, faePatchField, edgeMesh > >	lnGrad (const GeometricField< Type, faPatchField, areaMesh > &) const
	Return the lnGrad of the given cell field. More...

tmp< GeometricField< Type, faePatchField, edgeMesh > >	lnGrad (const tmp< GeometricField< Type, faPatchField, areaMesh >> &) const
	Return the lnGrad of the given tmp cell field. 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< lnGradScheme< Type > >	New (const faMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme. More...

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. More...

Detailed Description

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

Abstract base class for lnGrad schemes.

Source files

Definition at line 58 of file lnGradScheme.H.

Constructor & Destructor Documentation

◆ lnGradScheme()

lnGradScheme ( const faMesh & mesh )

inline

Construct from mesh.

Definition at line 97 of file lnGradScheme.H.

◆ ~lnGradScheme()

~lnGradScheme ( )

virtual

Destructor.

Definition at line 85 of file lnGradScheme.C.

Member Function Documentation

◆ declareRunTimeSelectionTable()

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

◆ New()

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

static

Return new tmp interpolation scheme.

Definition at line 42 of file lnGradScheme.C.

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

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

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

Referenced by correctedLnGrad< Type >::corrected(), limitedLnGrad< Type >::corrected(), uncorrectedLnGrad< Type >::deltaCoeffs(), fourthLnGrad< Type >::deltaCoeffs(), correctedLnGrad< Type >::deltaCoeffs(), and limitedLnGrad< Type >::deltaCoeffs().

Here is the caller graph for this function:

◆ lnGrad() [1/3]

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

static

Return the lnGrad of the given cell field.

with the given weighting factors

Definition at line 94 of file lnGradScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), IOobject::db(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, IOobject::instance(), mesh, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and tmp< T >::ref().

Here is the call graph for this function:

◆ deltaCoeffs()

virtual tmp<edgeScalarField> deltaCoeffs ( const GeometricField< Type, faPatchField, areaMesh > & ) const

pure virtual

Return the interpolation weighting factors for the given field.

Implemented in limitedLnGrad< Type >, correctedLnGrad< Type >, fourthLnGrad< Type >, and uncorrectedLnGrad< Type >.

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented in limitedLnGrad< Type >, correctedLnGrad< Type >, fourthLnGrad< Type >, and uncorrectedLnGrad< Type >.

Definition at line 155 of file lnGradScheme.H.

◆ correction()

virtual tmp<GeometricField<Type, faePatchField, edgeMesh> > correction ( const GeometricField< Type, faPatchField, areaMesh > & ) const

inlinevirtual

Return the explicit correction to the lnGrad.

for the given field

Reimplemented in limitedLnGrad< Type >, correctedLnGrad< Type >, fourthLnGrad< Type >, and uncorrectedLnGrad< Type >.

Definition at line 166 of file lnGradScheme.H.

◆ lnGrad() [2/3]

tmp< GeometricField< Type, faePatchField, edgeMesh > > lnGrad ( const GeometricField< Type, faPatchField, areaMesh > & vf ) const

virtual

Return the lnGrad of the given cell field.

with explicit correction

Definition at line 148 of file lnGradScheme.C.

References Foam::correction(), Foam::fac::lnGrad(), and tmp< T >::ref().

Here is the call graph for this function:

◆ lnGrad() [3/3]

tmp< GeometricField< Type, faePatchField, edgeMesh > > lnGrad ( const tmp< GeometricField< Type, faPatchField, areaMesh >> & tvf ) const

Return the lnGrad of the given tmp cell field.

with explicit correction

Definition at line 167 of file lnGradScheme.C.

References Foam::fac::lnGrad().

Here is the call graph for this function:

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

src/finiteArea/finiteArea/lnGradSchemes/lnGradScheme/lnGradScheme.H
src/finiteArea/finiteArea/lnGradSchemes/lnGradScheme/lnGradScheme.C

Public Member Functions

Static Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ lnGradScheme()

◆ ~lnGradScheme()

Member Function Documentation

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ lnGrad() [1/3]

◆ deltaCoeffs()

◆ corrected()

◆ correction()

◆ lnGrad() [2/3]

◆ lnGrad() [3/3]

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