CoBlended< Type > Class Template Reference

Two-scheme Courant number based blending differencing scheme. More...

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

Public Member Functions

 TypeName ("CoBlended")
 Runtime type information. More...
 
 CoBlended (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 CoBlended (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from mesh, faceFlux and Istream. More...
 
 CoBlended (const CoBlended &)=delete
 Disallow default bitwise copy construction. More...
 
virtual tmp< surfaceScalarFieldblendingFactor (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 Return the face-based blending factor. 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...
 
void operator= (const CoBlended &)=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 &)
 Disallow default bitwise copy construction. More...
 
virtual ~surfaceInterpolationScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual tmp< GeometricField< typename innerProduct< vector, Type >::type, fvsPatchField, surfaceMesh > > dotInterpolate (const surfaceVectorField &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf) const
 Return the face-interpolate of the given cell field. More...
 
tmp< GeometricField< typename innerProduct< vector, Type >::type, fvsPatchField, surfaceMesh > > dotInterpolate (const surfaceVectorField &Sf, const tmp< GeometricField< Type, fvPatchField, volMesh >> &) const
 Return the face-interpolate of the given tmp cell field. 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...
 
void operator= (const surfaceInterpolationScheme &)=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...
 
- Public Member Functions inherited from blendedSchemeBase< Type >
 blendedSchemeBase ()
 Constructor. More...
 
virtual ~blendedSchemeBase ()
 Destructor. 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...
 
template<class SFType >
static tmp< GeometricField< typename innerProduct< typename SFType::value_type, Type >::type, fvsPatchField, surfaceMesh > > dotInterpolate (const SFType &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf, const tmp< surfaceScalarField > &tlambdas)
 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...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 

Detailed Description

template<class Type>
class Foam::CoBlended< Type >

Two-scheme Courant number based blending differencing scheme.

Similar to localBlended but uses a blending factor computed from the face-based Courant number and the lower and upper Courant number limits supplied:

\[ weight = 1 - max(min((Co - Co1)/(Co2 - Co1), 1), 0) \]

where

$ Co1 $ = Courant number below which scheme1 is used
$ Co2 $ = Courant number above which scheme2 is used

The weight applies to the first scheme and 1-weight to the second scheme.

Example of the CoBlended scheme specification using LUST for Courant numbers less than 1 and linearUpwind for Courant numbers greater than 10:

    divSchemes
    {
        .
        .
        div(phi,U)      Gauss CoBlended 1 LUST grad(U) 10 linearUpwind grad(U);
        .
        .
    }
Source files

Definition at line 86 of file CoBlended.H.

Constructor & Destructor Documentation

◆ CoBlended() [1/3]

CoBlended ( 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 121 of file CoBlended.H.

References Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.

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

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

◆ CoBlended() [2/3]

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

Construct from mesh, faceFlux and Istream.

Definition at line 154 of file CoBlended.H.

References CoBlended< Type >::blendingFactor(), CoBlended< Type >::CoBlended(), Foam::exit(), Foam::FatalIOError, and FatalIOErrorInFunction.

Here is the call graph for this function:

◆ CoBlended() [3/3]

CoBlended ( const CoBlended< Type > &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "CoBlended< Type >"  )

Runtime type information.

◆ blendingFactor()

◆ weights()

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

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 238 of file CoBlended.H.

References CoBlended< Type >::blendingFactor(), and CoBlended< Type >::interpolate().

Referenced by CoBlended< Type >::blendingFactor().

Here is the call graph for this function:
Here is the caller 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 254 of file CoBlended.H.

References CoBlended< Type >::blendingFactor().

Referenced by CoBlended< Type >::weights().

Here is the call graph for this function:
Here is the caller 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 267 of file CoBlended.H.

References CoBlended< Type >::correction().

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

Here is the call graph for this function:
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 277 of file CoBlended.H.

References CoBlended< Type >::blendingFactor(), CoBlended< Type >::corrected(), and CoBlended< Type >::operator=().

Referenced by CoBlended< Type >::corrected().

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

◆ operator=()

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

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

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