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

Central-difference lnGrad scheme with limited non-orthogonal correction. More...

Inheritance diagram for limitedLnGrad< Type >:
Inheritance graph
[legend]
Collaboration diagram for limitedLnGrad< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("limited")
 Runtime type information. More...
 
 limitedLnGrad (const limitedLnGrad &)=delete
 No copy construct. More...
 
void operator= (const limitedLnGrad &)=delete
 No copy assignment. More...
 
 limitedLnGrad (const faMesh &mesh)
 Construct from mesh. More...
 
 limitedLnGrad (const faMesh &mesh, Istream &is)
 Construct from mesh and data stream. More...
 
virtual ~limitedLnGrad ()=default
 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 limitedLnGrad for the given field. More...
 
- 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. More...
 
void operator= (const lnGradScheme &)=delete
 No copy assignment. More...
 
 lnGradScheme (const faMesh &mesh)
 Construct from mesh. More...
 
virtual ~lnGradScheme ()
 Destructor. More...
 
const faMesh & mesh () const noexcept
 Return mesh reference. 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...
 

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::limitedLnGrad< Type >

Central-difference lnGrad scheme with limited non-orthogonal correction.

The limiter is controlled by a coefficient with a value between 0 and 1 which when 0 switches the correction off and the scheme behaves as uncorrectedSnGrad, when set to 1 the full correction is applied and the scheme behaves as correctedSnGrad and when set to 0.5 the limiter is calculated such that the non-orthogonal contribution does not exceed the orthogonal part.

Author Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 59 of file limitedLnGrad.H.

Constructor & Destructor Documentation

◆ limitedLnGrad() [1/3]

limitedLnGrad ( const limitedLnGrad< Type > &  )
delete

No copy construct.

◆ limitedLnGrad() [2/3]

limitedLnGrad ( const faMesh &  mesh)
inline

Construct from mesh.

Definition at line 97 of file limitedLnGrad.H.

◆ limitedLnGrad() [3/3]

limitedLnGrad ( const faMesh &  mesh,
Istream &  is 
)
inline

Construct from mesh and data stream.

Definition at line 107 of file limitedLnGrad.H.

References Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.

Here is the call graph for this function:

◆ ~limitedLnGrad()

virtual ~limitedLnGrad ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "limited"  )

Runtime type information.

◆ operator=()

void operator= ( const limitedLnGrad< Type > &  )
delete

No copy assignment.

◆ 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 134 of file limitedLnGrad.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 144 of file limitedLnGrad.H.

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

Here is the call 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 limitedLnGrad for the given field.

Reimplemented from lnGradScheme< Type >.

Definition at line 42 of file limitedLnGrad.C.

References Foam::average(), Foam::correction(), Foam::ensightOutput::debug, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimless, Foam::endl(), Foam::Info, Foam::limiter(), Foam::mag(), Foam::max(), mesh, and Foam::min().

Here is the call graph for this function:
The documentation for this class was generated from the following files: