faNVDscheme< Type, NVDweight > Class Template Reference

Class to create the weighting-factors based on the NVD (Normalised Variable Diagram). More...

Inheritance diagram for faNVDscheme< Type, NVDweight >:
[legend]
Collaboration diagram for faNVDscheme< Type, NVDweight >:
[legend]

Public Types

typedef NVDweight Weight
 Define a typedef for the NVDweight. More...
 

Public Member Functions

 TypeName ("faNVDscheme")
 Runtime type information. More...
 
 faNVDscheme (const faMesh &mesh, const edgeScalarField &edgeFlux, const NVDweight &weight)
 Construct from mesh and edgeFlux and blendingFactor. More...
 
 faNVDscheme (const faMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 faNVDscheme (const faMesh &mesh, const edgeScalarField &edgeFlux, Istream &is)
 Construct from mesh, edgeFlux and Istream. More...
 
virtual tmp< edgeScalarFieldweights (const GeometricField< Type, faPatchField, areaMesh > &) const
 Return the interpolation weighting factors. More...
 
- Public Member Functions inherited from edgeInterpolationScheme< Type >
 declareRunTimeSelectionTable (tmp, edgeInterpolationScheme, Mesh,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 declareRunTimeSelectionTable (tmp, edgeInterpolationScheme, MeshFlux,(const faMesh &mesh, const edgeScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
 
 edgeInterpolationScheme (const faMesh &mesh)
 Construct from mesh. More...
 
virtual ~edgeInterpolationScheme ()
 
const faMeshmesh () const
 Return mesh reference. More...
 
virtual tmp< edgeScalarFieldweights (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 face-interpolate. More...
 
virtual tmp< GeometricField< Type, faePatchField, edgeMesh > > interpolate (const GeometricField< Type, faPatchField, areaMesh > &) const
 Return the face-interpolate of the given cell field. More...
 
virtual tmp< GeometricField< Type, faePatchField, edgeMesh > > euclidianInterpolate (const GeometricField< Type, faPatchField, areaMesh > &) const
 Return the euclidian edge-interpolate of the given area field. More...
 
tmp< GeometricField< Type, faePatchField, edgeMesh > > interpolate (const tmp< GeometricField< Type, faPatchField, areaMesh > > &) const
 Return the face-interpolate 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...
 

Protected Member Functions

 faNVDscheme (const faNVDscheme &)=delete
 No copy construct. More...
 
void operator= (const faNVDscheme &)=delete
 No copy assignment. More...
 

Protected Attributes

const edgeScalarFieldedgeFlux_
 

Additional Inherited Members

- Static Public Member Functions inherited from edgeInterpolationScheme< Type >
static tmp< edgeInterpolationScheme< Type > > New (const faMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< edgeInterpolationScheme< Type > > New (const faMesh &mesh, const edgeScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< GeometricField< Type, faePatchField, edgeMesh > > interpolate (const GeometricField< Type, faPatchField, areaMesh > &, const tmp< edgeScalarField > &, const tmp< edgeScalarField > &)
 Return the face-interpolate of the given cell field. More...
 
static tmp< GeometricField< Type, faePatchField, edgeMesh > > interpolate (const GeometricField< Type, faPatchField, areaMesh > &, const tmp< edgeScalarField > &)
 Return the face-interpolate of the given cell field. More...
 
static tmp< GeometricField< Type, faePatchField, edgeMesh > > euclidianInterpolate (const GeometricField< Type, faPatchField, areaMesh > &, const tmp< edgeScalarField > &)
 Return the euclidian edge-interpolate of the given area field. More...
 

Detailed Description

template<class Type, class NVDweight>
class Foam::faNVDscheme< Type, NVDweight >

Class to create the weighting-factors based on the NVD (Normalised Variable Diagram).

The particular differencing scheme class is supplied as a template argument, the weight function of which is called by the weight function of this class for the internal edges as well as edges of coupled patches (e.g. processor-processor patches). The weight function is supplied the central-differencing weighting factor, the edge-flux, the cell and edge gradients (from which the normalised variable distribution may be created) and the cell centre distance.

This code organisation is both neat and efficient, allowing for convenient implementation of new schemes to run on parallelised cases.

Source files

Definition at line 63 of file faNVDscheme.H.

Member Typedef Documentation

◆ Weight

typedef NVDweight Weight

Define a typedef for the NVDweight.

Definition at line 86 of file faNVDscheme.H.

Constructor & Destructor Documentation

◆ faNVDscheme() [1/4]

faNVDscheme ( const faNVDscheme< Type, NVDweight > &  )
protecteddelete

No copy construct.

◆ faNVDscheme() [2/4]

faNVDscheme ( const faMesh mesh,
const edgeScalarField edgeFlux,
const NVDweight &  weight 
)
inline

Construct from mesh and edgeFlux and blendingFactor.

Definition at line 96 of file faNVDscheme.H.

◆ faNVDscheme() [3/4]

faNVDscheme ( const faMesh mesh,
Istream is 
)
inline

Construct from mesh and Istream.

The name of the flux field is read from the Istream and looked-up from the database

Definition at line 111 of file faNVDscheme.H.

◆ faNVDscheme() [4/4]

faNVDscheme ( const faMesh mesh,
const edgeScalarField edgeFlux,
Istream is 
)
inline

Construct from mesh, edgeFlux and Istream.

Definition at line 129 of file faNVDscheme.H.

Member Function Documentation

◆ operator=()

void operator= ( const faNVDscheme< Type, NVDweight > &  )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "faNVDscheme< Type, NVDweight >"  )

Runtime type information.

◆ weights()

Foam::tmp< Foam::edgeScalarField > weights ( const GeometricField< Type, faPatchField, areaMesh > &  phi) const
virtual

Return the interpolation weighting factors.

Implements edgeInterpolationScheme< Type >.

Definition at line 58 of file faNVDscheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), coupled(), forAll, Foam::limiter(), mesh, n, Vector< Cmpt >::normalise(), phi, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), tmp< T >::ref(), and Vector< Cmpt >::removeCollinear().

Here is the call graph for this function:

Member Data Documentation

◆ edgeFlux_

const edgeScalarField& edgeFlux_
protected

Definition at line 72 of file faNVDscheme.H.


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