limitWith< Type > Class Template Reference

limitWith interpolation scheme limits the specified scheme with the specified limiter. More...

Inheritance diagram for limitWith< Type >:

Collaboration diagram for limitWith< Type >:

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

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< 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. More...
template<class SFType >
static tmp< GeometricField< typename innerProduct< typename SFType::value_type, Type >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const SFType &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf, const tmp< surfaceScalarField > &tlambdas)
	Return the face-interpolate of the given cell field. More...
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, 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...

Detailed Description

template<class Type>
class Foam::limitWith< Type >

limitWith interpolation scheme limits the specified scheme with the specified limiter.

Source files

• limitWith.H
• limitWith.C

Definition at line 51 of file limitWith.H.

Constructor & Destructor Documentation

limitWith() [1/3]

limitWith ( const fvMesh &  mesh, Istream &  is  )

inline

Construct from mesh and Istream.

The name of the flux field is read from the Istream and looked-up from the mesh objectRegistry

Definition at line 76 of file limitWith.H.

Referenced by limitWith< Type >::limitWith().

Here is the caller graph for this function:

limitWith() [2/3]

limitWith ( const fvMesh &  mesh, const surfaceScalarField &  faceFlux, Istream &  is  )

inline

Construct from mesh, faceFlux and Istream.

Definition at line 94 of file limitWith.H.

References limitWith< Type >::limitWith(), and limitWith< Type >::weights().

Here is the call graph for this function:

limitWith() [3/3]

limitWith ( const limitWith< Type > &  )

delete

Disallow default bitwise copy construction.

Member Function Documentation

TypeName()

TypeName

(

"limitWith< Type >"

)

Runtime type information.

weights()

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

inlinevirtual

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 119 of file limitWith.H.

References Foam::MULES::limiter().

Referenced by limitWith< Type >::limitWith().

Here is the call graph for this function:

Here is the caller graph for this function:

corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 132 of file limitWith.H.

correction()

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction ( const GeometricField< Type, fvPatchField, volMesh > &  vf ) const

inlinevirtual

Return the explicit correction to the face-interpolate.

for the given field

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 140 of file limitWith.H.

References limitWith< Type >::operator=().

Here is the call graph for this function:

operator=()

void operator= ( const limitWith< Type > &  )

delete

Disallow default bitwise assignment.

Referenced by limitWith< Type >::correction().

Here is the caller graph for this function:

---

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

• src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitWith/limitWith.H