twoDPointCorrector Class Reference

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

Inheritance diagram for twoDPointCorrector:
Collaboration diagram for twoDPointCorrector:

Public Member Functions

 ClassName ("twoDPointCorrector")
 
 twoDPointCorrector (const twoDPointCorrector &)=delete
 Disallow default bitwise copy construction. 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...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
virtual bool movePoints ()
 Correct weighting factors for moving mesh. More...
 
void operator= (const twoDPointCorrector &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >
virtual const wordtype () const
 Runtime type information. More...
 
virtual ~DemandDrivenMeshObject ()
 
const polyMeshmesh () 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 dependenciesModified () const
 Return true if the object's dependencies have been modified. 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 &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
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 TopoChangeableMeshObject< Mesh >
template<class Type >
 TopoChangeableMeshObject (Type &mo)
 
- Public Member Functions inherited from DistributeableMeshObject< Mesh >
template<class Type >
 DistributeableMeshObject (Type &mo)
 
- Public Member Functions inherited from MoveableMeshObject< Mesh >
template<class Type >
 MoveableMeshObject (Type &mo)
 
- Public Member Functions inherited from DeletableMeshObject< Mesh >
template<class Type >
 DeletableMeshObject (Type &mo)
 
virtual ~DeletableMeshObject ()=default
 Virtual destructor to make class polymorphic. More...
 

Protected Member Functions

 twoDPointCorrector (const polyMesh &mesh)
 Construct from mesh. More...
 
- Protected Member Functions inherited from DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >
 DemandDrivenMeshObject (const IOobject &io, const polyMesh &mesh)
 Construct from mesh and IOobject. More...
 
 DemandDrivenMeshObject (const word &name, const polyMesh &mesh)
 Construct from mesh and name. More...
 
 DemandDrivenMeshObject (const polyMesh &mesh)
 Construct from mesh, the name is set to Type::typeName. 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< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >
 

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< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >
static twoDPointCorrectorNew (const word &name, const polyMesh &mesh)
 Construct and return the named DemandDrivenMeshObject. More...
 
static twoDPointCorrectorNew (const polyMesh &mesh)
 Construct and return the DemandDrivenMeshObject named Type::typeName. More...
 
static twoDPointCorrectorNew (const word &name, const polyMesh &mesh, const Args &... args)
 Construct and return the named DemandDrivenMeshObject. More...
 
static twoDPointCorrectorNew (const polyMesh &mesh, const Args &... args)
 Construct and return the DemandDrivenMeshObject named Type::typeName. More...
 
static bool found (const word &name, const polyMesh &mesh)
 Return true if the DemandDrivenMeshObject with the given name. More...
 
static bool found (const polyMesh &mesh)
 Return true if the DemandDrivenMeshObject named Type::typeName. 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

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() [1/2]

twoDPointCorrector ( const polyMesh mesh)
explicitprotected

Construct from mesh.

Definition at line 197 of file twoDPointCorrector.C.

◆ twoDPointCorrector() [2/2]

twoDPointCorrector ( const twoDPointCorrector )
delete

Disallow default bitwise copy construction.

◆ ~twoDPointCorrector()

Destructor.

Definition at line 217 of file twoDPointCorrector.C.

Member Function Documentation

◆ ClassName()

ClassName ( "twoDPointCorrector"  )

◆ required()

bool required ( ) const
inline

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

Definition at line 143 of file twoDPointCorrector.H.

Referenced by motionSmootherAlgo::modifyMotionPoints().

Here is the caller graph for this function:

◆ planeNormal()

const Foam::vector & planeNormal ( ) const

Return plane normal.

Definition at line 253 of file twoDPointCorrector.C.

Referenced by directions::directions(), and motionSmootherAlgo::modifyMotionPoints().

Here is the caller graph for this function:

◆ normalEdgeIndices()

const Foam::labelList & normalEdgeIndices ( ) const

Return indices of normal edges.

Definition at line 264 of file twoDPointCorrector.C.

Referenced by motionSmootherAlgo::modifyMotionPoints().

Here is the caller graph for this function:

◆ normalDir()

Foam::direction normalDir ( ) const

Return direction normal to plane.

Definition at line 225 of file twoDPointCorrector.C.

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

Here is the call graph for this function:

◆ correctPoints()

void correctPoints ( pointField p) const

Correct motion points.

Definition at line 275 of file twoDPointCorrector.C.

References A, Foam::meshTools::constrainToMeshCentre(), UList< T >::end(), forAll, and p.

Referenced by motionSmootherAlgo::modifyMotionPoints(), and motionSolver::twoDCorrectPoints().

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

◆ correctDisplacement()

void correctDisplacement ( const pointField p,
vectorField disp 
) const

Correct motion displacements.

Definition at line 315 of file twoDPointCorrector.C.

References A, Foam::meshTools::constrainToMeshCentre(), Foam::e, forAll, and p.

Referenced by pointConstraints::constrainDisplacement().

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

◆ topoChange()

void topoChange ( const polyTopoChangeMap )
virtual

Update topology.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 365 of file twoDPointCorrector.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap )
virtual

Update from another mesh using the given map.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 371 of file twoDPointCorrector.C.

◆ distribute()

void distribute ( const polyDistributionMap )
virtual

Redistribute or update using the given distribution map.

Implements DistributeableMeshObject< Mesh >.

Definition at line 377 of file twoDPointCorrector.C.

◆ movePoints()

bool movePoints ( )
virtual

Correct weighting factors for moving mesh.

Implements MoveableMeshObject< Mesh >.

Definition at line 383 of file twoDPointCorrector.C.

◆ operator=()

void operator= ( const twoDPointCorrector )
delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >


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