Public Member Functions | List of all members
twoDPointCorrector Class Reference

Class applies a two-dimensional correction to mesh motion point field. More...

Inheritance diagram for twoDPointCorrector:
Inheritance graph
[legend]
Collaboration diagram for twoDPointCorrector:
Collaboration graph
[legend]

Public Member Functions

 ClassName ("twoDPointCorrector")
 
 twoDPointCorrector (const polyMesh &mesh)
 Construct from components. More...
 
 ~twoDPointCorrector ()
 Destructor. More...
 
bool required () const
 Is 2D correction required, i.e. is the mesh a wedge or slab. More...
 
const vectorplaneNormal () const
 Return plane normal. More...
 
const labelListnormalEdgeIndices () const
 Return indices of normal edges. More...
 
direction normalDir () const
 Return direction normal to plane. More...
 
void correctPoints (pointField &p) const
 Correct motion points. More...
 
void correctDisplacement (const pointField &p, vectorField &disp) const
 Correct motion displacements. More...
 
void updateMesh (const mapPolyMesh &)
 Update topology. More...
 
bool movePoints ()
 Correct weighting factors for moving mesh. More...
 
- Public Member Functions inherited from MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >
 MeshObject (const polyMesh &mesh)
 
virtual ~MeshObject ()
 
const polyMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 
- Public Member Functions inherited from UpdateableMeshObject< polyMesh >
 UpdateableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from MoveableMeshObject< polyMesh >
 MoveableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from GeometricMeshObject< polyMesh >
 GeometricMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from TopologicalMeshObject< polyMesh >
 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)
 

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< polyMesh, UpdateableMeshObject, twoDPointCorrector >
static const twoDPointCorrectorNew (const polyMesh &mesh)
 
static const twoDPointCorrectorNew (const polyMesh &mesh, const Data1 &d)
 
static const twoDPointCorrectorNew (const polyMesh &mesh, const Data1 &, const Data2 &)
 
static const twoDPointCorrectorNew (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
 
static const twoDPointCorrectorNew (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
 
static bool Delete (const polyMesh &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 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...
 
- Protected Attributes inherited from MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >
const polyMeshmesh_
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Class applies a two-dimensional correction to mesh motion point field.

The correction guarantees that the mesh does not get twisted during motion and thus introduce a third dimension into a 2-D problem.

The operation is performed by looping through all edges approximately normal to the plane and enforcing their orthogonality onto the plane by adjusting points on their ends.

Source files

Definition at line 61 of file twoDPointCorrector.H.

Constructor & Destructor Documentation

twoDPointCorrector ( const polyMesh mesh)

Construct from components.

Definition at line 197 of file twoDPointCorrector.C.

Destructor.

Definition at line 212 of file twoDPointCorrector.C.

Member Function Documentation

ClassName ( "twoDPointCorrector"  )
bool required ( ) const
inline

Is 2D correction required, i.e. is the mesh a wedge or slab.

Definition at line 130 of file twoDPointCorrector.H.

References twoDPointCorrector::correctDisplacement(), twoDPointCorrector::correctPoints(), twoDPointCorrector::movePoints(), twoDPointCorrector::normalDir(), twoDPointCorrector::normalEdgeIndices(), twoDPointCorrector::planeNormal(), and twoDPointCorrector::updateMesh().

Referenced by motionSmootherAlgo::modifyMotionPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::vector & planeNormal ( ) const
const Foam::labelList & normalEdgeIndices ( ) const

Return indices of normal edges.

Definition at line 259 of file twoDPointCorrector.C.

Referenced by twoDPointCorrector::correctDisplacement(), twoDPointCorrector::correctPoints(), motionSmootherAlgo::modifyMotionPoints(), and twoDPointCorrector::required().

Here is the caller graph for this function:

Foam::direction normalDir ( ) const

Return direction normal to plane.

Definition at line 220 of file twoDPointCorrector.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, Foam::mag(), Foam::nl, twoDPointCorrector::planeNormal(), Vector< Cmpt >::X, Vector< Cmpt >::x(), Vector< Cmpt >::Y, Vector< Cmpt >::y(), Vector< Cmpt >::Z, and Vector< Cmpt >::z().

Referenced by twoDPointCorrector::required().

Here is the call graph for this function:

Here is the caller graph for this function:

void correctPoints ( pointField p) const
void correctDisplacement ( const pointField p,
vectorField disp 
) const
void updateMesh ( const mapPolyMesh )
virtual

Update topology.

Implements UpdateableMeshObject< polyMesh >.

Definition at line 360 of file twoDPointCorrector.C.

Referenced by twoDPointCorrector::required().

Here is the caller graph for this function:

bool movePoints ( )
virtual

Correct weighting factors for moving mesh.

Implements MoveableMeshObject< polyMesh >.

Definition at line 366 of file twoDPointCorrector.C.

Referenced by twoDPointCorrector::required().

Here is the caller graph for this function:


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