Class to create the weighting-factors based on the face-flux. More...

Inheritance diagram for PhiScheme< Type, PhiLimiter >:

Collaboration diagram for PhiScheme< Type, PhiLimiter >:

Public Member Functions
	TypeName ("PhiScheme")
	Runtime type information. More...

	PhiScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, const PhiLimiter &weight)
	Construct from mesh, faceFlux and blendingFactor. More...

	PhiScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream. More...

	PhiScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
	Construct from mesh, faceFlux and Istream. More...

	PhiScheme (const PhiScheme &)=delete
	Disallow default bitwise copy construction. More...

virtual tmp< surfaceScalarField >	limiter (const VolField< Type > &) const
	Return the interpolation weighting factors. More...

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

Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
	TypeName ("limitedSurfaceInterpolationScheme")
	Runtime type information. More...

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

	limitedSurfaceInterpolationScheme (const fvMesh &mesh, Istream &is)
	Construct from mesh and Istream. More...

	limitedSurfaceInterpolationScheme (const limitedSurfaceInterpolationScheme &)=delete
	Disallow default bitwise copy construction. More...

virtual	~limitedSurfaceInterpolationScheme ()
	Destructor. More...

tmp< surfaceScalarField >	weights (const VolField< Type > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) const
	Return the interpolation weighting factors for the given field,. More...

virtual tmp< surfaceScalarField >	weights (const VolField< Type > &) const
	Return the interpolation weighting factors for the given field. More...

virtual tmp< SurfaceField< Type > >	flux (const VolField< Type > &) const
	Return the interpolation weighting factors. More...

void	operator= (const limitedSurfaceInterpolationScheme &)=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 &)=delete
	Disallow default bitwise copy construction. More...

virtual	~surfaceInterpolationScheme ()
	Destructor. More...

const fvMesh &	mesh () const
	Return mesh reference. More...

virtual bool	corrected () const
	Return true if this scheme uses an explicit correction. More...

virtual tmp< SurfaceField< Type > >	correction (const VolField< Type > &) const
	Return the explicit correction to the face-interpolate. More...

virtual tmp< SurfaceField< typename innerProduct< vector, Type >::type > >	dotInterpolate (const surfaceVectorField &Sf, const VolField< Type > &vf) const
	Return the face-interpolate of the given cell field. More...

tmp< SurfaceField< typename innerProduct< vector, Type >::type > >	dotInterpolate (const surfaceVectorField &Sf, const tmp< VolField< Type >> &) const
	Return the face-interpolate of the given tmp cell field. More...

virtual tmp< SurfaceField< Type > >	interpolate (const VolField< Type > &) const
	Return the face-interpolate of the given cell field. More...

tmp< SurfaceField< Type > >	interpolate (const tmp< VolField< Type >> &) const
	Return the face-interpolate of the given tmp cell field. More...

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

tmp< SurfaceField< typename innerProduct< vector, scalar >::type > >	dotInterpolate (const surfaceVectorField &Sf, const VolField< scalar > &) const

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

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Public Member Functions inherited from PhiLimiter
	PhiLimiter (Istream &is)

scalar	limiter (const scalar cdWeight, const scalar faceFlux, const vector &PhiP, const vector &PhiN, const vector &Sf, const scalar &) const

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

static tmp< limitedSurfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme. More...

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< SurfaceField< Type > >	interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...

template<class SFType >
static tmp< SurfaceField< typename innerProduct< typename SFType::value_type, Type >::type > >	dotInterpolate (const SFType &Sf, const VolField< Type > &vf, const tmp< surfaceScalarField > &tlambdas)
	Return the face-interpolate of the given cell field. More...

static tmp< SurfaceField< Type > >	interpolate (const VolField< Type > &, 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...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Attributes inherited from limitedSurfaceInterpolationScheme< Type >
const surfaceScalarField &	faceFlux_

Detailed Description

template<class Type, class PhiLimiter>
class Foam::PhiScheme< Type, PhiLimiter >

Class to create the weighting-factors based on the face-flux.

The particular interpolation 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 with the centred interpolation weighting factor, the face-flux, the face neighbour cell values and the face area.

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 59 of file PhiScheme.H.

Constructor & Destructor Documentation

◆ PhiScheme() [1/4]

PhiScheme	(	const fvMesh &	mesh,
		const surfaceScalarField &	faceFlux,
		const PhiLimiter &	weight
	)

inline

Construct from mesh, faceFlux and blendingFactor.

Definition at line 74 of file PhiScheme.H.

◆ PhiScheme() [2/4]

PhiScheme	(	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 88 of file PhiScheme.H.

◆ PhiScheme() [3/4]

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

inline

Construct from mesh, faceFlux and Istream.

Definition at line 99 of file PhiScheme.H.

◆ PhiScheme() [4/4]

PhiScheme ( const PhiScheme< Type, PhiLimiter > & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "PhiScheme< Type, PhiLimiter >" )

Runtime type information.

◆ limiter()

Foam::tmp< Foam::surfaceScalarField > limiter ( const VolField< Type > & phi ) const

virtual

Return the interpolation weighting factors.

Implements limitedSurfaceInterpolationScheme< Type >.

Definition at line 36 of file PhiScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), IOobject::db(), Foam::dimFlux, Foam::dimless, Foam::dimMassFlux, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::fvc::interpolate(), Foam::MULES::limiter(), fvMesh::magSf(), fvMesh::neighbour(), Foam::compressible::New(), fvMesh::owner(), patchi, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), tmp< T >::ref(), rho, and fvMesh::Sf().

Here is the call graph for this function:

◆ operator=()

void operator= ( const PhiScheme< Type, PhiLimiter > & )

delete

Disallow default bitwise assignment.

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

src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/PhiScheme/PhiScheme.H
src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/PhiScheme/PhiScheme.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type, class PhiLimiter> class Foam::PhiScheme< Type, PhiLimiter >

Constructor & Destructor Documentation

◆ PhiScheme() [1/4]

◆ PhiScheme() [2/4]

◆ PhiScheme() [3/4]

◆ PhiScheme() [4/4]

Member Function Documentation

◆ TypeName()

◆ limiter()

◆ operator=()

template<class Type, class PhiLimiter>
class Foam::PhiScheme< Type, PhiLimiter >