limitedSurfaceInterpolationScheme< Type > Class Template Referenceabstract

Abstract base class for limited surface interpolation schemes. More...

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

Public Member Functions

 TypeName ("limitedSurfaceInterpolationScheme")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, limitedSurfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 declareRunTimeSelectionTable (tmp, limitedSurfaceInterpolationScheme, MeshFlux,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
 
 limitedSurfaceInterpolationScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux)
 Construct from mesh and faceFlux. More...
 
 limitedSurfaceInterpolationScheme (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 limitedSurfaceInterpolationScheme (const limitedSurfaceInterpolationScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~limitedSurfaceInterpolationScheme ()
 Destructor. More...
 
virtual tmp< surfaceScalarFieldlimiter (const VolField< Type > &) const =0
 Return the interpolation weighting factors. More...
 
tmp< surfaceScalarFieldweights (const VolField< Type > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) const
 Return the interpolation weighting factors for the given field,. More...
 
virtual tmp< surfaceScalarFieldweights (const VolField< Type > &) const
 Return the interpolation weighting factors for the given field. More...
 
virtual tmp< SurfaceField< Type > > flux (const VolField< Type > &) const
 Return the interpolation weighting factors. More...
 
void operator= (const limitedSurfaceInterpolationScheme &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from surfaceInterpolationScheme< Type >
 TypeName ("surfaceInterpolationScheme")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
 
 declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, MeshFlux,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
 
 surfaceInterpolationScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
 surfaceInterpolationScheme (const surfaceInterpolationScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~surfaceInterpolationScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual bool corrected () const
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< SurfaceField< Type > > correction (const VolField< Type > &) const
 Return the explicit correction to the face-interpolate. More...
 
virtual tmp< SurfaceField< typename innerProduct< vector, Type >::type > > dotInterpolate (const surfaceVectorField &Sf, const VolField< Type > &vf) const
 Return the face-interpolate of the given cell field. More...
 
tmp< SurfaceField< typename innerProduct< vector, Type >::type > > dotInterpolate (const surfaceVectorField &Sf, const tmp< VolField< Type >> &) const
 Return the face-interpolate of the given tmp cell field. More...
 
virtual tmp< SurfaceField< Type > > interpolate (const VolField< Type > &) const
 Return the face-interpolate of the given cell field. More...
 
tmp< SurfaceField< Type > > interpolate (const tmp< VolField< Type >> &) const
 Return the face-interpolate of the given tmp cell field. More...
 
void operator= (const surfaceInterpolationScheme &)=delete
 Disallow default bitwise assignment. More...
 
tmp< SurfaceField< typename innerProduct< vector, scalar >::type > > dotInterpolate (const surfaceVectorField &Sf, const VolField< scalar > &) const
 
- 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< limitedSurfaceInterpolationScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< limitedSurfaceInterpolationScheme< Type > > New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
- Static Public Member Functions inherited from surfaceInterpolationScheme< Type >
static tmp< surfaceInterpolationScheme< Type > > New (const fvMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< surfaceInterpolationScheme< Type > > New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< SurfaceField< Type > > interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field. More...
 
template<class SFType >
static tmp< SurfaceField< typename innerProduct< typename SFType::value_type, Type >::type > > dotInterpolate (const SFType &Sf, const VolField< Type > &vf, const tmp< surfaceScalarField > &tlambdas)
 Return the face-interpolate of the given cell field. More...
 
static tmp< SurfaceField< Type > > interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field. More...
 

Protected Attributes

const surfaceScalarFieldfaceFlux_
 

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

Abstract base class for limited surface interpolation schemes.

Source files

Definition at line 49 of file limitedSurfaceInterpolationScheme.H.

Constructor & Destructor Documentation

◆ limitedSurfaceInterpolationScheme() [1/3]

limitedSurfaceInterpolationScheme ( const fvMesh mesh,
const surfaceScalarField faceFlux 
)
inline

Construct from mesh and faceFlux.

Definition at line 98 of file limitedSurfaceInterpolationScheme.H.

◆ limitedSurfaceInterpolationScheme() [2/3]

limitedSurfaceInterpolationScheme ( const fvMesh 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 mesh objectRegistry

Definition at line 111 of file limitedSurfaceInterpolationScheme.H.

◆ limitedSurfaceInterpolationScheme() [3/3]

Disallow default bitwise copy construction.

◆ ~limitedSurfaceInterpolationScheme()

Destructor.

Definition at line 132 of file limitedSurfaceInterpolationScheme.C.

Member Function Documentation

◆ TypeName()

TypeName ( "limitedSurfaceInterpolationScheme< Type >"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( tmp  ,
limitedSurfaceInterpolationScheme< Type >  ,
Mesh  ,
(const fvMesh &mesh, Istream &schemeData)  ,
(mesh, schemeData)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( tmp  ,
limitedSurfaceInterpolationScheme< Type >  ,
MeshFlux  ,
(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)  ,
(mesh, faceFlux, schemeData)   
)

◆ New() [1/2]

Foam::tmp< Foam::limitedSurfaceInterpolationScheme< Type > > New ( const fvMesh mesh,
Istream schemeData 
)
static

Return new tmp interpolation scheme.

Definition at line 35 of file limitedSurfaceInterpolationScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, and Foam::nl.

Here is the call graph for this function:

◆ New() [2/2]

Foam::tmp< Foam::limitedSurfaceInterpolationScheme< Type > > New ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream schemeData 
)
static

Return new tmp interpolation scheme.

Definition at line 82 of file limitedSurfaceInterpolationScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, and Foam::nl.

Here is the call graph for this function:

◆ limiter()

virtual tmp<surfaceScalarField> limiter ( const VolField< Type > &  ) const
pure virtual

Return the interpolation weighting factors.

Implemented in upwind< Type >, PhiScheme< Type, PhiLimiter >, LimitedScheme< Type, Limiter, LimitFunc >, and blended< Type >.

◆ weights() [1/2]

Foam::tmp< Foam::surfaceScalarField > weights ( const VolField< Type > &  phi,
const surfaceScalarField CDweights,
tmp< surfaceScalarField tLimiter 
) const

Return the interpolation weighting factors for the given field,.

by limiting the given weights with the given limiter

Definition at line 141 of file limitedSurfaceInterpolationScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, patchi, Foam::pos0(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), and tmp< T >::ref().

Here is the call graph for this function:

◆ weights() [2/2]

Foam::tmp< Foam::surfaceScalarField > weights ( const VolField< Type > &  phi) const
virtual

Return the interpolation weighting factors for the given field.

Implements surfaceInterpolationScheme< Type >.

Reimplemented in blended< Type >, LUST< Type >, and upwind< Type >.

Definition at line 184 of file limitedSurfaceInterpolationScheme.C.

References Foam::MULES::limiter().

Here is the call graph for this function:

◆ flux()

Foam::tmp< Foam::SurfaceField< Type > > flux ( const VolField< Type > &  phi) const
virtual

Return the interpolation weighting factors.

Definition at line 199 of file limitedSurfaceInterpolationScheme.C.

References Foam::fvc::interpolate().

Referenced by Foam::MULES::limit(), and Foam::MULES::limitSum().

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

◆ operator=()

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

Disallow default bitwise assignment.

Member Data Documentation

◆ faceFlux_


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