Public Member Functions | List of all members
correctedLnGrad< Type > Class Template Reference

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

Inheritance diagram for correctedLnGrad< Type >:
[legend]
Collaboration diagram for correctedLnGrad< Type >:
[legend]

Public Member Functions

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

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. 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::correctedLnGrad< Type >

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

Source files

Definition at line 56 of file correctedLnGrad.H.

Constructor & Destructor Documentation

◆ correctedLnGrad() [1/2]

correctedLnGrad ( const faMesh &  mesh)
inline

Construct from mesh.

Definition at line 75 of file correctedLnGrad.H.

◆ correctedLnGrad() [2/2]

correctedLnGrad ( const faMesh &  mesh,
Istream &   
)
inline

Construct from mesh and data stream.

Definition at line 82 of file correctedLnGrad.H.

◆ ~correctedLnGrad()

~correctedLnGrad
virtual

Destructor.

Definition at line 47 of file correctedLnGrad.C.

Member Function Documentation

◆ TypeName()

TypeName ( "corrected"  )

Runtime type information.

◆ deltaCoeffs()

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 95 of file correctedLnGrad.H.

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

Here is the call graph for this function:

◆ corrected()

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from lnGradScheme< Type >.

Definition at line 104 of file correctedLnGrad.H.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correction()

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 55 of file correctedLnGrad.C.

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

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: