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 >:
Collaboration diagram for FitData< FitDataType, ExtendedStencil, Polynomial >:

Public Member Functions

virtual ~FitData ()
 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 DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >
virtual ~DemandDrivenMeshObject ()
 
const fvMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from MoveableMeshObject< Mesh >
 MoveableMeshObject (regIOobject &io, const Mesh &mesh)
 
- Public Member Functions inherited from GeometricMeshObject< Mesh >
 GeometricMeshObject (regIOobject &io, const Mesh &mesh)
 
- Public Member Functions inherited from TopologicalMeshObject< Mesh >
 TopologicalMeshObject (regIOobject &io, const Mesh &mesh)
 
virtual ~TopologicalMeshObject ()=default
 Virtual destructor to make class polymorphic. More...
 

Protected Member Functions

 FitData (const fvMesh &mesh, const ExtendedStencil &stencil, const bool linearCorrection, const scalar linearLimitFactor, const scalar centralWeight)
 Construct from components. More...
 
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...
 
- Protected Member Functions inherited from DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >
 DemandDrivenMeshObject (const fvMesh &mesh)
 Construct from mesh. More...
 
 DemandDrivenMeshObject (const fvMesh &mesh, const IOobject &io)
 Construct from mesh and IOobject. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Friends

class DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >
static FitDataType & New (const fvMesh &mesh)
 
static FitDataType & New (const fvMesh &mesh, const Args &... args)
 
static bool Delete (const fvMesh &mesh)
 Lookup DemandDrivenMeshObject and delete. More...
 
static bool found (const fvMesh &mesh)
 Return true if this DemandDrivenMeshObject is found. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

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 54 of file FitData.H.

Constructor & Destructor Documentation

◆ FitData()

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

Construct from components.

Definition at line 34 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 ( )
inlinevirtual

Destructor.

Definition at line 118 of file FitData.H.

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 69 of file FitData.C.

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

Here is the call graph for this function:

◆ stencil()

const ExtendedStencil& stencil ( ) const
inline

Return reference to the stencil.

Definition at line 125 of file FitData.H.

◆ linearLimitFactor()

scalar linearLimitFactor ( ) const
inline

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

Definition at line 131 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 137 of file FitData.H.

◆ dim()

label dim ( ) const
inline

Dimensionality of the geometry.

Definition at line 143 of file FitData.H.

◆ minSize()

label minSize ( ) const
inline

Minimum stencil size.

Definition at line 149 of file FitData.H.

◆ linearCorrection()

bool linearCorrection ( ) const
inline

Definition at line 154 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 131 of file FitData.C.

References primitiveMesh::faceCentres().

Here is the call graph for this function:

◆ calcFit() [2/2]

virtual void calcFit ( )
pure virtual

Calculate the fit for all the faces.

Implemented in CentredFitSnGradData< Polynomial >.

◆ movePoints()

bool movePoints
virtual

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

Implements MoveableMeshObject< Mesh >.

Definition at line 316 of file FitData.C.

Friends And Related Function Documentation

◆ DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >

friend class DemandDrivenMeshObject< fvMesh, MoveableMeshObject, FitDataType >
friend

Definition at line 79 of file FitData.H.


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