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

LocalMax-mean differencing scheme class. More...

#include <finiteVolume/localMax.H>


Detailed Description

template<class Type>
class Foam::localMax< Type >

LocalMax-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 55 of file localMax.H.

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

List of all members.

Public Member Functions

 TypeName ("localMax")
 Runtime type information.
 localMax (const fvMesh &mesh)
 Construct from mesh.
 localMax (const fvMesh &mesh, Istream &is)
 Construct from Istream.
 localMax (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from faceFlux and Istream.
virtual tmp< surfaceScalarFieldweights (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors.
virtual tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 Return the face-interpolate of the given cell field.
- 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.
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

localMax ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 74 of file localMax.H.

localMax ( 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 83 of file localMax.H.

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

Construct from faceFlux and Istream.

Definition at line 93 of file localMax.H.


Member Function Documentation

TypeName ( "localMax< Type >"  )

Runtime type information.

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

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 107 of file localMax.H.

References notImplemented.


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