limitWith< Type > Class Template Reference

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

#include <finiteVolume/limitWith.H>

---

Detailed Description

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

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

Source files

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

Definition at line 52 of file limitWith.H.

Inheritance diagram for limitWith< Type >:

Collaboration diagram for limitWith< Type >:

List of all members.

Public Member Functions
	TypeName ("limitWith")
	Runtime type information.
	limitWith (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream.
	limitWith (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
	Construct from mesh, faceFlux and Istream.
virtual tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &vf) const
	Return the interpolation weighting factors.
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 > &vf) const
	Return the explicit correction to the face-interpolate.

---

Constructor & Destructor Documentation

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 84 of file limitWith.H.

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

Construct from mesh, faceFlux and Istream.

Definition at line 102 of file limitWith.H.

---

Member Function Documentation

TypeName

(

"limitWith< Type >"

)

Runtime type information.

virtual tmp<surfaceScalarField> weights

(

const GeometricField< Type, fvPatchField, volMesh > &

vf  )

const [inline, virtual]

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 124 of file limitWith.H.

References Foam::MULES::limiter().

virtual bool corrected

(

)

const [inline, virtual]

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 137 of file limitWith.H.

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction

(

const GeometricField< Type, fvPatchField, volMesh > &

vf  )

const [inline, virtual]

Return the explicit correction to the face-interpolate.

for the given field

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 145 of file limitWith.H.

---

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

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