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

Cubic interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction. More...

#include <finiteVolume/cubic.H>


Detailed Description

template<class Type>
class Foam::cubic< Type >

Cubic interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction.

Source files

Definition at line 52 of file cubic.H.

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

List of all members.

Public Member Functions

 TypeName ("cubic")
 Runtime type information.
 cubic (const fvMesh &mesh)
 Construct from mesh.
 cubic (const fvMesh &mesh, Istream &)
 Construct from mesh and Istream.
 cubic (const fvMesh &mesh, const surfaceScalarField &, Istream &)
 Construct from mesh, faceFlux and Istream.
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 > &vf) const
 Return the explicit correction to the face-interpolate.
- Public Member Functions inherited from linear< Type >
 TypeName ("linear")
 Runtime type information.
 linear (const fvMesh &mesh)
 Construct from mesh.
 linear (const fvMesh &mesh, Istream &)
 Construct from Istream.
 linear (const fvMesh &mesh, const surfaceScalarField &, Istream &)
 Construct from faceFlux and Istream.
tmp< surfaceScalarFieldweights (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 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.

Constructor & Destructor Documentation

cubic ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 74 of file cubic.H.

cubic ( const fvMesh mesh,
Istream  
)
inline

Construct from mesh and Istream.

Definition at line 81 of file cubic.H.

cubic ( const fvMesh mesh,
const surfaceScalarField ,
Istream  
)
inline

Construct from mesh, faceFlux and Istream.

Definition at line 91 of file cubic.H.


Member Function Documentation

TypeName ( "cubic< Type >"  )

Runtime type information.

virtual bool corrected ( ) const
inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 104 of file cubic.H.


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