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

Interpolation scheme class using weights looked-up from the objectRegistry. More...

#include <finiteVolume/weighted.H>


Detailed Description

template<class Type>
class Foam::weighted< Type >

Interpolation scheme class using weights looked-up from the objectRegistry.

Source files

Definition at line 51 of file weighted.H.

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

List of all members.

Public Member Functions

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

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.
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

weighted ( const surfaceScalarField weights)
inline

Construct from weights.

Definition at line 75 of file weighted.H.

weighted ( const fvMesh mesh,
Istream is 
)
inline

Construct from Istream.

Definition at line 82 of file weighted.H.

weighted ( const fvMesh mesh,
const surfaceScalarField ,
Istream is 
)
inline

Construct from faceFlux and Istream.

Definition at line 94 of file weighted.H.


Member Function Documentation

TypeName ( "weighted< Type >"  )

Runtime type information.

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

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 116 of file weighted.H.


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