Gradient calculated using weighted least-squares on an arbitrary stencil. The stencil type is provided via a template argument and any cell-based stencil is supported: More...

Inheritance diagram for LeastSquaresGrad< Type, Stencil >:

[legend]

Collaboration diagram for LeastSquaresGrad< Type, Stencil >:

[legend]

Public Member Functions
	TypeName ("LeastSquares")
	Runtime type information. More...

	LeastSquaresGrad (const fvMesh &mesh, Istream &schemeData)
	Construct from Istream. More...

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

virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	calcGrad (const GeometricField< Type, fvPatchField, volMesh > &vsf, const word &name) const
	Return the gradient of the given field to the gradScheme::grad. More...

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

Public Member Functions inherited from gradScheme< Type >
virtual const word &	type () const =0
	Runtime type information. More...

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

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

virtual	~gradScheme ()
	Destructor. More...

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

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

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

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

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

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initializing count to 0. More...

Detailed Description

template<class Type, class Stencil>
class Foam::fv::LeastSquaresGrad< Type, Stencil >

Gradient calculated using weighted least-squares on an arbitrary stencil. The stencil type is provided via a template argument and any cell-based stencil is supported:

Stencil	Connections	Scheme name
`centredCFCCellToCellStencil`	cell-face-cell	Not Instantiated
`centredCPCCellToCellStencil`	cell-point-cell	pointCellsLeastSquares
`centredCECCellToCellStencil`	cell-edge-cell	edgeCellsLeastSquares

The first of these is not instantiated by default as the standard leastSquaresGrad is equivalent and more efficient.

Usage

Example of the gradient specification:

gradSchemes
{
    default         pointCellsLeastSquares;
}

See also: Foam::fv::LeastSquaresVectors Foam::fv::leastSquaresGrad

Source files

Definition at line 97 of file LeastSquaresGrad.H.

Constructor & Destructor Documentation

◆ LeastSquaresGrad() [1/2]

LeastSquaresGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

inline

Construct from Istream.

Definition at line 116 of file LeastSquaresGrad.H.

References LeastSquaresGrad< Type, Stencil >::calcGrad(), Foam::name(), and LeastSquaresGrad< Type, Stencil >::operator=().

Here is the call graph for this function:

◆ LeastSquaresGrad() [2/2]

LeastSquaresGrad ( const LeastSquaresGrad< Type, Stencil > & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "LeastSquares" )

Runtime type information.

◆ calcGrad()

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