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

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

#include <finiteVolume/surfaceInterpolationScheme.H>


Detailed Description

template<class Type>
class Foam::surfaceInterpolationScheme< Type >

Abstract base class for surface interpolation schemes.

Source files

Definition at line 56 of file surfaceInterpolationScheme.H.

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

List of all members.

Public Member Functions

 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 tmp< surfaceScalarFieldweights (const GeometricField< Type, fvPatchField, volMesh > &) const =0
 Return the interpolation weighting factors for the given field.
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
< surfaceInterpolationScheme
< Type > > 
New (const fvMesh &mesh, Istream &schemeData)
 Return new tmp interpolation scheme.
static tmp
< surfaceInterpolationScheme
< Type > > 
New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme.
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.

Constructor & Destructor Documentation

surfaceInterpolationScheme ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 112 of file surfaceInterpolationScheme.H.

Definition at line 151 of file surfaceInterpolationScheme.C.


Member Function Documentation

TypeName ( "surfaceInterpolationScheme< Type >"  )

Runtime type information.

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

Return new tmp interpolation scheme.

Reimplemented in limitedSurfaceInterpolationScheme< Type >.

Definition at line 96 of file surfaceInterpolationScheme.C.

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

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate ( const GeometricField< Type, fvPatchField, volMesh > &  vf) const
virtual

Return the face-interpolate of the given cell field.

with explicit correction

Reimplemented in fixedBlended< Type >, localBlended< Type >, harmonic, localMax< Type >, and localMin< Type >.

Definition at line 321 of file surfaceInterpolationScheme.C.

References Foam::correction(), fvSchemes::debug, Foam::endl(), Foam::Info, and Foam::interpolate().

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate ( const tmp< GeometricField< Type, fvPatchField, volMesh > > &  tvf) const

Return the face-interpolate of the given tmp cell field.

Return the face-interpolate of the given cell field.

with explicit correction

Definition at line 350 of file surfaceInterpolationScheme.C.

References Foam::interpolate().


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