Public Member Functions | Protected Member Functions | List of all members
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 >:
Inheritance graph
[legend]
Collaboration diagram for FitData< FitDataType, ExtendedStencil, Polynomial >:
Collaboration graph
[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 ()
 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)
 
virtual ~MeshObject ()
 
const fvMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 
- Public Member Functions inherited from MoveableMeshObject< fvMesh >
 MoveableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from GeometricMeshObject< fvMesh >
 GeometricMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from TopologicalMeshObject< fvMesh >
 TopologicalMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from meshObject
 ClassName ("meshObject")
 
 meshObject (const word &typeName, const objectRegistry &obr)
 
- 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 &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from 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...
 
IstreamreadStream (const word &)
 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...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. 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
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- 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...
 
Foam::autoPtr< IOobjectclone () const
 Clone. 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...
 
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
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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)
 

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...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- 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...
 
- Static Public Member Functions inherited from MeshObject< fvMesh, MoveableMeshObject, FitDataType >
static const FitDataType & New (const fvMesh &mesh)
 
static const FitDataType & New (const fvMesh &mesh, const Data1 &d)
 
static const FitDataType & New (const fvMesh &mesh, const Data1 &, const Data2 &)
 
static const FitDataType & New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
 
static const FitDataType & New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
 
static bool Delete (const fvMesh &mesh)
 
- Static Public Member Functions inherited from meshObject
template<class Mesh >
static void movePoints (objectRegistry &)
 
template<class Mesh >
static void updateMesh (objectRegistry &, const mapPolyMesh &)
 
template<class Mesh , template< class > class MeshObjectType>
static void clear (objectRegistry &)
 
template<class Mesh , template< class > class FromType, template< class > class ToType>
static void clearUpto (objectRegistry &)
 Clear all meshObject derived from FromType up to (but not including) 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)
 
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 const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Protected Attributes inherited from MeshObject< fvMesh, MoveableMeshObject, FitDataType >
const fvMeshmesh_
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. 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 ( const fvMesh mesh,
const ExtendedStencil &  stencil,
const bool  linearCorrection,
const scalar  linearLimitFactor,
const scalar  centralWeight 
)

Construct from components.

Definition at line 35 of file FitData.C.

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

Here is the call graph for this function:

virtual ~FitData ( )
inlinevirtual

Destructor.

Definition at line 109 of file FitData.H.

Member Function Documentation

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

References FitData< FitDataType, ExtendedStencil, Polynomial >::calcFit(), Foam::exit(), f(), primitiveMesh::faceAreas(), primitiveMesh::faceCentres(), polyMesh::faces(), Foam::FatalError, FatalErrorIn, polyMesh::geometricD(), Foam::mag(), mesh, polyMesh::nGeometricD(), and polyMesh::points().

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

Here is the call graph for this function:

Here is the caller graph for this function:

const ExtendedStencil& stencil ( ) const
inline

Return reference to the stencil.

Definition at line 116 of file FitData.H.

scalar linearLimitFactor ( ) const
inline

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

Definition at line 122 of file FitData.H.

scalar centralWeight ( ) const
inline

Return weight for central stencil.

Definition at line 128 of file FitData.H.

label dim ( ) const
inline

Dimensionality of the geometry.

Definition at line 134 of file FitData.H.

label minSize ( ) const
inline

Minimum stencil size.

Definition at line 140 of file FitData.H.

bool linearCorrection ( ) const
inline
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.

References Foam::cmptMag(), Foam::cmptMax(), Foam::endl(), forAll, Foam::mag(), mesh, Foam::nl, p, List< T >::setSize(), List< T >::size(), SVD::VSinvUt(), WarningIn, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

virtual void calcFit ( )
pure virtual

Calculate the fit for all the faces.

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

Here is the caller graph for this function:

bool movePoints ( )
virtual

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

Implements MoveableMeshObject< fvMesh >.

Definition at line 320 of file FitData.C.

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

Here is the caller graph for this function:


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