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")

	LeastSquaresGrad (const fvMesh &mesh, Istream &schemeData)

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

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

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

	gradScheme (const fvMesh &mesh)

virtual	~gradScheme ()=default

const fvMesh &	mesh () const

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

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

tmp< GeometricField< typename outerProduct< vector, Type >::type, fvPatchField, volMesh > >	grad (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

Additional Inherited Members
Static Public Member Functions inherited from gradScheme< Type >
static tmp< gradScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)

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 99 of file LeastSquaresGrad.H.

Constructor & Destructor Documentation

◆ LeastSquaresGrad()

LeastSquaresGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

inline

Definition at line 127 of file LeastSquaresGrad.H.

Member Function Documentation

◆ TypeName()

TypeName ( "LeastSquares" )

◆ calcGrad()

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

virtual

Implements gradScheme< Type >.

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

src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H

Public Member Functions

Additional Inherited Members