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")

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

	PhiScheme (const fvMesh &mesh, Istream &is)

	PhiScheme (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

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)

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 PhiLimiter>
class Foam::PhiScheme< Type, PhiLimiter >

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

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 with the central-differencing 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 60 of file PhiScheme.H.

Constructor & Destructor Documentation

◆ PhiScheme() [1/3]

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

inline

Definition at line 84 of file PhiScheme.H.

◆ PhiScheme() [2/3]

PhiScheme	(	const fvMesh &	mesh,
		Istream &	is
	)

inline

Definition at line 98 of file PhiScheme.H.

◆ PhiScheme() [3/3]

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

inline

Definition at line 109 of file PhiScheme.H.

Member Function Documentation

◆ TypeName()

TypeName ( "PhiScheme< Type, PhiLimiter >" )

◆ limiter()

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

virtual

Implements limitedSurfaceInterpolationScheme< Type >.

Definition at line 32 of file PhiScheme.C.

References GeometricField::boundaryField(), GeometricField::boundaryFieldRef(), coupled(), Foam::dimArea, Foam::dimDensity, Foam::dimless, Foam::dimVelocity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::fac::interpolate(), Foam::limiter(), mesh, phi, GeometricField::primitiveFieldRef(), tmp::ref(), and rho.

Here is the call graph for this function:

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/3]

◆ PhiScheme() [2/3]

◆ PhiScheme() [3/3]

Member Function Documentation

◆ TypeName()

◆ limiter()

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