Abstract base class for snGrad schemes. More...

Inheritance diagram for snGradScheme< Type >:

[legend]

Collaboration diagram for snGradScheme< Type >:

Public Member Functions
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, snGradScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))

	snGradScheme (const fvMesh &mesh)
	Construct from mesh. More...

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

virtual	~snGradScheme ()
	Destructor. More...

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

virtual tmp< surfaceScalarField >	deltaCoeffs (const VolField< Type > &) const =0
	Return the interpolation weighting factors for the given field. 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 snGrad. More...

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

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

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

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

Static Public Member Functions
static tmp< snGradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme. More...

static tmp< SurfaceField< Type > >	snGrad (const VolField< Type > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")
	Return the snGrad of the given cell field with the given deltaCoeffs. More...

static tmp< SurfaceField< Type > >	sndGrad (const VolField< Type > &, const word &snGradName="sndGrad")
	Return the sndGrad of the given cell field. More...

Additional Inherited Members
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

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

Detailed Description

template<class Type>
class Foam::fv::snGradScheme< Type >

Abstract base class for snGrad schemes.

Source files

Definition at line 60 of file snGradScheme.H.

Constructor & Destructor Documentation

◆ snGradScheme() [1/2]

snGradScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 91 of file snGradScheme.H.

◆ snGradScheme() [2/2]

snGradScheme ( const snGradScheme< Type > & )

delete

Disallow default bitwise copy construction.

◆ ~snGradScheme()

~snGradScheme

virtual

Destructor.

Definition at line 92 of file snGradScheme.C.

Member Function Documentation

◆ type()

virtual const word& type ( ) const

pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	tmp	,
		snGradScheme< Type >	,
		Mesh	,
		(const fvMesh &mesh, Istream &schemeData)	,
		(mesh, schemeData)
	)

◆ New()

tmp< snGradScheme< Type > > New	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

static

Return new tmp interpolation scheme.

Definition at line 45 of file snGradScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, and Foam::nl.

Referenced by laplacianScheme< Type, GType >::laplacianScheme(), and Foam::fvc::snGrad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 117 of file snGradScheme.H.

Referenced by CentredFitSnGradScheme< Type, Polynomial, Stencil >::correction(), CentredFitSnGradScheme< Type, Polynomial, Stencil >::deltaCoeffs(), correctedSnGrad< Type >::deltaCoeffs(), faceCorrectedSnGrad< Type >::deltaCoeffs(), orthogonalSnGrad< Type >::deltaCoeffs(), and uncorrectedSnGrad< Type >::deltaCoeffs().

Here is the caller graph for this function:

◆ snGrad() [1/3]

tmp< SurfaceField< Type > > snGrad	(	const VolField< Type > &	vf,
		const tmp< surfaceScalarField > &	tdeltaCoeffs,
		const word &	snGradName = `"snGrad"`
	)

static

Return the snGrad of the given cell field with the given deltaCoeffs.

Definition at line 100 of file snGradScheme.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvPatchField< Type >::coupled(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), fvMesh::neighbour(), fvMesh::owner(), patchi, tmp< T >::ref(), and fvPatchField< Type >::snGrad().

Here is the call graph for this function:

◆ sndGrad()

tmp< SurfaceField< Type > > sndGrad	(	const VolField< Type > &	vf,
		const word &	snGradName = `"sndGrad"`
	)

static

Return the sndGrad of the given cell field.

Definition at line 157 of file snGradScheme.C.

References DimensionedField< Type, GeoMesh >::mesh(), and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ deltaCoeffs()

virtual tmp<surfaceScalarField> deltaCoeffs ( const VolField< Type > & ) const

pure virtual

Return the interpolation weighting factors for the given field.

Implemented in phaseStabilisedSnGrad< Type >, uncorrectedSnGrad< Type >, orthogonalSnGrad< Type >, limitedSnGrad< Type >, faceCorrectedSnGrad< Type >, correctedSnGrad< Type >, and CentredFitSnGradScheme< Type, Polynomial, Stencil >.

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented in uncorrectedSnGrad< Type >, phaseStabilisedSnGrad< Type >, orthogonalSnGrad< Type >, limitedSnGrad< Type >, faceCorrectedSnGrad< Type >, correctedSnGrad< Type >, and CentredFitSnGradScheme< Type, Polynomial, Stencil >.

Definition at line 147 of file snGradScheme.H.

◆ correction()

virtual tmp<SurfaceField<Type> > correction ( const VolField< Type > & ) const

inlinevirtual

Return the explicit correction to the snGrad.

for the given field

Reimplemented in CentredFitSnGradScheme< Type, Polynomial, Stencil >, uncorrectedSnGrad< Type >, phaseStabilisedSnGrad< Type >, orthogonalSnGrad< Type >, limitedSnGrad< Type >, faceCorrectedSnGrad< Type >, and correctedSnGrad< Type >.

Definition at line 155 of file snGradScheme.H.

◆ snGrad() [2/3]

tmp< SurfaceField< Type > > snGrad ( const VolField< Type > & vf ) const

virtual

Return the snGrad of the given cell field.

with explicit correction

Definition at line 169 of file snGradScheme.C.

References Foam::correction(), tmp< T >::ref(), and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ snGrad() [3/3]

tmp< SurfaceField< Type > > snGrad ( const tmp< VolField< Type >> & tvf ) const

Return the snGrad of the given tmp cell field.

with explicit correction

Definition at line 190 of file snGradScheme.C.

References tmp< T >::clear(), and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ operator=()

void operator= ( const snGradScheme< Type > & )

delete

Disallow default bitwise assignment.

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

src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H
src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fv::snGradScheme< Type >

Constructor & Destructor Documentation

◆ snGradScheme() [1/2]

◆ snGradScheme() [2/2]

◆ ~snGradScheme()

Member Function Documentation

◆ type()

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ snGrad() [1/3]

◆ sndGrad()

◆ deltaCoeffs()

◆ corrected()

◆ correction()

◆ snGrad() [2/3]

◆ snGrad() [3/3]

◆ operator=()

template<class Type>
class Foam::fv::snGradScheme< Type >