Loading...
Searching...
No Matches
edgeLimitedGrad< Type > Class Template Reference

edgeLimitedGrad gradient scheme applied to a runTime selected base gradient scheme. More...

#include <edgeLimitedFaGrad.H>

Inheritance diagram for edgeLimitedGrad< Type >:
Collaboration diagram for edgeLimitedGrad< Type >:

Public Member Functions

 TypeName ("edgeLimited")
 RunTime type information.
 edgeLimitedGrad (const edgeLimitedGrad &)=delete
 No copy construct.
void operator= (const edgeLimitedGrad &)=delete
 No copy assignment.
 edgeLimitedGrad (const faMesh &mesh, Istream &schemeData)
 Construct from mesh and schemeData.
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > calcGrad (const GeometricField< Type, faPatchField, areaMesh > &vsf, const word &name) const
 Return the gradient of the given field to the gradScheme::grad for optional caching.
Public Member Functions inherited from gradScheme< Type >
 declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
 gradScheme (const gradScheme &)=delete
 No copy construct.
void operator= (const gradScheme &)=delete
 No copy assignment.
 gradScheme (const faMesh &mesh)
 Construct from mesh.
virtual ~gradScheme ()=default
 Destructor.
const faMeshmesh () const noexcept
 Return mesh reference.
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const GeometricField< Type, faPatchField, areaMesh > &, const word &name) const
 Calculate and return the grad of the given field which may have been cached.
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const GeometricField< Type, faPatchField, areaMesh > &) const
 Calculate and return the grad of the given field with the default name which may have been cached.
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > grad (const tmp< GeometricField< Type, faPatchField, areaMesh > > &) const
 Calculate and return the grad of the given field with the default name which may have been cached.
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 gradScheme< Type >
static tmp< gradScheme< Type > > New (const faMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore.

Detailed Description

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

edgeLimitedGrad gradient scheme applied to a runTime selected base gradient scheme.

The scalar limiter based on limiting the extrapolated edge values between the edge-neighbour cell values and is applied to all components of the gradient.

Source files

Definition at line 58 of file edgeLimitedFaGrad.H.

Constructor & Destructor Documentation

◆ edgeLimitedGrad() [1/2]

template<class Type>
edgeLimitedGrad ( const edgeLimitedGrad< Type > & )
delete

No copy construct.

References edgeLimitedGrad().

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

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

◆ edgeLimitedGrad() [2/2]

template<class Type>
edgeLimitedGrad ( const faMesh & mesh,
Istream & schemeData )
inline

Construct from mesh and schemeData.

Definition at line 112 of file edgeLimitedFaGrad.H.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, gradScheme< Type >::gradScheme(), gradScheme< Type >::mesh(), and gradScheme< Type >::New().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>
TypeName ( "edgeLimited" )

RunTime type information.

◆ operator=()

template<class Type>
void operator= ( const edgeLimitedGrad< Type > & )
delete

No copy assignment.

References edgeLimitedGrad().

Here is the call graph for this function:

◆ calcGrad()

template<class Type>
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > calcGrad ( const GeometricField< Type, faPatchField, areaMesh > & vsf,
const word & name ) const
virtual

Return the gradient of the given field to the gradScheme::grad for optional caching.

Implements gradScheme< Type >.

References Foam::name().

Referenced by makeFaGradScheme().

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 file:
  • src/finiteArea/finiteArea/gradSchemes/limitedGradSchemes/edgeLimitedFaGrad/edgeLimitedFaGrad.H