A list of mesh zones. More...
Public Member Functions | |
| MeshZones (const IOobject &, const MeshType &) | |
| Read constructor given IOobject and a MeshType reference. More... | |
| MeshZones (const IOobject &, const MeshType &, const label size) | |
| Construct given size. More... | |
| MeshZones (const IOobject &, const MeshType &, const PtrList< ZoneType > &) | |
| Construct given a PtrList. More... | |
| MeshZones (MeshZones &&)=default | |
| Move constructor. More... | |
| MeshZones (const MeshZones &)=delete | |
| Disallow default bitwise copy construction. More... | |
| ~MeshZones () | |
| Destructor. More... | |
| const MeshType & | mesh () const |
| Return the mesh reference. More... | |
| const Map< label > & | zoneMap () const |
| Map of zones containing zone index for all zoned elements. More... | |
| label | whichZone (const label objectIndex) const |
| Given a global object index, return the zone it is in. More... | |
| wordList | types () const |
| Return a list of zone types. More... | |
| wordList | names () const |
| Return a list of zone names. More... | |
| labelList | findIndices (const wordRe &) const |
| Return zone indices for all matches. More... | |
| label | findIndex (const wordRe &) const |
| Return zone index for the first match, return -1 if not found. More... | |
| label | findZoneID (const word &zoneName) const |
| Find zone index given a name. More... | |
| PackedBoolList | findMatching (const wordRe &) const |
| Mark cells that match the zone specification. More... | |
| void | clearAddressing () |
| Clear addressing. More... | |
| void | clear () |
| Clear the zones. More... | |
| bool | checkDefinition (const bool report=false) const |
| Check zone definition. Return true if in error. More... | |
| bool | checkParallelSync (const bool report=false) const |
| Check whether all procs have all zones and in same order. Return. More... | |
| void | movePoints (const pointField &) |
| Correct zones after moving points. More... | |
| bool | writeData (Ostream &) const |
| writeData member function required by regIOobject More... | |
| const ZoneType & | operator[] (const word &) const |
| Return const reference to ZoneType by name. More... | |
| ZoneType & | operator[] (const word &) |
| Return reference to ZoneType by name. More... | |
| void | operator= (const MeshZones< ZoneType, MeshType > &)=delete |
| Disallow default bitwise assignment. More... | |
 Public Member Functions inherited from PtrList< ZoneType > | |
