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

Inheritance diagram for limitWith< Type >:

Collaboration diagram for limitWith< Type >:

[legend]

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...

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...

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...

virtual	~surfaceInterpolationScheme ()
	Destructor. More...

const fvMesh &	mesh () const
	Return mesh reference. 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...

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...

Private Member Functions
	limitWith (const limitWith &)
	Disallow default bitwise copy construct. More...

void	operator= (const limitWith &)
	Disallow default bitwise assignment. More...

Private Attributes
tmp< surfaceInterpolationScheme< Type > >	tInterp_
	Interpolation scheme. More...

tmp< limitedSurfaceInterpolationScheme< Type > >	tLimiter_
	Limiter. 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...

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...

Detailed Description

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

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

Source files

Definition at line 51 of file limitWith.H.

Constructor & Destructor Documentation

◆ limitWith() [1/3]

limitWith ( const limitWith< Type > & )

private

Disallow default bitwise copy construct.

◆ limitWith() [2/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 83 of file limitWith.H.

◆ limitWith() [3/3]

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

inline

Construct from mesh, faceFlux and Istream.

Definition at line 101 of file limitWith.H.

Member Function Documentation

◆ operator=()

void operator= ( const limitWith< Type > & )

private

Disallow default bitwise assignment.

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

References Foam::MULES::limiter(), limitWith< Type >::tInterp_, and limitWith< Type >::tLimiter_.

Here is the call 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 136 of file limitWith.H.

References limitWith< Type >::tInterp_.

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

References limitWith< Type >::tInterp_, and limitWith< Type >::tLimiter_.

Field Documentation

◆ tInterp_

tmp<surfaceInterpolationScheme<Type> > tInterp_

private

Interpolation scheme.

Definition at line 58 of file limitWith.H.

Referenced by limitWith< Type >::corrected(), limitWith< Type >::correction(), and limitWith< Type >::weights().

◆ tLimiter_

tmp<limitedSurfaceInterpolationScheme<Type> > tLimiter_

private

Limiter.

Definition at line 61 of file limitWith.H.

Referenced by limitWith< Type >::correction(), and limitWith< Type >::weights().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ limitWith() [1/3]

◆ limitWith() [2/3]

◆ limitWith() [3/3]

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ weights()

◆ corrected()

◆ correction()

Field Documentation

◆ tInterp_

◆ tLimiter_

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