polyTopoChanger Class Reference

List of mesh modifiers defining the mesh dynamics. More...

Inheritance diagram for polyTopoChanger:
[legend]
Collaboration diagram for polyTopoChanger:
[legend]

Public Member Functions

 TypeName ("polyTopoChanger")
 Runtime type information. More...
 
 polyTopoChanger (const IOobject &io, polyMesh &mesh)
 Read construct given IOobject and a polyMesh. More...
 
 polyTopoChanger (polyMesh &mesh, const IOobject::readOption rOpt)
 Read construct for given polyMesh and read-option. More...
 
 polyTopoChanger (polyMesh &mesh)
 Read construct for given polyMesh. More...
 
virtual ~polyTopoChanger ()=default
 Destructor. More...
 
const polyMeshmesh () const
 Return the mesh reference. More...
 
wordList types () const
 Return a list of patch types. More...
 
wordList names () const
 Return a list of patch names. More...
 
bool changeTopology () const
 Is topology change required. More...
 
autoPtr< polyTopoChangetopoChangeRequest () const
 Return topology change request. More...
 
void modifyMotionPoints (pointField &) const
 Modify point motion. More...
 
autoPtr< mapPolyMeshchangeMesh (const bool inflate, const bool syncParallel=true, const bool orderCells=false, const bool orderPoints=false)
 
void update (const mapPolyMesh &m)
 Force recalculation of locally stored data on topological change. More...
 
void addTopologyModifiers (const List< polyMeshModifier * > &tm)
 Add given set of topology modifiers to the topoChanger. More...
 
label findModifierID (const word &modName) const
 Find modifier given a name. More...
 
bool writeData (Ostream &) const
 writeData member function required by regIOobject More...
 
bool operator!= (const polyTopoChanger &) const
 
bool operator== (const polyTopoChanger &) const
 
