Public Member Functions | Private Member Functions | Private Attributes
limiterBlended< Type > Class Template Reference

Blends two specified schemes using the limiter function provided by a limitedSurfaceInterpolationScheme. More...

Inheritance diagram for limiterBlended< Type >:
Inheritance graph
[legend]
Collaboration diagram for limiterBlended< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("limiterBlended")
 Runtime type information. More...
 
 limiterBlended (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 limiterBlended (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from mesh, faceFlux and Istream. More...
 
tmp< surfaceScalarFieldweights (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 Return the interpolation weighting factors. More...
 
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 Return the face-interpolate of the given cell field. More...
 
virtual bool corrected () const
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 Return the explicit correction to the face-interpolate. 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...
 
virtual ~surfaceInterpolationScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
 Return the face-interpolate of the given tmp cell field. More...
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to 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...
 

Private Member Functions

 limiterBlended (const limiterBlended &)
 Disallow default bitwise copy construct. More...
 
void operator= (const limiterBlended &)
 Disallow default bitwise assignment. More...
 

Private Attributes

tmp< limitedSurfaceInterpolationScheme< Type > > tLimitedScheme_
 Limited scheme providing the limiter. More...
 
tmp< surfaceInterpolationScheme< Type > > tScheme1_
 Scheme 1. More...
 
tmp< surfaceInterpolationScheme< Type > > tScheme2_
 Scheme 2. More...
 

Additional Inherited Members

- 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< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field. More...
 
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field. More...
 

Detailed Description

template<class Type>
class Foam::limiterBlended< Type >

Blends two specified schemes using the limiter function provided by a limitedSurfaceInterpolationScheme.

The limited scheme is specified first followed by the scheme to be scaled by the limiter and then the scheme scaled by 1 - limiter e.g.

div(phi,U) Gauss limiterBlended vanLeer linear linearUpwind grad(U);

Source files

Definition at line 55 of file limiterBlended.H.

Constructor & Destructor Documentation

◆ limiterBlended() [1/3]

limiterBlended ( const limiterBlended< Type > &  )
private

Disallow default bitwise copy construct.

◆ limiterBlended() [2/3]

limiterBlended ( 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 90 of file limiterBlended.H.

◆ limiterBlended() [3/3]

limiterBlended ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream is 
)
inline

Construct from mesh, faceFlux and Istream.

Definition at line 112 of file limiterBlended.H.

Member Function Documentation

◆ operator=()

void operator= ( const limiterBlended< Type > &  )
private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "limiterBlended< Type >"  )

Runtime type information.

◆ weights()

tmp<surfaceScalarField> weights ( const GeometricField< Type, fvPatchField, volMesh > &  vf) const
inlinevirtual

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 138 of file limiterBlended.H.

References Foam::MULES::limiter(), limiterBlended< Type >::tLimitedScheme_, limiterBlended< Type >::tScheme1_, and limiterBlended< Type >::tScheme2_.

Here is the call graph for this function:

◆ interpolate()

tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > interpolate ( const GeometricField< Type, fvPatchField, volMesh > &  vf) const
inlinevirtual

Return the face-interpolate of the given cell field.

with explicit correction

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 155 of file limiterBlended.H.

References Foam::MULES::limiter(), limiterBlended< Type >::tLimitedScheme_, limiterBlended< Type >::tScheme1_, and limiterBlended< Type >::tScheme2_.

Here is the call graph for this function:

◆ corrected()

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 169 of file limiterBlended.H.

References limiterBlended< Type >::tScheme1_, and limiterBlended< Type >::tScheme2_.

Referenced by limiterBlended< Type >::correction().

Here is the caller graph for this function:

◆ correction()

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction ( const GeometricField< Type, fvPatchField, volMesh > &  vf) const
inlinevirtual

Return the explicit correction to the face-interpolate.

for the given field

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 179 of file limiterBlended.H.

References limiterBlended< Type >::corrected(), Foam::MULES::limiter(), limiterBlended< Type >::tLimitedScheme_, limiterBlended< Type >::tScheme1_, and limiterBlended< Type >::tScheme2_.

Here is the call graph for this function:

Field Documentation

◆ tLimitedScheme_

tmp<limitedSurfaceInterpolationScheme<Type> > tLimitedScheme_
private

Limited scheme providing the limiter.

Definition at line 62 of file limiterBlended.H.

Referenced by limiterBlended< Type >::correction(), limiterBlended< Type >::interpolate(), and limiterBlended< Type >::weights().

◆ tScheme1_

tmp<surfaceInterpolationScheme<Type> > tScheme1_
private

◆ tScheme2_

tmp<surfaceInterpolationScheme<Type> > tScheme2_
private

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