correctedLnGrad< Type > Class Template Reference

Simple central-difference lnGrad scheme with non-orthogonal correction. More...

#include <correctedLnGrad.H>

Inheritance diagram for correctedLnGrad< Type >:

Collaboration diagram for correctedLnGrad< Type >:

Public Member Functions
	TypeName ("corrected")
	Runtime type information.
	correctedLnGrad (const correctedLnGrad &)=delete
	No copy construct.
void	operator= (const correctedLnGrad &)=delete
	No copy assignment.
	correctedLnGrad (const faMesh &mesh)
	Construct from mesh.
	correctedLnGrad (const faMesh &mesh, Istream &)
	Construct from mesh and data stream.
virtual	~correctedLnGrad ()
	Destructor.
virtual tmp< edgeScalarField >	deltaCoeffs (const GeometricField< Type, faPatchField, areaMesh > &) const
	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 correctedLnGrad.
Public Member Functions inherited from lnGradScheme< Type >
	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< 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.

Additional Inherited Members
Static Public Member Functions inherited from lnGradScheme< Type >
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::correctedLnGrad< Type >

Simple central-difference lnGrad scheme with non-orthogonal correction.

Source files

• correctedLnGrad.H
• correctedLnGrad.C

Definition at line 52 of file correctedLnGrad.H.

Constructor & Destructor Documentation

correctedLnGrad() [1/3]

template<class Type>

correctedLnGrad ( const correctedLnGrad< Type > & )

delete

No copy construct.

References correctedLnGrad().

Referenced by correctedLnGrad(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

correctedLnGrad() [2/3]

template<class Type>

correctedLnGrad ( const faMesh & mesh )

inline

Construct from mesh.

Definition at line 82 of file correctedLnGrad.H.

References lnGradScheme< Type >::lnGradScheme(), and lnGradScheme< Type >::mesh().

Here is the call graph for this function:

correctedLnGrad() [3/3]

template<class Type>

correctedLnGrad ( const faMesh & mesh, Istream &  )

inline

Construct from mesh and data stream.

Definition at line 91 of file correctedLnGrad.H.

References lnGradScheme< Type >::lnGradScheme(), and lnGradScheme< Type >::mesh().

Here is the call graph for this function:

~correctedLnGrad()

template<class Type>

~correctedLnGrad ( )

virtual

Destructor.

Definition at line 38 of file correctedLnGrad.C.

Member Function Documentation

TypeName()

template<class Type>

TypeName

(

"corrected"

)

Runtime type information.

operator=()

template<class Type>

void operator= ( const correctedLnGrad< Type > & )

delete

No copy assignment.

References correctedLnGrad().

Here is the call graph for this function:

deltaCoeffs()

template<class Type>

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

inlinevirtual

Return the interpolation weighting factors for the given field.

Implements lnGradScheme< Type >.

Definition at line 108 of file correctedLnGrad.H.

References edgeInterpolation::deltaCoeffs(), and lnGradScheme< Type >::mesh().

Here is the call graph for this function:

corrected()

template<class Type>

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from lnGradScheme< Type >.

Definition at line 119 of file correctedLnGrad.H.

References lnGradScheme< Type >::mesh(), and edgeInterpolation::orthogonal().

Here is the call graph for this function:

correction()

template<class Type>

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

virtual

Return the explicit correction to the correctedLnGrad.

for the given field

Reimplemented from lnGradScheme< Type >.

Definition at line 46 of file correctedLnGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::component(), IOobject::db(), DimensionedField< Type, GeoMesh >::dimensions(), IOobject::instance(), lnGradScheme< Type >::mesh(), mesh, IOobject::name(), lnGradScheme< Type >::New(), tmp< T >::ref(), and GeometricField< Type, PatchField, GeoMesh >::replace().

Referenced by fourthLnGrad< Type >::correction().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/finiteArea/finiteArea/lnGradSchemes/correctedLnGrad/correctedLnGrad.H
• src/finiteArea/finiteArea/lnGradSchemes/correctedLnGrad/correctedLnGrad.C