| PtrList () | |
| Null Constructor. More... | |
| PtrList (const label) | |
| Construct with size specified. More... | |
| PtrList (const PtrList< ZoneType > &) | |
| Copy constructor. More... | |
| PtrList (const PtrList< ZoneType > &, const CloneArg &) | |
| Copy constructor with additional argument for clone. More... | |
| PtrList (PtrList< ZoneType > &&) | |
| Move constructor. More... | |
| PtrList (PtrList< ZoneType > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< ZoneType > &) | |
| Construct as copy of SLPtrList<T> More... | |
| PtrList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrList (Istream &) | |
| Construct from Istream using default Istream constructor class. More... | |
| ~PtrList () | |
| Destructor. More... | |
| void | setSize (const label) |
| Reset size of PtrList. If extending the PtrList, new entries are. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | clear () |
| Clear the PtrList, i.e. set size to zero deleting all the. More... | |
| void | append (ZoneType *) |
| Append an element at the end of the list. More... | |
| void | append (const autoPtr< ZoneType > &) |
| void | append (const tmp< ZoneType > &) |
| void | transfer (PtrList< ZoneType > &) |
| Transfer the contents of the argument PtrList into this PtrList. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| autoPtr< ZoneType > | set (const label, ZoneType *) |
| Set element to given T* and return old element (can be nullptr) More... | |
| autoPtr< ZoneType > | set (const label, const autoPtr< ZoneType > &) |
| Set element to given autoPtr<T> and return old element. More... | |
| autoPtr< ZoneType > | set (const label, const tmp< ZoneType > &) |
| Set element to given tmp<T> and return old element. More... | |
| void | reorder (const labelUList &oldToNew) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | shuffle (const labelUList &newToOld) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | operator= (const PtrList< ZoneType > &) |
| Assignment operator. More... | |
| void | operator= (PtrList< ZoneType > &&) |
| Move assignment operator. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| UPtrList () | |
| Null Constructor. More... | |
| UPtrList (const label) | |
| Construct with size specified. More... | |
| UPtrList (UPtrList< T > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| label | size () const |
| Return the number of elements in the UPtrList. More... | |
| bool | empty () const |
| Return true if the UPtrList is empty (ie, size() is zero) More... | |
| T & | first () |
| Return reference to the first element of the list. More... | |
| const T & | first () const |
| Return reference to first element of the list. More... | |
| T & | last () |
| Return reference to the last element of the list. More... | |
| const T & | last () const |
| Return reference to the last element of the list. More... | |
| void | setSize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | resize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | clear () |
| Clear the UPtrList, i.e. set size to zero. More... | |
| void | transfer (UPtrList< T > &) |
| Transfer the contents of the argument UPtrList into this. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| T * | set (const label, T *) |
| Set element. Return old element (can be nullptr). More... | |
| void | reorder (const labelUList &oldToNew) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | shuffle (const labelUList &newToOld) |
| Reorders elements. Ordering does not have to be done in. More... | |
| template<class T2 > | |
| UPtrList< T2 > | convert () |
| Convert to list of different pointer type. More... | |
| template<class T2 > | |
| UPtrList< const T2 > | convert () const |
| Convert to list of different pointer type. More... | |
| const T & | operator[] (const label) const |
| Return element const reference. More... | |
| T & | operator[] (const label) |
| Return element reference. More... | |
| const T * | operator() (const label) const |
| Return element const pointer. More... | |
| T * | operator() (const label) |
| Return element const pointer. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UPtrList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UPtrList. More... | |
| const_iterator | cbegin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | cend () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
| const_iterator | begin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | end () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
| template<class T2 > | |
| Foam::UPtrList< T2 > | convert () |
| template<class T2 > | |
| Foam::UPtrList< const T2 > | convert () const |
| 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 fileName & | caseName () 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... | |
| 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 up to date (obviously) More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (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... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. 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 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 fileName & | caseName (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 ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| 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< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| virtual | ~IOobject () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| word & | headerClassName () |
| Return name of the class name read from header. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| const string & | note () 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 |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName (const bool global) const |
| fileName & | instance () 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 fileName & | local () 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< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &) |
| template<class Name > | |
| Foam::word | groupName (Name name, const word &group) |
Friends | |
| Ostream & | operator (Ostream &, const MeshZones< ZoneType, MeshType > &) |
Additional Inherited Members | |
| Public Types inherited from UPtrList< T > | |
| typedef T | value_type |
| Type of values the UPtrList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into UPtrList::value_type objects. More... | |
| typedef const T & | const_reference |
| Type that can be used for storing into constant UPtrList::value_type. 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... | |
| enum | fileCheckTypes { 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 *) |
| 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... | |
| Protected Member Functions inherited from PtrList< ZoneType > | |
| void | read (Istream &, const INew &inewt) |
| Read from Istream using given Istream constructor class. 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... | |
A list of mesh zones.
Definition at line 62 of file MeshZones.H.
Read constructor given IOobject and a MeshType reference.
Definition at line 136 of file MeshZones.C.
Construct given size.
Definition at line 152 of file MeshZones.C.
Construct given a PtrList.
Definition at line 170 of file MeshZones.C.
Disallow default bitwise copy construction.
Destructor.
Definition at line 198 of file MeshZones.C.
|
inline |
Return the mesh reference.
Definition at line 126 of file MeshZones.H.
Referenced by faceZone::calcFaceZonePatch(), and FacePostProcessing< CloudType >::preFace().
| const Foam::Map< Foam::label > & zoneMap |
Map of zones containing zone index for all zoned elements.
Return -1 if the object is not in the zone
Definition at line 208 of file MeshZones.C.
| Foam::label whichZone | ( | const label | objectIndex | ) | const |
Given a global object index, return the zone it is in.
If object does not belong to any zones, return -1
Definition at line 220 of file MeshZones.C.
References HashTableCore::end(), and HashTable< T, Key, Hash >::find().
Referenced by meshRefinement::checkZoneFaces(), meshRefinement::mergeBaffles(), perfectInterface::setRefinement(), removeCells::setRefinement(), and edgeCollapser::setRefinement().
| Foam::wordList types |
Return a list of zone types.
Definition at line 240 of file MeshZones.C.
References forAll, and UPtrList< T >::size().
| Foam::wordList names |
Return a list of zone names.
Definition at line 256 of file MeshZones.C.
References forAll, and UPtrList< T >::size().
Referenced by preserveFaceZonesConstraint::add(), surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), preserveFaceZonesConstraint::apply(), meshRefinement::checkCoupledFaceZones(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), cellTable::operator=(), and CellZoneInjection< CloudType >::topoChange().
| Foam::labelList findIndices | ( | const wordRe & | key | ) | const |
Return zone indices for all matches.
Definition at line 272 of file MeshZones.C.
References Foam::findStrings(), forAll, wordRe::isPattern(), Foam::name(), and List< T >::setSize().
Referenced by porosityModel::porosityModel().
| Foam::label findIndex | ( | const wordRe & | key | ) | const |
Return zone index for the first match, return -1 if not found.
Definition at line 305 of file MeshZones.C.
References UList< T >::empty(), Foam::findIndices(), forAll, wordRe::isPattern(), and Foam::name().
| Foam::label findZoneID | ( | const word & | zoneName | ) | const |
Find zone index given a name.
Definition at line 340 of file MeshZones.C.
References Foam::endl(), forAll, InfoInFunction, and Foam::name().
Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), cellZoneSet::cellZoneSet(), snappySnapDriver::doSnap(), FacePostProcessing< CloudType >::FacePostProcessing(), faceZoneSet::faceZoneSet(), snappySnapDriver::getZoneSurfacePoints(), interRegionExplicitPorositySource::interRegionExplicitPorositySource(), movingCone::movingCone(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), pointZoneSet::pointZoneSet(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), CellZoneInjection< CloudType >::topoChange(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), and pointZoneSet::writeObject().
| Foam::PackedBoolList findMatching | ( | const wordRe & | key | ) | const |
Mark cells that match the zone specification.
Definition at line 369 of file MeshZones.C.
References Foam::findIndices(), and forAll.
| void clearAddressing |
Clear addressing.
Definition at line 387 of file MeshZones.C.
References Foam::deleteDemandDrivenData(), and forAll.
Referenced by interRegionExplicitPorositySource::interRegionExplicitPorositySource(), Foam::polyMeshZipUpCells(), polyMesh::swap(), polyMesh::topoChange(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), and pointZoneSet::writeObject().
| void clear |
Clear the zones.
Definition at line 401 of file MeshZones.C.
References clear().
Referenced by polyMeshAdder::add(), and cellTable::addCellZones().
| bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 409 of file MeshZones.C.
References forAll.
| bool checkParallelSync | ( | const bool | report = false | ) | const |
Check whether all procs have all zones and in same order. Return.
true if in error.
Definition at line 427 of file MeshZones.C.
References Foam::endl(), forAll, Foam::Info, and List< T >::size().
| void movePoints | ( | const pointField & | p | ) |
Correct zones after moving points.
Definition at line 505 of file MeshZones.C.
|
virtual |
writeData member function required by regIOobject
Implements regIOobject.
Definition at line 517 of file MeshZones.C.
References IOstream::good().
Return const reference to ZoneType by name.
Definition at line 527 of file MeshZones.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
Return reference to ZoneType by name.
Definition at line 547 of file MeshZones.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.
Disallow default bitwise assignment.
1.9.1 
