leastSquaresFaGrad< Type > Class Template Reference

Second-order gradient scheme using least-squares. More...

#include <leastSquaresFaGrad.H>

Inheritance diagram for leastSquaresFaGrad< Type >:

Collaboration diagram for leastSquaresFaGrad< Type >:

Public Member Functions
	TypeName ("leastSquares")
	Runtime type information.
	leastSquaresFaGrad (const leastSquaresFaGrad &)=delete
	No copy construct.
void	operator= (const leastSquaresFaGrad &)=delete
	No copy assignment.
	leastSquaresFaGrad (const faMesh &mesh)
	Construct from mesh.
	leastSquaresFaGrad (const faMesh &mesh, Istream &)
	Construct from Istream.
virtual tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > >	calcGrad (const GeometricField< Type, faPatchField, areaMesh > &vsf, const word &name) const
	Return the gradient of the given field to the gradScheme::grad for optional caching.
Public Member Functions inherited from gradScheme< Type >
	declareRunTimeSelectionTable (tmp, gradScheme, Istream,(const faMesh &mesh, Istream &schemeData),(mesh, schemeData))
	gradScheme (const gradScheme &)=delete
	No copy construct.
void	operator= (const gradScheme &)=delete
	No copy assignment.
	gradScheme (const faMesh &mesh)
	Construct from mesh.
virtual	~gradScheme ()=default
	Destructor.
const faMesh &	mesh () const noexcept
	Return mesh reference.
tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > >	grad (const GeometricField< Type, faPatchField, areaMesh > &, 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, faPatchField, areaMesh > >	grad (const GeometricField< Type, faPatchField, areaMesh > &) 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, faPatchField, areaMesh > >	grad (const tmp< GeometricField< Type, faPatchField, areaMesh > > &) 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.

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

Detailed Description

template<class Type>
class Foam::fa::leastSquaresFaGrad< Type >

Second-order gradient scheme using least-squares.

Author Hrvoje Jasak, Wikki Ltd.

Source files

• leastSquaresFaGrad.H
• leastSquaresFaGrad.C

Definition at line 56 of file leastSquaresFaGrad.H.

Constructor & Destructor Documentation

leastSquaresFaGrad() [1/3]

template<class Type>

leastSquaresFaGrad ( const leastSquaresFaGrad< Type > & )

delete

No copy construct.

References leastSquaresFaGrad().

Referenced by leastSquaresFaGrad(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

leastSquaresFaGrad() [2/3]

template<class Type>

leastSquaresFaGrad ( const faMesh & mesh )

inline

Construct from mesh.

Definition at line 86 of file leastSquaresFaGrad.H.

References gradScheme< Type >::gradScheme(), and gradScheme< Type >::mesh().

Here is the call graph for this function:

leastSquaresFaGrad() [3/3]

template<class Type>

leastSquaresFaGrad ( const faMesh & mesh, Istream &  )

inline

Construct from Istream.

Definition at line 94 of file leastSquaresFaGrad.H.

References gradScheme< Type >::gradScheme(), and gradScheme< Type >::mesh().

Here is the call graph for this function:

Member Function Documentation

TypeName()

template<class Type>

TypeName

(

"leastSquares"

)

Runtime type information.

operator=()

template<class Type>

void operator= ( const leastSquaresFaGrad< Type > & )

delete

No copy assignment.

References leastSquaresFaGrad().

Here is the call graph for this function:

calcGrad()

template<class Type>

tmp< GeometricField< typename outerProduct< vector, Type >::type, faPatchField, areaMesh > > calcGrad ( const GeometricField< Type, faPatchField, areaMesh > & 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 47 of file leastSquaresFaGrad.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), gaussGrad< Type >::correctBoundaryConditions(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), faPatchFieldBase::coupled(), IOobject::db(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimLength, forAll, IOobject::instance(), DimensionedField< Type, GeoMesh >::mesh(), gradScheme< Type >::mesh(), Foam::name(), MeshObject< faMesh, MoveableMeshObject, leastSquaresFaVectors >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, leastSquaresFaVectors::nVectors(), faPatchField< Type >::patchNeighbourField(), leastSquaresFaVectors::pVectors(), tmp< T >::ref(), Foam::Zero, and faPatchFieldBase::zeroGradientType().

Here is the call graph for this function:

---

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

• src/finiteArea/finiteArea/gradSchemes/leastSquaresFaGrad/leastSquaresFaGrad.H
• src/finiteArea/finiteArea/gradSchemes/leastSquaresFaGrad/leastSquaresFaGrad.C