Abstract base class for gradient schemes. More...

#include <gradScheme.H>

Inheritance diagram for gradScheme< Type >:

[legend]

Collaboration diagram for gradScheme< Type >:

Public Member Functions
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const fvMesh &mesh)
	Construct from mesh.
virtual	~gradScheme ()=default
	Destructor.
const fvMesh &	mesh () const
	Return const reference to mesh.
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	calcGrad (const GeometricField< Type, fvPatchField, volMesh > &, const word &name) const =0
	Calculate and return the grad of the given field.
virtual void	calcGrad (GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > &res, const GeometricField< Type, fvPatchField, volMesh > &) const
	Calculate the grad of the given field into supplied field.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (const GeometricField< Type, fvPatchField, volMesh > &, const word &name) const
	Calculate and return the grad of the given field which may have been cached.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (const GeometricField< Type, fvPatchField, volMesh > &) const
	Calculate and return the grad of the given field with the default name which may have been cached.
tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Calculate and return the grad of the given field with the default name which may have been cached.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Static Public Member Functions
static tmp< gradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return a pointer to a new gradScheme created on freestore.

Detailed Description

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

Abstract base class for gradient schemes.

Source files

Definition at line 59 of file gradScheme.H.

Constructor & Destructor Documentation

◆ gradScheme()

template<class Type>

gradScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 109 of file gradScheme.H.

References mesh().

Here is the call graph for this function:

◆ ~gradScheme()

template<class Type>

virtual ~gradScheme ( )

virtualdefault

Destructor.

Member Function Documentation

◆ type()

template<class Type>

virtual const word & type ( ) const

pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class Type>

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

References mesh().

Here is the call graph for this function:

◆ New()

template<class Type>

Foam::tmp< Foam::fv::gradScheme< Type > > New	(	const fvMesh &	mesh,
		Istream &	schemeData )

static

Return a pointer to a new gradScheme created on freestore.

Definition at line 29 of file gradScheme.C.

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

Referenced by cellLimitedGrad< Foam::scalar, Foam::fv::gradientLimiters::minmod >::cellLimitedGrad(), cellMDLimitedGrad< Type >::cellMDLimitedGrad(), linearUpwind< Type >::correction(), linearUpwind< Type >::correction(), faceLimitedGrad< Type >::faceLimitedGrad(), faceMDLimitedGrad< Type >::faceMDLimitedGrad(), correctedSnGrad< Type >::fullGradCorrection(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), and Foam::fvc::grad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mesh()

template<class Type>

const fvMesh & mesh ( ) const

inline

Return const reference to mesh.

Definition at line 138 of file gradScheme.H.

Referenced by cellLimitedGrad< Type, Limiter >::calcGrad(), cellLimitedGrad< Type, Limiter >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), fusedGaussGrad< Type >::calcGrad(), fusedGaussGrad< Type >::calcGrad(), fusedLeastSquaresGrad< Type >::calcGrad(), gaussGrad< Type >::calcGrad(), LeastSquaresGrad< Type, Stencil >::calcGrad(), LeastSquaresGrad< Type, Stencil >::calcGrad(), leastSquaresGrad< Type >::calcGrad(), cellLimitedGrad< Foam::scalar, Foam::fv::gradientLimiters::minmod >::cellLimitedGrad(), cellMDLimitedGrad< Type >::cellMDLimitedGrad(), fusedGaussGrad< Type >::correctBoundaryConditions(), declareRunTimeSelectionTable(), faceLimitedGrad< Type >::faceLimitedGrad(), faceMDLimitedGrad< Type >::faceMDLimitedGrad(), fourthGrad< Type >::fourthGrad(), fusedGaussGrad< Type >::fusedGaussGrad(), fusedGaussGrad< Type >::fusedGaussGrad(), fusedLeastSquaresGrad< Type >::fusedLeastSquaresGrad(), fusedLeastSquaresGrad< Type >::fusedLeastSquaresGrad(), gaussGrad< Type >::gaussGrad(), gaussGrad< Type >::gaussGrad(), fusedGaussGrad< Type >::gradf(), gaussGrad< Type >::gradf(), gradScheme(), iterativeGaussGrad< Type >::iterativeGaussGrad(), iterativeGaussGrad< Type >::iterativeGaussGrad(), LeastSquaresGrad< Foam::scalar, Foam::centredCPCCellToCellStencilObject >::LeastSquaresGrad(), leastSquaresGrad< Type >::leastSquaresGrad(), leastSquaresGrad< Type >::leastSquaresGrad(), and New().

Here is the caller graph for this function:

◆ calcGrad() [1/2]

template<class Type>

virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > > calcGrad	(	const GeometricField< Type, fvPatchField, volMesh > &	,
		const word &	name ) const

pure virtual

Calculate and return the grad of the given field.

Used by grad either to recalculate the cached gradient when it is out of date with respect to the field or when it is not cached.

Implemented in cellLimitedGrad< Type, Limiter >, cellMDLimitedGrad< Type >, faceLimitedGrad< Type >, faceMDLimitedGrad< Type >, fourthGrad< Type >, fusedGaussGrad< Type >, fusedLeastSquaresGrad< Type >, gaussGrad< Type >, iterativeGaussGrad< Type >, LeastSquaresGrad< Type, Stencil >, and leastSquaresGrad< Type >.

References Foam::name().

Referenced by calcGrad(), and grad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcGrad() [2/2]

template<class Type>

void calcGrad	(	GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > &	res,
		const GeometricField< Type, fvPatchField, volMesh > &	vsf ) const

virtual

Calculate the grad of the given field into supplied field.

Reimplemented in cellLimitedGrad< Type, Limiter >, fourthGrad< Type >, fusedGaussGrad< Type >, gaussGrad< Type >, and LeastSquaresGrad< Type, Stencil >.

Definition at line 174 of file gradScheme.C.

References calcGrad(), DebugPout, Foam::endl(), and IOobject::name().

Here is the call graph for this function:

◆ grad() [1/3]

template<class Type>

Foam::tmp< Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > > grad	(	const GeometricField< Type, fvPatchField, volMesh > &	vsf,
		const word &	name ) const

Calculate and return the grad of the given field which may have been cached.

Definition at line 80 of file gradScheme.C.

References solution::cachePrintMessage(), calcGrad(), mesh, Foam::name(), and regIOobject::store().

Referenced by faceLimitedGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), grad(), and grad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ grad() [2/3]

template<class Type>

Foam::tmp< Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > > grad ( const GeometricField< Type, fvPatchField, volMesh > & vsf ) const

Calculate and return the grad of the given field with the default name which may have been cached.

Definition at line 140 of file gradScheme.C.

References grad(), and IOobject::name().

Here is the call graph for this function:

◆ grad() [3/3]

template<class Type>

Foam::tmp< Foam::GeometricField< typename Foam::outerProduct< Foam::vector, Type >::type, Foam::fvPatchField, Foam::volMesh > > grad ( const tmp< GeometricField< Type, fvPatchField, volMesh > > & tvsf ) const

Calculate and return the grad of the given field with the default name which may have been cached.

Definition at line 159 of file gradScheme.C.

References grad().

Here is the call graph for this function:

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

src/finiteVolume/finiteVolume/gradSchemes/gradScheme/gradScheme.H
src/finiteVolume/finiteVolume/gradSchemes/gradScheme/gradScheme.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ gradScheme()

◆ ~gradScheme()

Member Function Documentation

◆ type()

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ calcGrad() [1/2]

◆ calcGrad() [2/2]

◆ grad() [1/3]

◆ grad() [2/3]

◆ grad() [3/3]