localMin< Type > Class Template Reference

Local minimum interpolation scheme in which the face value is set to the minimum of the two neighbouring cell values. More...

Inheritance diagram for localMin< Type >:
Collaboration diagram for localMin< Type >:

Public Member Functions

 TypeName ("localMin")
 Runtime type information. More...
 
 localMin (const fvMesh &mesh)
 Construct from mesh. More...
 
 localMin (const fvMesh &mesh, Istream &is)
 Construct from Istream. More...
 
 localMin (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from faceFlux and Istream. More...
 
virtual tmp< surfaceScalarFieldweights (const VolField< Type > &) const
 Return the interpolation weighting factors. More...
 
virtual tmp< SurfaceField< Type > > interpolate (const VolField< Type > &vf) const
 Return the face-interpolate of the given cell field. More...
 
void operator= (const localMin &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from surfaceInterpolationScheme< Type >
 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))
 
 surfaceInterpolationScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
 surfaceInterpolationScheme (const surfaceInterpolationScheme &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~surfaceInterpolationScheme ()
 Destructor. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
virtual bool corrected () const
 Return true if this scheme uses an explicit correction. More...
 
virtual tmp< SurfaceField< Type > > correction (const VolField< Type > &) const
 Return the explicit correction to the face-interpolate. More...
 
virtual tmp< SurfaceField< typename innerProduct< vector, Type >::type > > dotInterpolate (const surfaceVectorField &Sf, const VolField< Type > &vf) const
 Return the face-interpolate of the given cell field. More...
 
tmp< SurfaceField< typename innerProduct< vector, Type >::type > > dotInterpolate (const surfaceVectorField &Sf, const tmp< VolField< Type >> &) const
 Return the face-interpolate of the given tmp cell field. More...
 
tmp< SurfaceField< Type > > interpolate (const tmp< VolField< Type >> &) const
 Return the face-interpolate of the given tmp cell field. More...
 
void operator= (const surfaceInterpolationScheme &)=delete
 Disallow default bitwise assignment. More...
 
tmp< SurfaceField< typename innerProduct< vector, scalar >::type > > dotInterpolate (const surfaceVectorField &Sf, const VolField< scalar > &) const
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

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. More...
 
static tmp< surfaceInterpolationScheme< Type > > New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme. More...
 
static tmp< SurfaceField< Type > > interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field. More...
 
template<class SFType >
static tmp< SurfaceField< typename innerProduct< typename SFType::value_type, Type >::type > > dotInterpolate (const SFType &Sf, const VolField< Type > &vf, const tmp< surfaceScalarField > &tlambdas)
 Return the face-interpolate of the given cell field. More...
 
static tmp< SurfaceField< Type > > interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 

Detailed Description

template<class Type>
class Foam::localMin< Type >

Local minimum interpolation scheme in which the face value is set to the minimum of the two neighbouring cell values.

Source files

Definition at line 52 of file localMin.H.

Constructor & Destructor Documentation

◆ localMin() [1/3]

localMin ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 66 of file localMin.H.

◆ localMin() [2/3]

localMin ( 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 74 of file localMin.H.

◆ localMin() [3/3]

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

Construct from faceFlux and Istream.

Definition at line 84 of file localMin.H.

Member Function Documentation

◆ TypeName()

TypeName ( "localMin< Type >"  )

Runtime type information.

◆ weights()

virtual tmp<surfaceScalarField> weights ( const VolField< Type > &  ) const
inlinevirtual

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 98 of file localMin.H.

References NotImplemented.

◆ interpolate()

◆ operator=()

void operator= ( const localMin< Type > &  )
delete

Disallow default bitwise assignment.


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