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

#include <LimitedScheme.H>

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

[legend]

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

[legend]

Public Types
typedef Limiter	LimiterType

Public Member Functions
	TypeName ("LimitedScheme")
	Runtime type information.
	LimitedScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, const Limiter &weight)
	Construct from mesh and faceFlux and limiter scheme.
	LimitedScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream.
	LimitedScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
	Construct from mesh, faceFlux and Istream.
virtual tmp< surfaceScalarField >	limiter (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the interpolation weighting factors.
Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
	TypeName ("limitedSurfaceInterpolationScheme")
	Runtime type information.
	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)
	Construct from mesh and faceFlux.
	limitedSurfaceInterpolationScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream.
virtual	~limitedSurfaceInterpolationScheme ()
	Destructor.
tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) const
	Return the interpolation weighting factors for the given field,.
virtual tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the interpolation weighting factors for the given field.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	flux (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the interpolation weighting factors.
Public Member Functions inherited from surfaceInterpolationScheme< Type >
	TypeName ("surfaceInterpolationScheme")
	Runtime type information.
	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.
virtual	~surfaceInterpolationScheme ()=default
	Destructor.
const fvMesh &	mesh () const
	Return mesh reference.
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 > &) const
	Return the explicit correction to the face-interpolate.
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.
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.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the face-interpolate of the given cell field.
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Return the face-interpolate of the given tmp cell field.
template<class SFType>
Foam::tmp< Foam::GeometricField< typename Foam::innerProduct< typename SFType::value_type, Type >::type, Foam::fvsPatchField, Foam::surfaceMesh > >	dotInterpolate (const SFType &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf, const tmp< surfaceScalarField > &tlambdas)
tmp< GeometricField< typename innerProduct< vector, scalar >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const GeometricField< scalar, fvPatchField, volMesh > &) const
Foam::tmp< Foam::GeometricField< typename Foam::innerProduct< Foam::vector, Foam::scalar >::type, Foam::fvsPatchField, Foam::surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const GeometricField< scalar, fvPatchField, volMesh > &) const
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Static Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
static tmp< limitedSurfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme.
static tmp< limitedSurfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme.
Static Public Member Functions inherited from surfaceInterpolationScheme< Type >
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme.
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme.
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.
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.
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field.
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

Definition at line 64 of file LimitedScheme.H.

Member Typedef Documentation

◆ LimiterType

template<class Type, class Limiter, template< class > class LimitFunc>

typedef Limiter LimiterType

Definition at line 98 of file LimitedScheme.H.

Constructor & Destructor Documentation

◆ LimitedScheme() [1/3]

template<class Type, class Limiter, template< class > class LimitFunc>

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

inline

Construct from mesh and faceFlux and limiter scheme.

Definition at line 105 of file LimitedScheme.H.

◆ LimitedScheme() [2/3]

template<class Type, class Limiter, template< class > class LimitFunc>

LimitedScheme	(	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 122 of file LimitedScheme.H.

◆ LimitedScheme() [3/3]

template<class Type, class Limiter, template< class > class LimitFunc>

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

inline

Construct from mesh, faceFlux and Istream.

Definition at line 135 of file LimitedScheme.H.

Member Function Documentation

◆ TypeName()

template<class Type, class Limiter, template< class > class LimitFunc>

TypeName ( "LimitedScheme< Type, Limiter, LimitFunc >" )

Runtime type information.

◆ limiter()

template<class Type, class Limiter, template< class > class LimitFunc>

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

virtual

Return the interpolation weighting factors.

Implements limitedSurfaceInterpolationScheme< Type >.

Definition at line 136 of file LimitedScheme.C.

References Foam::dimless, surfaceInterpolationScheme< Type >::mesh(), mesh, GeometricField< scalar, fvsPatchField, surfaceMesh >::New(), tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, phi, IOobjectOption::REGISTER, and regIOobject::store().

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LimiterType

Constructor & Destructor Documentation

◆ LimitedScheme() [1/3]

◆ LimitedScheme() [2/3]

◆ LimitedScheme() [3/3]

Member Function Documentation

◆ TypeName()

◆ limiter()