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

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
	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 ()=default
	Destructor. More...

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

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

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
	Default construct, initializing count to 0. More...

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

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

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	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...

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

Constructor & Destructor Documentation

◆ LeastSquaresGrad()

LeastSquaresGrad	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

inline

Construct from Istream.

Definition at line 131 of file LeastSquaresGrad.H.

Member Function Documentation

◆ TypeName()

TypeName ( "LeastSquares" )

Runtime type information.

◆ calcGrad()

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

virtual

Return the gradient of the given field to the gradScheme::grad for optional caching

Implements gradScheme< Type >.

Definition at line 48 of file LeastSquaresGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), mapDistributeBase::constructSize(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimLength, mapDistribute::distribute(), forAll, IOobject::instance(), extendedCentredCellToCellStencil::map(), mesh, DimensionedField< Type, GeoMesh >::mesh(), Foam::name(), fvPatchField< Type >::patch(), tmp< T >::ref(), fvPatch::start(), LeastSquaresVectors< Stencil >::stencil(), extendedCentredCellToCellStencil::stencil(), and LeastSquaresVectors< Stencil >::vectors().

Here is the call graph for this function:

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

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