Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
fvGeometryScheme Class Referenceabstract

Abstract base class for geometry calculation schemes. More...

Inheritance diagram for fvGeometryScheme:
[legend]
Collaboration diagram for fvGeometryScheme:
[legend]

Public Member Functions

 TypeName ("fvGeometryScheme")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, fvGeometryScheme, dict,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
 
 fvGeometryScheme (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh. More...
 
virtual ~fvGeometryScheme ()=default
 Destructor. More...
 
const fvMesh & mesh () const
 Return mesh reference. More...
 
virtual void movePoints ()
 Update basic geometric properties from provided points. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update mesh for topology changes. More...
 
virtual tmp< surfaceScalarField > weights () const =0
 Return linear difference weighting factors. More...
 
virtual tmp< surfaceScalarField > deltaCoeffs () const =0
 Return cell-centre difference coefficients. More...
 
virtual tmp< surfaceScalarField > nonOrthDeltaCoeffs () const =0
 Return non-orthogonal cell-centre difference coefficients. More...
 
virtual tmp< surfaceVectorField > nonOrthCorrectionVectors () const =0
 Return non-orthogonality correction vectors. More...
 
- 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...
 

Static Public Member Functions

static tmp< fvGeometryScheme > New (const fvMesh &mesh, const dictionary &dict, const word &defaultScheme)
 Return new tmp interpolation scheme. More...
 

Protected Member Functions

bool setMeshPhi () const
 Set the mesh motion flux. More...
 

Protected Attributes

const fvMesh & mesh_
 Hold reference to mesh. More...
 

Detailed Description

Abstract base class for geometry calculation schemes.

Source files

Definition at line 56 of file fvGeometryScheme.H.

Constructor & Destructor Documentation

◆ fvGeometryScheme()

fvGeometryScheme ( const fvMesh &  mesh,
const dictionary &  dict 
)
inline

Construct from mesh.

Definition at line 107 of file fvGeometryScheme.H.

◆ ~fvGeometryScheme()

virtual ~fvGeometryScheme ( )
virtualdefault

Destructor.

Member Function Documentation

◆ setMeshPhi()

bool setMeshPhi ( ) const
protected

Set the mesh motion flux.

Definition at line 44 of file fvGeometryScheme.C.

References Foam::abort(), TimeState::deltaTValue(), f(), polyMesh::faces(), Foam::FatalError, FatalErrorInFunction, forAll, fvGeometryScheme::mesh_, polyMesh::moving(), polyMesh::oldPoints(), polyMesh::points(), UList< T >::size(), and fvMesh::time().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fvGeometryScheme"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( tmp  ,
fvGeometryScheme  ,
dict  ,
(const fvMesh &mesh, const dictionary &dict)  ,
(mesh, dict)   
)

◆ New()

Foam::tmp< Foam::fvGeometryScheme > New ( const fvMesh &  mesh,
const dictionary &  dict,
const word &  defaultScheme 
)
static

Return new tmp interpolation scheme.

Definition at line 102 of file fvGeometryScheme.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::findEntry(), dictionary::getOrDefault(), mesh, and entry::stream().

Here is the call graph for this function:

◆ mesh()

const fvMesh & mesh ( ) const
inline

Return mesh reference.

Definition at line 131 of file fvGeometryScheme.H.

References fvGeometryScheme::mesh_.

Referenced by stabilisedFvGeometryScheme::makeFaceCentresAndAreas().

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( )
virtual

Update basic geometric properties from provided points.

Reimplemented in averageNeighbourFvGeometryScheme, basicFvGeometryScheme, highAspectRatioFvGeometryScheme, solidBodyFvGeometryScheme, and stabilisedFvGeometryScheme.

Definition at line 138 of file fvGeometryScheme.C.

References primitiveMesh::clearGeom().

Referenced by basicFvGeometryScheme::movePoints(), highAspectRatioFvGeometryScheme::movePoints(), and stabilisedFvGeometryScheme::movePoints().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh &  mpm)
virtual

Update mesh for topology changes.

Reimplemented in solidBodyFvGeometryScheme.

Definition at line 152 of file fvGeometryScheme.C.

◆ weights()

virtual tmp< surfaceScalarField > weights ( ) const
pure virtual

Return linear difference weighting factors.

Implemented in basicFvGeometryScheme.

◆ deltaCoeffs()

virtual tmp< surfaceScalarField > deltaCoeffs ( ) const
pure virtual

Return cell-centre difference coefficients.

Implemented in basicFvGeometryScheme.

◆ nonOrthDeltaCoeffs()

virtual tmp< surfaceScalarField > nonOrthDeltaCoeffs ( ) const
pure virtual

Return non-orthogonal cell-centre difference coefficients.

Implemented in basicFvGeometryScheme.

◆ nonOrthCorrectionVectors()

virtual tmp< surfaceVectorField > nonOrthCorrectionVectors ( ) const
pure virtual

Return non-orthogonality correction vectors.

Implemented in basicFvGeometryScheme.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Hold reference to mesh.

Definition at line 74 of file fvGeometryScheme.H.

Referenced by highAspectRatioFvGeometryScheme::calcAspectRatioWeights(), averageNeighbourFvGeometryScheme::clipFaceTet(), fvGeometryScheme::mesh(), and fvGeometryScheme::setMeshPhi().

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