FreeFOAM The Cross-Platform CFD Toolkit
limitedSurfaceInterpolationScheme< Type > Class Template Reference

Abstract base class for limited surface interpolation schemes. More...

#include <finiteVolume/limitedSurfaceInterpolationScheme.H>


Detailed Description

+ Inheritance diagram for limitedSurfaceInterpolationScheme< Type >:
+ Collaboration diagram for limitedSurfaceInterpolationScheme< Type >:

List of all members.

Public Member Functions

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

Static Public Member Functions

static tmp
< limitedSurfaceInterpolationScheme
< Type > > 
New (const fvMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme.
static tmp
< limitedSurfaceInterpolationScheme
< Type > > 
New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme.
- Static Public Member Functions inherited from surfaceInterpolationScheme< Type >
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.
static tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field.

Protected Attributes

const surfaceScalarFieldfaceFlux_

Constructor & Destructor Documentation

limitedSurfaceInterpolationScheme ( const fvMesh mesh,
const surfaceScalarField faceFlux 
)
inline

Construct from mesh and faceFlux.

Definition at line 111 of file limitedSurfaceInterpolationScheme.H.

limitedSurfaceInterpolationScheme ( 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 125 of file limitedSurfaceInterpolationScheme.H.


Member Function Documentation

TypeName ( "limitedSurfaceInterpolationScheme< Type >"  )

Runtime type information.

declareRunTimeSelectionTable ( tmp  ,
limitedSurfaceInterpolationScheme< Type >  ,
Mesh  ,
(const fvMesh &mesh, Istream &schemeData)  ,
(mesh, schemeData)   
)
declareRunTimeSelectionTable ( tmp  ,
limitedSurfaceInterpolationScheme< Type >  ,
MeshFlux  ,
(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)  ,
(mesh, faceFlux, schemeData)   
)
tmp< limitedSurfaceInterpolationScheme< Type > > New ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream schemeData 
)
static

Return new tmp interpolation scheme.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 95 of file limitedSurfaceInterpolationScheme.C.

References fvSchemes::debug, Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and mesh.

virtual tmp<surfaceScalarField> limiter ( const GeometricField< Type, fvPatchField, volMesh > &  ) const
pure virtual
tmp< surfaceScalarField > weights ( const GeometricField< Type, fvPatchField, volMesh > &  phi,
const surfaceScalarField CDweights,
tmp< surfaceScalarField tLimiter 
) const

Return the interpolation weighting factors for the given field,.

by limiting the given weights with the given limiter

Definition at line 157 of file limitedSurfaceInterpolationScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, GeometricField< Type, PatchField, GeoMesh >::internalField(), and Foam::pos().

tmp< surfaceScalarField > weights ( const GeometricField< Type, fvPatchField, volMesh > &  phi) const
virtual

Return the interpolation weighting factors for the given field.

Implements surfaceInterpolationScheme< Type >.

Reimplemented in blended< Type >, and upwind< Type >.

Definition at line 199 of file limitedSurfaceInterpolationScheme.C.

References Foam::MULES::limiter(), mesh, and surfaceInterpolation::weights().

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > flux ( const GeometricField< Type, fvPatchField, volMesh > &  phi) const
virtual

Return the interpolation weighting factors.

Definition at line 214 of file limitedSurfaceInterpolationScheme.C.

References Foam::interpolate().


Member Data Documentation


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