FreeFOAM The Cross-Platform CFD Toolkit
skewCorrectionVectors Class Reference

Skew-correction vectors for the skewness-corrected interpolation scheme. More...

#include <finiteVolume/skewCorrectionVectors.H>


Detailed Description

+ Inheritance diagram for skewCorrectionVectors:
+ Collaboration diagram for skewCorrectionVectors:

List of all members.

Public Member Functions

 TypeName ("skewCorrectionVectors")
 skewCorrectionVectors (const fvMesh &mesh)
virtual ~skewCorrectionVectors ()
bool skew () const
 Return whether mesh is skew or not.
const surfaceVectorFieldoperator() () const
 Return reference to skew vectors array.
virtual bool movePoints ()
 Delete the correction vectors when the mesh moves.
- Public Member Functions inherited from MeshObject< fvMesh, skewCorrectionVectors >
 MeshObject (const fvMesh &mesh)
virtual ~MeshObject ()
const fvMeshmesh () const
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function.
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 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.
 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.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.

Additional Inherited Members

- Static Public Member Functions inherited from MeshObject< fvMesh, skewCorrectionVectors >
static const
skewCorrectionVectors
New (const fvMesh &mesh)
static const
skewCorrectionVectors
New (const fvMesh &mesh, const Data1 &d)
static const
skewCorrectionVectors
New (const fvMesh &mesh, const Data1 &, const Data2 &)
static const
skewCorrectionVectors
New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
static const
skewCorrectionVectors
New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
static bool Delete (const fvMesh &mesh)
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry.
- 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.
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider.
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider.
- Protected Attributes inherited from MeshObject< fvMesh, skewCorrectionVectors >
const fvMeshmesh_

Constructor & Destructor Documentation

skewCorrectionVectors ( const fvMesh mesh)
explicit

Definition at line 40 of file skewCorrectionVectors.C.

~skewCorrectionVectors ( )
virtual

Definition at line 48 of file skewCorrectionVectors.C.

References Foam::deleteDemandDrivenData().


Member Function Documentation

TypeName ( "skewCorrectionVectors"  )
bool skew ( ) const

Return whether mesh is skew or not.

Definition at line 169 of file skewCorrectionVectors.C.

const Foam::surfaceVectorField & operator() ( ) const

Return reference to skew vectors array.

Definition at line 180 of file skewCorrectionVectors.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and Foam::skew().

bool movePoints ( )
virtual

Delete the correction vectors when the mesh moves.

Definition at line 194 of file skewCorrectionVectors.C.

References Foam::deleteDemandDrivenData().


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