cellCoBlended< Type > Class Template Reference

Two-scheme cell-based Courant number based blending interpolation scheme. More...

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

Public Member Functions

 TypeName ("cellCoBlended")
 Runtime type information. More...
 
 cellCoBlended (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 cellCoBlended (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from mesh, faceFlux and Istream. More...
 
 cellCoBlended (const cellCoBlended &)=delete
 Disallow default bitwise copy construction. More...
 
virtual tmp< surfaceScalarFieldblendingFactor (const VolField< Type > &vf) const
 Return the face-based blending factor. More...
 
tmp< surfaceScalarFieldweights (const VolField< Type > &vf) const
 Return the interpolation weighting factors. More...
 
tmp< SurfaceField< Type > > interpolate (const VolField< Type > &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< SurfaceField< Type > > correction (const VolField< Type > &vf) const
 Return the explicit correction to the face-interpolate. More...
 
void operator= (const cellCoBlended &)=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< 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...
 
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...
 
- 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< 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 Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 

Detailed Description

template<class Type>
class Foam::cellCoBlended< Type >

Two-scheme cell-based Courant number based blending interpolation scheme.

This scheme is equivalent to the CoBlended scheme except that the Courant number is evaluated for cells using the same approach as use in the finite-volume solvers and then interpolated to the faces rather than being estimated directly at the faces based on the flux. This is a more consistent method for evaluating the Courant number but suffers from the need to interpolate which introduces a degree of freedom. However, the interpolation scheme for "Co" is run-time selected and may be specified in "interpolationSchemes" and "localMax" might be most appropriate.

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

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

interpolationSchemes
{
    .
    .
    interpolate(Co) localMax;
    .
    .
}
See also
Foam::CoBlended Foam::localBlended
Source files

Definition at line 88 of file cellCoBlended.H.

Constructor & Destructor Documentation

◆ cellCoBlended() [1/3]

cellCoBlended ( 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 122 of file cellCoBlended.H.

◆ cellCoBlended() [2/3]

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

Construct from mesh, faceFlux and Istream.

Definition at line 155 of file cellCoBlended.H.

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

Here is the call graph for this function:

◆ cellCoBlended() [3/3]

cellCoBlended ( const cellCoBlended< Type > &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "cellCoBlended< Type >"  )

Runtime type information.

◆ blendingFactor()

◆ weights()

tmp<surfaceScalarField> weights ( const VolField< Type > &  vf) const
inlinevirtual

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 257 of file cellCoBlended.H.

References cellCoBlended< Type >::blendingFactor().

Here is the call graph for this function:

◆ interpolate()

tmp<SurfaceField<Type> > interpolate ( const VolField< Type > &  vf) const
inlinevirtual

Return the face-interpolate of the given cell field.

with explicit correction

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 273 of file cellCoBlended.H.

References cellCoBlended< Type >::blendingFactor().

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 287 of file cellCoBlended.H.

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

Here is the caller graph for this function:

◆ correction()

virtual tmp<SurfaceField<Type> > correction ( const VolField< Type > &  vf) const
inlinevirtual

Return the explicit correction to the face-interpolate.

for the given field

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 296 of file cellCoBlended.H.

References cellCoBlended< Type >::blendingFactor(), and cellCoBlended< Type >::corrected().

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.


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