upwind< Type > Class Template Reference

Upwind interpolation scheme class. More...

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

Public Member Functions

 TypeName ("upwind")
 Runtime type information. More...
 
 upwind (const fvMesh &mesh, const surfaceScalarField &faceFlux)
 Construct from faceFlux. More...
 
 upwind (const fvMesh &mesh, Istream &is)
 Construct from Istream. More...
 
 upwind (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &)
 Construct from faceFlux and Istream. More...
 
virtual tmp< surfaceScalarFieldlimiter (const VolField< Type > &) const
 Return the interpolation limiter. More...
 
tmp< surfaceScalarFieldweights () const
 Return the interpolation weighting factors. More...
 
virtual tmp< surfaceScalarFieldweights (const VolField< Type > &) const
 Return the interpolation weighting factors. More...
 
void operator= (const upwind &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
 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...
 
tmp< surfaceScalarFieldweights (const VolField< Type > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
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 Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from limitedSurfaceInterpolationScheme< Type >
const surfaceScalarFieldfaceFlux_
 

Detailed Description

template<class Type>
class Foam::upwind< Type >

Upwind interpolation scheme class.

Source files

Definition at line 51 of file upwind.H.

Constructor & Destructor Documentation

◆ upwind() [1/3]

upwind ( const fvMesh mesh,
const surfaceScalarField faceFlux 
)
inline

Construct from faceFlux.

Definition at line 65 of file upwind.H.

◆ upwind() [2/3]

upwind ( const fvMesh mesh,
Istream is 
)
inline

Construct from Istream.

The name of the flux field is read from the Istream and looked-up from the mesh objectRegistry

Definition at line 77 of file upwind.H.

◆ upwind() [3/3]

upwind ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream  
)
inline

Construct from faceFlux and Istream.

Definition at line 87 of file upwind.H.

Member Function Documentation

◆ TypeName()

TypeName ( "upwind< Type >"  )

Runtime type information.

◆ limiter()

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

Return the interpolation limiter.

Implements limitedSurfaceInterpolationScheme< Type >.

Definition at line 101 of file upwind.H.

References Foam::dimless, surfaceInterpolationScheme< Type >::mesh(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ weights() [1/2]

tmp<surfaceScalarField> weights ( ) const
inline

Return the interpolation weighting factors.

Definition at line 115 of file upwind.H.

References limitedSurfaceInterpolationScheme< Type >::faceFlux_, and Foam::pos0().

Referenced by multivariateScheme< Type, Scheme >::multivariateScheme(), multivariateSelectionScheme< Type >::multivariateSelectionScheme(), upwind< Type >::weights(), and LUST< Type >::weights().

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

◆ weights() [2/2]

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

Return the interpolation weighting factors.

Reimplemented from limitedSurfaceInterpolationScheme< Type >.

Reimplemented in LUST< Type >.

Definition at line 121 of file upwind.H.

References upwind< Type >::weights().

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.


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