Public Member Functions | List of all members
harmonic Class Reference

Harmonic-mean differencing scheme class. More...

Inheritance diagram for harmonic:
Inheritance graph
[legend]
Collaboration diagram for harmonic:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("harmonic")
 Runtime type information. More...
 
 harmonic (const fvMesh &mesh)
 Construct from mesh. More...
 
 harmonic (const fvMesh &mesh, Istream &is)
 Construct from Istream. More...
 
 harmonic (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from faceFlux and Istream. More...
 
virtual tmp< surfaceScalarFieldweights (const GeometricField< scalar, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors. More...
 
virtual tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > interpolate (const GeometricField< scalar, fvPatchField, volMesh > &vf) const
 Return the face-interpolate of the given cell field. More...
 
- Public Member Functions inherited from surfaceInterpolationScheme< scalar >
 surfaceInterpolationScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
 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))
 
virtual ~surfaceInterpolationScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > interpolate (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &) const
 Return the face-interpolate of the given tmp cell field. More...
 
virtual bool corrected () const
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > correction (const GeometricField< scalar, fvPatchField, volMesh > &) const
 Return the explicit correction to the face-interpolate. More...
 
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to 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...
 

Additional Inherited Members

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

Detailed Description

Harmonic-mean differencing scheme class.

This scheme interpolates 1/field using a scheme specified at run-time and return the reciprocal of the interpolate.

Source files

Definition at line 54 of file harmonic.H.

Constructor & Destructor Documentation

harmonic ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 73 of file harmonic.H.

Referenced by harmonic::harmonic().

Here is the caller graph for this function:

harmonic ( 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 82 of file harmonic.H.

References harmonic::harmonic().

Here is the call graph for this function:

harmonic ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream is 
)
inline

Construct from faceFlux and Istream.

Definition at line 92 of file harmonic.H.

References harmonic::weights().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "harmonic"  )

Runtime type information.

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

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< scalar >.

Definition at line 106 of file harmonic.H.

References harmonic::interpolate(), and notImplemented.

Referenced by harmonic::harmonic().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return the face-interpolate of the given cell field.

Reimplemented from surfaceInterpolationScheme< scalar >.

Definition at line 122 of file harmonic.H.

References DimensionedField< Type, GeoMesh >::mesh().

Referenced by harmonic::weights().

Here is the call graph for this function:

Here is the caller graph for this function:


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