gaussGrad< Type > Class Template Reference

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

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

Public Member Functions

 TypeName ("Gauss")
 Runtime type information. More...
 
 gaussGrad (const fvMesh &mesh)
 Construct from mesh. More...
 
 gaussGrad (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 gaussGrad (const gaussGrad &)=delete
 Disallow default bitwise copy construction. More...
 
virtual tmp< VolField< typename outerProduct< vector, Type >::type > > calcGrad (const VolField< Type > &vsf, const word &name) const
 Return the gradient of the given field to the gradScheme::grad. More...
 
void operator= (const gaussGrad &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from gradScheme< Type >
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 gradScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
 gradScheme (const gradScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~gradScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
tmp< VolField< typename outerProduct< vector, Type >::type > > grad (const VolField< Type > &, const word &name) const
 Calculate and return the grad of the given field. More...
 
tmp< VolField< typename outerProduct< vector, Type >::type > > grad (const VolField< Type > &) const
 Calculate and return the grad of the given field. More...
 
tmp< VolField< typename outerProduct< vector, Type >::type > > grad (const tmp< VolField< Type >> &) const
 Calculate and return the grad of the given field. More...
 
void operator= (const gradScheme &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Static Public Member Functions

static tmp< VolField< typename outerProduct< vector, Type >::type > > gradf (const SurfaceField< Type > &, const word &name)
 Return the gradient of the given field. More...
 
static void correctBoundaryConditions (const VolField< Type > &, VolField< typename outerProduct< vector, Type >::type > &)
 Correct the boundary values of the gradient using the patchField. More...
 
- Static Public Member Functions inherited from gradScheme< Type >
static tmp< gradScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return a pointer to a new gradScheme created on freestore. More...
 

Protected Attributes

tmp< surfaceInterpolationScheme< Type > > tinterpScheme_
 

Additional Inherited Members

- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 

Detailed Description

template<class Type>
class Foam::fv::gaussGrad< Type >

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

Source files

Definition at line 57 of file gaussGrad.H.

Constructor & Destructor Documentation

◆ gaussGrad() [1/3]

gaussGrad ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 78 of file gaussGrad.H.

◆ gaussGrad() [2/3]

gaussGrad ( const fvMesh mesh,
Istream is 
)
inline

Construct from mesh and Istream.

Definition at line 85 of file gaussGrad.H.

References IOstream::eof(), gradScheme< Type >::mesh(), surfaceInterpolationScheme< Type >::New(), and gaussGrad< Type >::tinterpScheme_.

Here is the call graph for this function:

◆ gaussGrad() [3/3]

gaussGrad ( const gaussGrad< Type > &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "Gauss"  )

Runtime type information.

◆ gradf()

static tmp<VolField<typename outerProduct<vector, Type>::type> > gradf ( const SurfaceField< Type > &  ,
const word name 
)
static

Return the gradient of the given field.

calculated using Gauss' theorem on the given surface field

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

Here is the caller graph for this function:

◆ calcGrad()

virtual tmp<VolField<typename outerProduct<vector, Type>::type> > calcGrad ( const VolField< Type > &  vsf,
const word name 
) const
virtual

Return the gradient of the given field to the gradScheme::grad.

for optional caching

Implements gradScheme< Type >.

Reimplemented in filmGaussGrad< Type >.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( const VolField< Type > &  vsf,
VolField< typename outerProduct< vector, Type >::type > &  gGrad 
)
static

Correct the boundary values of the gradient using the patchField.

snGrad functions

Definition at line 125 of file gaussGrad.C.

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

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.

Member Data Documentation

◆ tinterpScheme_

tmp<surfaceInterpolationScheme<Type> > tinterpScheme_
protected

Definition at line 66 of file gaussGrad.H.

Referenced by gaussGrad< Type >::gaussGrad().


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