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

virtual	~snGradScheme ()
	Destructor. More...

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

virtual tmp< surfaceScalarField >	deltaCoeffs (const GeometricField< Type, fvPatchField, volMesh > &) 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< GeometricField< Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the explicit correction to the snGrad. More...

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	snGrad (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the snGrad of the given cell field. More...

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	snGrad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Return the snGrad of the given tmp cell field. More...

Public Member Functions inherited from refCount
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

bool	okToDelete () const
	Return true if the reference count is zero. More...

void	resetRefCount ()
	Reset the reference count to 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...

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

static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	snGrad (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")
	Return the snGrad of the given cell field with the given deltaCoeffs. More...

static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	sndGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &snGradName="sndGrad")
	Return the sndGrad of the given cell field. More...

Private Member Functions
void	operator= (const snGradScheme &)
	Disallow default bitwise assignment. More...

Private Attributes
const fvMesh &	mesh_
	Hold reference to mesh. 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()

snGradScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 97 of file snGradScheme.H.

◆ ~snGradScheme()

~snGradScheme

virtual

Destructor.

Definition at line 94 of file snGradScheme.C.

Member Function Documentation

◆ operator=()

void operator= ( const snGradScheme< Type > & )

private

Disallow default bitwise assignment.

◆ 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 46 of file snGradScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, mesh, 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 120 of file snGradScheme.H.

References snGradScheme< Type >::mesh_.

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

Here is the caller graph for this function:

◆ snGrad() [1/3]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad	(	const GeometricField< Type, fvPatchField, volMesh > &	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 103 of file snGradScheme.C.

References boundaryField(), GeometricField::boundaryField(), fvPatchField::coupled(), forAll, mesh, IOobject::NO_READ, IOobject::NO_WRITE, patchi, and fvPatchField::snGrad().

Here is the call graph for this function:

◆ sndGrad()

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > sndGrad	(	const GeometricField< Type, fvPatchField, volMesh > &	vf,
		const word &	snGradName = `"sndGrad"`
	)

static

Return the sndGrad of the given cell field.

Definition at line 165 of file snGradScheme.C.

References Foam::fvc::snGrad().

Here is the call graph for this function:

◆ deltaCoeffs()

virtual tmp<surfaceScalarField> deltaCoeffs ( const GeometricField< Type, fvPatchField, volMesh > & ) const

pure virtual

Return the interpolation weighting factors for the given field.

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

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

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

Definition at line 150 of file snGradScheme.H.

◆ correction()

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction ( const GeometricField< Type, fvPatchField, volMesh > & ) const

inlinevirtual

Return the explicit correction to the snGrad.

for the given field

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

Definition at line 158 of file snGradScheme.H.

◆ snGrad() [2/3]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad ( const GeometricField< Type, fvPatchField, volMesh > & vf ) const

virtual

Return the snGrad of the given cell field.

Return the face-snGrad of the given cell field.

with explicit correction

Definition at line 179 of file snGradScheme.C.

References Foam::correction(), and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ snGrad() [3/3]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > snGrad ( const tmp< GeometricField< Type, fvPatchField, volMesh > > & tvf ) const

Return the snGrad of the given tmp cell field.

Return the face-snGrad of the given cell field.

with explicit correction

Definition at line 202 of file snGradScheme.C.

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

Here is the call graph for this function:

Field Documentation

◆ mesh_

const fvMesh& mesh_

private

Hold reference to mesh.

Definition at line 67 of file snGradScheme.H.

Referenced by snGradScheme< Type >::mesh().

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

Private Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ snGradScheme()

◆ ~snGradScheme()

Member Function Documentation

◆ operator=()

◆ type()

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ snGrad() [1/3]

◆ sndGrad()

◆ deltaCoeffs()

◆ corrected()

◆ correction()

◆ snGrad() [2/3]

◆ snGrad() [3/3]

Field Documentation

◆ mesh_

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