FitData< FitDataType, ExtendedStencil, Polynomial > Class Template Referenceabstract

Data for the upwinded and centred polynomial fit interpolation schemes. The linearCorrection_ determines whether the fit is for a corrected linear scheme (first two coefficients are corrections for owner and neighbour) or a pure upwind scheme (first coefficient is correction for owner; weight on face taken as 1). More...

Inheritance diagram for FitData< FitDataType, ExtendedStencil, Polynomial >:
[legend]
Collaboration diagram for FitData< FitDataType, ExtendedStencil, Polynomial >:
[legend]

Public Member Functions

 FitData (const fvMesh &mesh, const ExtendedStencil &stencil, const bool linearCorrection, const scalar linearLimitFactor, const scalar centralWeight)
 Construct from components. More...
 
virtual ~FitData ()=default
 Destructor. More...
 
const ExtendedStencil & stencil () const
 Return reference to the stencil. More...
 
scalar linearLimitFactor () const
 Factor the fit is allowed to deviate from the base scheme. More...
 
scalar centralWeight () const
 Return weight for central stencil. More...
 
label dim () const
 Dimensionality of the geometry. More...
 
label minSize () const
 Minimum stencil size. More...
 
bool linearCorrection () const
 
void calcFit (scalarList &coeffsi, const List< point > &, const scalar wLin, const label faci)
 Calculate the fit for the specified face and set the coefficients. More...
 
virtual void calcFit ()=0
 Calculate the fit for all the faces. More...
 
bool movePoints ()
 Recalculate weights (but not stencil) when the mesh moves. More...
 
- Public Member Functions inherited from MeshObject< fvMesh, MoveableMeshObject, FitDataType >
 MeshObject (const fvMesh &mesh)
 Construct on Mesh type. More...
 
virtual ~MeshObject ()=default
 Destructor. More...
 
const fvMeshmesh () const
 
virtual bool writeData (Ostream &os) const
 

Protected Member Functions

void findFaceDirs (vector &idir, vector &jdir, vector &kdir, const label faci)
 Find the normal direction (i) and j and k directions for face faci. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MeshObject< fvMesh, MoveableMeshObject, FitDataType >
static const FitDataType & New (const fvMesh &mesh, Args &&... args)
 Get existing or create a new MeshObject. More...
 
static bool Delete (const fvMesh &mesh)
 Static destructor. More...
 
- Protected Attributes inherited from MeshObject< fvMesh, MoveableMeshObject, FitDataType >
const fvMeshmesh_
 

Detailed Description

template<class FitDataType, class ExtendedStencil, class Polynomial>
class Foam::FitData< FitDataType, ExtendedStencil, Polynomial >

Data for the upwinded and centred polynomial fit interpolation schemes. The linearCorrection_ determines whether the fit is for a corrected linear scheme (first two coefficients are corrections for owner and neighbour) or a pure upwind scheme (first coefficient is correction for owner; weight on face taken as 1).

Source files

Definition at line 57 of file FitData.H.

Constructor & Destructor Documentation

◆ FitData()

FitData ( const fvMesh mesh,
const ExtendedStencil &  stencil,
const bool  linearCorrection,
const scalar  linearLimitFactor,
const scalar  centralWeight 
)

Construct from components.

Definition at line 36 of file FitData.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and FitData< FitDataType, ExtendedStencil, Polynomial >::linearLimitFactor().

Here is the call graph for this function:

◆ ~FitData()

virtual ~FitData ( )
virtualdefault

Destructor.

Member Function Documentation

◆ findFaceDirs()

void findFaceDirs ( vector idir,
vector jdir,
vector kdir,
const label  faci 
)
protected

Find the normal direction (i) and j and k directions for face faci.

Definition at line 71 of file FitData.C.

References primitiveMesh::faceAreas(), polyMesh::geometricD(), mesh, polyMesh::nGeometricD(), and Foam::normalised().

Here is the call graph for this function:

◆ stencil()

const ExtendedStencil & stencil ( ) const
inline

Return reference to the stencil.

Definition at line 118 of file FitData.H.

◆ linearLimitFactor()

scalar linearLimitFactor ( ) const
inline

Factor the fit is allowed to deviate from the base scheme.

Definition at line 124 of file FitData.H.

Referenced by FitData< FitDataType, ExtendedStencil, Polynomial >::FitData().

Here is the caller graph for this function:

◆ centralWeight()

scalar centralWeight ( ) const
inline

Return weight for central stencil.

Definition at line 130 of file FitData.H.

◆ dim()

label dim ( ) const
inline

Dimensionality of the geometry.

Definition at line 136 of file FitData.H.

◆ minSize()

label minSize ( ) const
inline

Minimum stencil size.

Definition at line 142 of file FitData.H.

◆ linearCorrection()

bool linearCorrection ( ) const
inline

Definition at line 147 of file FitData.H.

◆ calcFit() [1/2]

void calcFit ( scalarList coeffsi,
const List< point > &  C,
const scalar  wLin,
const label  faci 
)

Calculate the fit for the specified face and set the coefficients.

Definition at line 132 of file FitData.C.

◆ calcFit() [2/2]

virtual void calcFit ( )
pure virtual

Calculate the fit for all the faces.

Implemented in CentredFitSnGradData< Polynomial >.

◆ movePoints()

bool movePoints

Recalculate weights (but not stencil) when the mesh moves.

Definition at line 317 of file FitData.C.


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