- Public Member Functions inherited from PtrList< polyMeshModifier >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< polyMeshModifier > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< polyMeshModifier > &&list)
 Move construct. More...
 
 PtrList (UList< polyMeshModifier * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< polyMeshModifier > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< polyMeshModifier > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< polyMeshModifier > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< polyMeshModifierclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< polyMeshModifierclone (Args &&... args) const
 
const polyMeshModifierset (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< polyMeshModifierset (const label i, polyMeshModifier *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< polyMeshModifierset (const label i, autoPtr< polyMeshModifier > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< polyMeshModifierset (const label i, autoPtr< polyMeshModifier > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< polyMeshModifierset (const label i, std::unique_ptr< polyMeshModifier > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< polyMeshModifierset (const label i, const refPtr< polyMeshModifier > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< polyMeshModifierset (const label i, const tmp< polyMeshModifier > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (polyMeshModifier *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< polyMeshModifier > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< polyMeshModifier > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< polyMeshModifier > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< polyMeshModifier > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< polyMeshModifier > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
autoPtr< polyMeshModifieremplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< polyMeshModifieremplace (const label i, Args &&... args)
 
autoPtr< polyMeshModifierrelease (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< polyMeshModifier > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< polyMeshModifier > &list)
 Copy assignment. More...
 
void operator= (PtrList< polyMeshModifier > &&list)
 Move assignment. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTime=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 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 as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=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...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. 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, bool globalObject=false)
 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, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, readOption, writeOption)
 Copy construct, resetting io options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const Timetime () const
 Return time. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return non-constant access to the class name read from header. More...
 
const stringnote () const
 Return the optional note. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
bool registerObject () const
 Should object created with this IOobject be registered? More...
 
boolregisterObject ()
 Should object created with this IOobject be registered? More...
 
bool globalObject () const
 Is object same for all processors? More...
 
boolglobalObject ()
 Is object same for all processors? More...
 
unsigned labelByteSize () const
 The label byte-size, possibly read from the header. More...
 
unsigned scalarByteSize () const
 The scalar byte-size, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const
 The read option. More...
 
readOptionreadOpt ()
 Non-constant access to the read option. More...
 
writeOption writeOpt () const
 The write option. More...
 
writeOptionwriteOpt ()
 Non-constant access to the write option. More...
 
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
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &is)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header. More...
 
bool writeHeader (Ostream &os, 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 &io)
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
template<class StringType >
Foam::word scopedName (StringType scope, const word &name)
 

Protected Attributes

polyMeshmesh_
 Reference to mesh. More...
 

Friends

Ostreamoperator<< (Ostream &, const polyTopoChanger &)
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership 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 StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
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 StringType >
static word scopedName (StringType scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Protected Member Functions inherited from PtrList< polyMeshModifier >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

List of mesh modifiers defining the mesh dynamics.

Source files

Definition at line 62 of file polyTopoChanger.H.

Constructor & Destructor Documentation

◆ polyTopoChanger() [1/3]

polyTopoChanger ( const IOobject io,
polyMesh mesh 
)

Read construct given IOobject and a polyMesh.

Definition at line 89 of file polyTopoChanger.C.

◆ polyTopoChanger() [2/3]

polyTopoChanger ( polyMesh mesh,
const IOobject::readOption  rOpt 
)

Read construct for given polyMesh and read-option.

Definition at line 103 of file polyTopoChanger.C.

◆ polyTopoChanger() [3/3]

polyTopoChanger ( polyMesh mesh)
explicit

Read construct for given polyMesh.

Uses read-option READ_IF_PRESENT

Definition at line 130 of file polyTopoChanger.C.

◆ ~polyTopoChanger()

virtual ~polyTopoChanger ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "polyTopoChanger"  )

Runtime type information.

◆ mesh()

const polyMesh& mesh ( ) const
inline

Return the mesh reference.

Definition at line 111 of file polyTopoChanger.H.

References polyTopoChanger::mesh_.

◆ types()

Foam::wordList types ( ) const

Return a list of patch types.

Definition at line 136 of file polyTopoChanger.C.

References forAll.

◆ names()

Foam::wordList names ( ) const

Return a list of patch names.

Definition at line 151 of file polyTopoChanger.C.

References forAll.

◆ changeTopology()

bool changeTopology ( ) const

Is topology change required.

Definition at line 166 of file polyTopoChanger.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ topoChangeRequest()

Foam::autoPtr< Foam::polyTopoChange > topoChangeRequest ( ) const

Return topology change request.

Definition at line 212 of file polyTopoChanger.C.

References forAll, mesh, autoPtr< T >::New(), and ref().

Here is the call graph for this function:

◆ modifyMotionPoints()

void modifyMotionPoints ( pointField p) const

Modify point motion.

Definition at line 232 of file polyTopoChanger.C.

References forAll, and p.

◆ changeMesh()

Foam::autoPtr< Foam::mapPolyMesh > changeMesh ( const bool  inflate,
const bool  syncParallel = true,
const bool  orderCells = false,
const bool  orderPoints = false 
)

Definition at line 265 of file polyTopoChanger.C.

References ref(), and update().

Referenced by attachPolyTopoChanger::attach().

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

◆ update()

void update ( const mapPolyMesh m)

Force recalculation of locally stored data on topological change.

Definition at line 246 of file polyTopoChanger.C.

References IOobject::AUTO_WRITE, and forAll.

◆ addTopologyModifiers()

void addTopologyModifiers ( const List< polyMeshModifier * > &  tm)

Add given set of topology modifiers to the topoChanger.

Definition at line 296 of file polyTopoChanger.C.

References Foam::abort(), IOobject::AUTO_WRITE, Foam::FatalError, FatalErrorInFunction, forAll, Foam::BitOps::set(), and setSize().

Here is the call graph for this function:

◆ findModifierID()

Foam::label findModifierID ( const word modName) const

Find modifier given a name.

Definition at line 319 of file polyTopoChanger.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::name(), and WarningInFunction.

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream os) const
virtual

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 345 of file polyTopoChanger.C.

References IOstream::good().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const polyTopoChanger me) const

Definition at line 354 of file polyTopoChanger.C.

References Foam::constant::atomic::me.

◆ operator==()

bool operator== ( const polyTopoChanger me) const

Definition at line 360 of file polyTopoChanger.C.

References Foam::constant::atomic::me.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const polyTopoChanger  
)
friend

Member Data Documentation

◆ mesh_

polyMesh& mesh_
protected

Reference to mesh.

Definition at line 83 of file polyTopoChanger.H.

Referenced by attachPolyTopoChanger::attach(), and polyTopoChanger::mesh().


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