LimitedScheme< Type, Limiter, LimitFunc > Class Template Reference

Class to create NVD/TVD limited weighting-factors. More...

Inheritance diagram for LimitedScheme< Type, Limiter, LimitFunc >:

Collaboration diagram for LimitedScheme< Type, Limiter, LimitFunc >:

Public Types
typedef Limiter	LimiterType

Public Member Functions
	TypeName ("LimitedScheme")
	LimitedScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, const Limiter &weight)
	LimitedScheme (const fvMesh &mesh, Istream &is)
	LimitedScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
virtual tmp< surfaceScalarField >	limiter (const GeometricField< Type, fvPatchField, volMesh > &) const
Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
	TypeName ("limitedSurfaceInterpolationScheme")
	declareRunTimeSelectionTable (tmp, limitedSurfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	declareRunTimeSelectionTable (tmp, limitedSurfaceInterpolationScheme, MeshFlux,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
	limitedSurfaceInterpolationScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux)
	limitedSurfaceInterpolationScheme (const fvMesh &mesh, Istream &is)
virtual	~limitedSurfaceInterpolationScheme ()
tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) const
virtual tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &) const
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	flux (const GeometricField< Type, fvPatchField, volMesh > &) const
Public Member Functions inherited from surfaceInterpolationScheme< Type >
	TypeName ("surfaceInterpolationScheme")
	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)
virtual	~surfaceInterpolationScheme ()=default
const fvMesh &	mesh () const
virtual bool	corrected () const
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &) const
virtual tmp< GeometricField< typename innerProduct< vector, Type >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf) const
tmp< GeometricField< typename innerProduct< vector, Type >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const tmp< GeometricField< Type, fvPatchField, volMesh >> &) const
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &) const
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh >> &) const
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
int	count () const noexcept
bool	unique () const noexcept
void	operator++ () noexcept
void	operator++ (int) noexcept
void	operator-- () noexcept
void	operator-- (int) noexcept

Additional Inherited Members
Static Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
static tmp< limitedSurfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
static tmp< limitedSurfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
Static Public Member Functions inherited from surfaceInterpolationScheme< Type >
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
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)
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
Protected Attributes inherited from limitedSurfaceInterpolationScheme< Type >
const surfaceScalarField &	faceFlux_

Detailed Description

template<class Type, class Limiter, template< class > class LimitFunc>
class Foam::LimitedScheme< Type, Limiter, LimitFunc >

Class to create NVD/TVD limited weighting-factors.

The particular differencing scheme class is supplied as a template argument, the weight function of which is called by the weight function of this class for the internal faces as well as faces of coupled patches (e.g. processor-processor patches). The weight function is supplied the central-differencing weighting factor, the face-flux, the cell and face gradients (from which the normalised variable distribution may be created) and the cell centre distance.

This code organisation is both neat and efficient, allowing for convenient implementation of new schemes to run on parallelised cases.

Source files

• LimitedScheme.H
• LimitedScheme.C

Definition at line 64 of file LimitedScheme.H.

Member Typedef Documentation

LimiterType

typedef Limiter LimiterType

Definition at line 90 of file LimitedScheme.H.

Constructor & Destructor Documentation

LimitedScheme() [1/3]

LimitedScheme ( const fvMesh &  mesh, const surfaceScalarField &  faceFlux, const Limiter &  weight  )

inline

Definition at line 96 of file LimitedScheme.H.

LimitedScheme() [2/3]

LimitedScheme ( const fvMesh &  mesh, Istream &  is  )

inline

Definition at line 110 of file LimitedScheme.H.

LimitedScheme() [3/3]

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

inline

Definition at line 121 of file LimitedScheme.H.

Member Function Documentation

TypeName()

TypeName

(

"LimitedScheme< Type, Limiter, LimitFunc >"

)

limiter()

Foam::tmp< Foam::surfaceScalarField > limiter ( const GeometricField< Type, fvPatchField, volMesh > &  phi ) const

virtual

Implements limitedSurfaceInterpolationScheme< Type >.

Definition at line 137 of file LimitedScheme.C.

References Foam::dimless, mesh, Foam::New(), phi, and tmp::ref().

Referenced by LimitedLimiter< LimitedScheme >::limiter().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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