Abstract base class for runtime selected snGrad surface normal gradient schemes. More...

Inheritance diagram for snGradScheme< Type >:

[legend]

Collaboration diagram for snGradScheme< Type >:

Public Member Functions
virtual const word &	type () const =0

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

	snGradScheme (const fvMesh &mesh)

virtual	~snGradScheme ()=default

const fvMesh &	mesh () const

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

virtual bool	corrected () const noexcept

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

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

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	snGrad (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

Static Public Member Functions
static tmp< snGradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)

static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	snGrad (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const word &snGradName="snGrad")

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

Detailed Description

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

Abstract base class for runtime selected snGrad surface normal gradient schemes.

A surface normal gradient is evaluated at a cell face. It is the normal-to-face component of the gradient of values at the centres of two cells that the face connects.

Unit-surface-normal vector decomposition is based on the so-called over-relaxed approach. Orthogonal components are treated implicitly and non-orthogonal components are treated explicitly with (or without) various limiters.

Source files

Definition at line 72 of file snGradScheme.H.

Constructor & Destructor Documentation

◆ snGradScheme()

snGradScheme ( const fvMesh & mesh )

inline

Definition at line 112 of file snGradScheme.H.

◆ ~snGradScheme()

virtual ~snGradScheme ( )

virtualdefault

Member Function Documentation

◆ type()

virtual const word& type ( ) const

pure virtual

◆ declareRunTimeSelectionTable()

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

◆ New()

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

static

Definition at line 42 of file snGradScheme.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, InfoInFunction, 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

Definition at line 135 of file snGradScheme.H.

Referenced by CentredFitSnGradScheme< Type, Polynomial, Stencil >::correction(), CentredFitSnGradScheme< Type, Polynomial, Stencil >::deltaCoeffs(), faceCorrectedSnGrad< Type >::deltaCoeffs(), correctedSnGrad< Type >::deltaCoeffs(), skewCorrectedSnGrad< Type >::deltaCoeffs(), uncorrectedSnGrad< Type >::deltaCoeffs(), orthogonalSnGrad< Type >::deltaCoeffs(), relaxedSnGrad< Type >::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

Definition at line 86 of file snGradScheme.C.

References GeometricField::boundaryField(), GeometricField::boundaryFieldRef(), fvPatchField::coupled(), forAll, mesh, IOobject::NO_READ, IOobject::NO_WRITE, tmp::ref(), 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"`
	)