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

Two-scheme fixed-blending differencing scheme. More...

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

Public Member Functions

 TypeName ("fixedBlended")
 Runtime type information. More...
 
 fixedBlended (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream. More...
 
 fixedBlended (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

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

Private Attributes

const scalar blendingFactor_
 
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::fixedBlended< Type >

Two-scheme fixed-blending differencing scheme.

Similar to localBlended but uses a single (global) constant blending factor. The factor applies to the first scheme and 1-factor to the second scheme.

Note
Although a blending factor of 0 and 1 is permitted, it is more efficient just to use the underlying scheme directly.
Source files

Definition at line 57 of file fixedBlended.H.

Constructor & Destructor Documentation

◆ fixedBlended() [1/3]

fixedBlended ( const fixedBlended< Type > &  )
private

Disallow default bitwise copy construct.

◆ fixedBlended() [2/3]

fixedBlended ( 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 93 of file fixedBlended.H.

References fixedBlended< Type >::blendingFactor_, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, fixedBlended< Type >::tScheme1_, and fixedBlended< Type >::tScheme2_.

Here is the call graph for this function:

◆ fixedBlended() [3/3]

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

Construct from mesh, faceFlux and Istream.

Definition at line 129 of file fixedBlended.H.

References fixedBlended< Type >::blendingFactor_, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, fixedBlended< Type >::tScheme1_, and fixedBlended< Type >::tScheme2_.

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

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

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "fixedBlended< 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 169 of file fixedBlended.H.

References fixedBlended< Type >::blendingFactor_, fixedBlended< Type >::tScheme1_, and fixedBlended< Type >::tScheme2_.

◆ 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 183 of file fixedBlended.H.

References fixedBlended< Type >::blendingFactor_, fixedBlended< Type >::tScheme1_, and fixedBlended< Type >::tScheme2_.

◆ corrected()

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 194 of file fixedBlended.H.

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

Referenced by fixedBlended< 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 204 of file fixedBlended.H.

References fixedBlended< Type >::blendingFactor_, fixedBlended< Type >::corrected(), fixedBlended< Type >::tScheme1_, and fixedBlended< Type >::tScheme2_.

Here is the call graph for this function:

Field Documentation

◆ blendingFactor_

const scalar blendingFactor_
private

◆ tScheme1_

tmp<surfaceInterpolationScheme<Type> > tScheme1_
private

◆ tScheme2_

tmp<surfaceInterpolationScheme<Type> > tScheme2_
private

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