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

Basic second-order gradient scheme using face-interpolation and Gauss' theorem. More...

#include <gaussFaGrad.H>

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

Public Member Functions

 TypeName ("Gauss")
 Runtime type information.
 gaussGrad (const gaussGrad &)=delete
 No copy construct.
void operator= (const gaussGrad &)=delete
 No copy assignment.
 gaussGrad (const faMesh &mesh)
 Construct from mesh.
 gaussGrad (const faMesh &mesh, Istream &is)
 Construct from Istream.
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.

Static Public Member Functions

static tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > gradf (const GeometricField< Type, faePatchField, edgeMesh > &, const word &name)
 Return the gradient of the given field calculated using Gauss' theorem on the given surface field.
static void correctBoundaryConditions (const GeometricField< Type, faPatchField, areaMesh > &, GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > &)
 Correct the boundary values of the gradient using the patchField.
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::gaussGrad< Type >

Basic second-order gradient scheme using face-interpolation and Gauss' theorem.

Source files

Definition at line 57 of file gaussFaGrad.H.

Constructor & Destructor Documentation

◆ gaussGrad() [1/3]

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

No copy construct.

References gaussGrad().

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

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

◆ gaussGrad() [2/3]

template<class Type>
gaussGrad ( const faMesh & mesh)
inline

Construct from mesh.

Definition at line 95 of file gaussFaGrad.H.

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

Here is the call graph for this function:

◆ gaussGrad() [3/3]

template<class Type>
gaussGrad ( const faMesh & mesh,
Istream & is )
inline

Construct from Istream.

Definition at line 104 of file gaussFaGrad.H.

References IOstream::eof(), gradScheme< Type >::gradScheme(), and gradScheme< Type >::mesh().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>
TypeName ( "Gauss" )

Runtime type information.

◆ operator=()

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

No copy assignment.

References gaussGrad().

Here is the call graph for this function:

◆ gradf()

template<class Type>
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > gradf ( const GeometricField< Type, faePatchField, edgeMesh > & ssf,
const word & name )
static

Return the gradient of the given field calculated using Gauss' theorem on the given surface field.

Definition at line 47 of file gaussFaGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::fac::edgeIntegrate(), DimensionedField< Type, GeoMesh >::mesh(), n, Foam::name(), and tmp< T >::ref().

Referenced by Foam::fac::grad().

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

◆ calcGrad()

template<class Type>
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 >.

Definition at line 78 of file gaussFaGrad.C.

References correctBoundaryConditions(), Foam::fac::edgeIntegrate(), Foam::interpolate(), DimensionedField< Type, GeoMesh >::mesh(), Foam::name(), and tmp< T >::ref().

Here is the call graph for this function:

◆ correctBoundaryConditions()

template<class Type>
void correctBoundaryConditions ( const GeometricField< Type, faPatchField, areaMesh > & vsf,
GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > & gGrad )
static

Correct the boundary values of the gradient using the patchField.

snGrad functions

Definition at line 107 of file gaussFaGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, and DimensionedField< Type, GeoMesh >::mesh().

Referenced by leastSquaresFaGrad< Type >::calcGrad(), makeFaGradScheme(), and 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 files: