attachPolyTopoChanger Class Reference

This class is derived from polyMesh and serves as a tool for statically connecting pieces of a mesh by executing the mesh modifiers and cleaning the mesh. More...

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

Public Member Functions

 attachPolyTopoChanger (const IOobject &io, polyMesh &)
 Read constructor from IOobject and a polyMesh. More...
 
 attachPolyTopoChanger (polyMesh &)
 Read constructor for given polyMesh. More...
 
virtual ~attachPolyTopoChanger ()=default
 Destructor. More...
 
void attach (const bool removeEmptyPatches=true)
 Attach mesh. By default filter out empty patches. More...
 
- Public Member Functions inherited from polyTopoChanger
 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 isTimeObject=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...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) 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 (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::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, bool globalObject=false)
 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 noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Return non-constant access to the optional note. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, 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 noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. 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 noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
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 objectRelPath () const
 The object path relative to the root. 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...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
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 with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
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)
 

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 bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable an output file banner. More...
 
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...
 
static word scopedName (const std::string &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, const bool noSyntaxHint=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 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...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. 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 IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Protected Attributes inherited from polyTopoChanger
polyMeshmesh_
 Reference to mesh. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

This class is derived from polyMesh and serves as a tool for statically connecting pieces of a mesh by executing the mesh modifiers and cleaning the mesh.

The idea is that a mesh can be built from pieces and put together using various mesh modifiers (mainly sliding interfaces) which are not needed during the run. Therefore, once the mesh is assembled and mesh modification triggered, the newly created point, face and cell zones can be cleared together with the mesh modifiers thus creating a singly connected static mesh.

Note: All point, face and cell zoning will be lost! Do it after attaching the parts of the mesh, as the point, face and cell numbering changes.

Definition at line 62 of file attachPolyTopoChanger.H.

Constructor & Destructor Documentation

◆ attachPolyTopoChanger() [1/2]

attachPolyTopoChanger ( const IOobject io,
polyMesh mesh 
)

Read constructor from IOobject and a polyMesh.

Definition at line 35 of file attachPolyTopoChanger.C.

◆ attachPolyTopoChanger() [2/2]

attachPolyTopoChanger ( polyMesh mesh)
explicit

Read constructor for given polyMesh.

Definition at line 45 of file attachPolyTopoChanger.C.

◆ ~attachPolyTopoChanger()

virtual ~attachPolyTopoChanger ( )
virtualdefault

Destructor.

Member Function Documentation

◆ attach()

void attach ( const bool  removeEmptyPatches = true)

Attach mesh. By default filter out empty patches.

Definition at line 55 of file attachPolyTopoChanger.C.

References polyMesh::addPatches(), polyMesh::boundaryMesh(), polyTopoChanger::changeMesh(), primitiveMesh::checkMesh(), PtrList< T >::clone(), Foam::expressions::patchExpr::debug, Foam::endl(), polyMesh::facesInstance(), forAll, polyTopoChanger::mesh_, polyMesh::movePoints(), IOobject::name(), polyMesh::oldPoints(), p, Foam::Pout, polyMesh::removeBoundary(), polyMesh::setInstance(), and polyBoundaryMesh::start().

Here is the call graph for this function:

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