This class separates the mesh into distinct unconnected regions, each of which is then given a label according to globalNumbering(). More...
Public Member Functions | |
| ClassName ("regionSplit") | |
| Runtime type information. More... | |
| regionSplit (const polyMesh &, const bool doGlobalRegions=Pstream::parRun()) | |
| Construct from mesh. More... | |
| regionSplit (const polyMesh &, const boolList &blockedFace, const bool doGlobalRegions=Pstream::parRun()) | |
| Construct from mesh and whether face is blocked. More... | |
| regionSplit (const polyMesh &, const boolList &blockedFace, const List< labelPair > &, const bool doGlobalRegions=Pstream::parRun()) | |
| Construct from mesh and whether face is blocked. Additional explicit. More... | |
| const globalIndex & | globalNumbering () const |
| Return global region numbering. More... | |
| label | nLocalRegions () const |
| Return local number of regions. More... | |
| label | nRegions () const |
| Return total number of regions. More... | |
 Public Member Functions inherited from MeshObject< polyMesh, TopologicalMeshObject, regionSplit > | |
| MeshObject (const polyMesh &mesh) | |
| virtual | ~MeshObject () |
| const polyMesh & | mesh () const |
| virtual bool | writeData (Foam::Ostream &) const |
| 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... | |
| 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... | |
| 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... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (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. Return. 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 valid) const |
| Write using given format, version and compression. 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 &) |
| 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, bool globalObject=false) | |
| 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, bool globalObject=false) | |
| 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... | |
| 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... | |
| bool & | globalObject () |
| Is object same for all processors. More... | |
| bool | globalObject () const |
| Is object same for all processors. 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 |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () 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 | localFilePath (const word &typeName) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName) const |
| Helper for filePath that searches up if in parallel. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true) |
| Read header (uses typeFilePath to find file) and check header. 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) |
| Public Member Functions inherited from List< label > | |
| List () | |
| Null constructor. More... | |
| List (const label) | |
| Construct with given size. More... | |
| List (const label, const label &) | |
| Construct with given size and value for all elements. More... | |
| List (const label, const zero) | |
| Construct with given size initializing all elements to zero. More... | |
| List (const List< label > &) | |
| Copy constructor. More... | |
| List (const List< T2 > &) | |
| Copy constructor from list containing another type. More... | |
| List (const Xfer< List< label >> &) | |
| Construct by transferring the parameter contents. More... | |
| List (List< label > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< label > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| List (InputIterator first, InputIterator last) | |
| Construct given start and end iterators. More... | |
| List (const FixedList< label, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< label > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< label > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< label > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< label > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (std::initializer_list< label >) | |
| Construct from an initializer list. More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| autoPtr< List< label > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const label &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const label &) |
| Reset size of List and value for new elements. More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | append (const label &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< label > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< label > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< label > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (DynamicList< label, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< label > &) |
| Transfer the contents of the argument List into this list. More... | |
| Xfer< List< label > > | xfer () |
| Transfer contents to the Xfer container. More... | |
| label & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< label > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< label > &) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< label > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const SLList< label > &) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< label > &) |
| Assignment to UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< label > &) |
| Assignment to BiIndirectList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< label >) |
| Assignment to an initializer list. More... | |
| void | operator= (const label &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| Public Member Functions inherited from UList< T > | |
| UList () | |
| Null constructor. More... | |
| UList (T *__restrict__ v, label size) | |
| Construct from components. More... | |
| label | fcIndex (const label i) const |
| Return the forward circular index, i.e. the next index. More... | |
| label | rcIndex (const label i) const |
| Return the reverse circular index, i.e. the previous index. More... | |
| std::streamsize | byteSize () const |
| Return the binary size in number of characters of the UList. More... | |
| const T * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| T * | data () |
| Return a pointer to the first data element,. More... | |
| T & | first () |
| Return the first element of the list. More... | |
| const T & | first () const |
| Return first element of the list. More... | |
| T & | last () |
| Return the last element of the list. More... | |
| const T & | last () const |
| Return the last element of the list. More... | |
| void | checkStart (const label start) const |
| Check start is within valid range (0 ... size-1) More... | |
| void | checkSize (const label size) const |
| Check size is within valid range (0 ... size) More... | |
| void | checkIndex (const label i) const |
| Check index i is within valid range (0 ... size-1) More... | |
| void | shallowCopy (const UList< T > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< T > &) |
| Copy elements of the given UList. More... | |
| void | writeEntry (Ostream &) const |
| Write the UList as a dictionary entry. More... | |
| void | writeEntry (const word &keyword, Ostream &) const |
| Write the UList as a dictionary entry with keyword. More... | |
| T & | operator[] (const label) |
| Return element of UList. More... | |
| const T & | operator[] (const label) const |
| Return element of constant UList. More... | |
| operator const Foam::List< T > & () const | |
| Allow cast to a const List<T>&. More... | |
| void | operator= (const T &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | cend () const |
| Return const_iterator to end traversing the constant UList. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | end () const |
| Return const_iterator to end traversing the constant UList. More... | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More... | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| label | max_size () const |
| Return size of the largest possible UList. More... | |
| bool | empty () const |
| Return true if the UList is empty (ie, size() is zero) More... | |
| void | swap (UList< T > &) |
| Swap two ULists of the same type in constant time. More... | |
| bool | operator== (const UList< T > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< T > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< T > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< T > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< T > &) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< T > &) const |
| Return true if !(a < b). Takes linear time. More... | |
| template<> | |
| const bool & | operator[] (const label i) const |
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... | |
| Public Types inherited from List< label > | |
| typedef SubList< label > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< T > | |
| typedef T | value_type |
| Type of values the UList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into. More... | |
| typedef const T & | const_reference |
| Type that can be used for storing into. More... | |
| typedef label | difference_type |
| The type that can represent the difference between any two. More... | |
| typedef label | size_type |
| The type that can represent the size of a UList. More... | |
| typedef T * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const T * | const_iterator |
| Random access iterator for traversing UList. More... | |
| typedef T * | reverse_iterator |
| Reverse iterator for reverse traversal of UList. More... | |
| typedef const T * | const_reverse_iterator |
| Reverse iterator for reverse traversal of constant UList. More... | |
| Static Public Member Functions inherited from MeshObject< polyMesh, TopologicalMeshObject, regionSplit > | |
| static const regionSplit & | New (const polyMesh &mesh) |
| static const regionSplit & | New (const polyMesh &mesh, const Data1 &d) |
| static const regionSplit & | New (const polyMesh &mesh, const Data1 &, const Data2 &) |
| static const regionSplit & | New (const polyMesh &mesh, const Data1 &, const Data2 &, const Data3 &) |
| static const regionSplit & | New (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 Member Functions inherited from List< label > | |
| static const List< label > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< T > | |
| static const UList< T > & | null () |
| Return a null UList. More... | |
| Static Public Attributes inherited from regIOobject | |
| static float | fileModificationSkew |
| Static Public Attributes inherited from IOobject | |
| static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. 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... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| Protected Member Functions inherited from List< label > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
| Protected Attributes inherited from MeshObject< polyMesh, TopologicalMeshObject, regionSplit > | |
| const polyMesh & | mesh_ |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
This class separates the mesh into distinct unconnected regions, each of which is then given a label according to globalNumbering().
Say 6 cells, 3 processors, with single baffle on proc1.
baffle | +—+—+—+—+—+—+ | | | | | | | +—+—+—+—+—+—+ proc0 | proc1 | proc2
1: determine local regions (uncoupled)
+—+—+—+—+—+—+ | 0 | 0 | 0 | 1 | 0 | 0 | +—+—+—+—+—+—+ proc0 | proc1 | proc2
2: make global
+—+—+—+—+—+—+ | 0 | 0 | 1 | 2 | 3 | 3 | +—+—+—+—+—+—+ proc0 | proc1 | proc2
3: merge connected across procs
+—+—+—+—+—+—+ | 0 | 0 | 0 | 2 | 2 | 2 | +—+—+—+—+—+—+ proc0 | proc1 | proc2
4. determine locally owner regions. determine compact numbering for the local regions and send these to all processors that need them:
proc0 uses regions:
So proc1 needs to get the compact number for region 0 from proc0 and proc2 needs to get the compact number for region 2 from proc1:
+—+—+—+—+—+—+ | 0 | 0 | 0 | 1 | 1 | 1 | +—+—+—+—+—+—+ proc0 | proc1 | proc2
Can optionally keep all regions local to the processor.
Note: does not walk across cyclicAMI/cyclicACMI - since not 'coupled()' at the patch level.
Definition at line 119 of file regionSplit.H.
| regionSplit | ( | const polyMesh & | mesh, |
| const bool | doGlobalRegions = Pstream::parRun() |
||
| ) |
Construct from mesh.
Definition at line 398 of file regionSplit.C.
Referenced by regionSplit::regionSplit().
| regionSplit | ( | const polyMesh & | mesh, |
| const boolList & | blockedFace, | ||
| const bool | doGlobalRegions = Pstream::parRun() |
||
| ) |
Construct from mesh and whether face is blocked.
NOTE: blockedFace has to be consistent across coupled faces!
Definition at line 414 of file regionSplit.C.
References regionSplit::regionSplit().
| regionSplit | ( | const polyMesh & | mesh, |
| const boolList & | blockedFace, | ||
| const List< labelPair > & | explicitConnections, | ||
| const bool | doGlobalRegions = Pstream::parRun() |
||
| ) |
Construct from mesh and whether face is blocked. Additional explicit.
connections between normal boundary faces. NOTE: blockedFace has to be consistent across coupled faces!
Definition at line 434 of file regionSplit.C.
| ClassName | ( | "regionSplit" | ) |
Runtime type information.
|
inline |
Return global region numbering.
Definition at line 189 of file regionSplit.H.
Referenced by regionSplit::nLocalRegions(), and regionSplit::nRegions().
|
inline |
Return local number of regions.
Definition at line 195 of file regionSplit.H.
References regionSplit::globalNumbering(), globalIndex::localSize(), and UPstream::myProcNo().
Referenced by decompositionMethod::decompose().
|
inline |
Return total number of regions.
Definition at line 201 of file regionSplit.H.
References regionSplit::globalNumbering(), and globalIndex::size().
Referenced by meshRefinement::mergeBaffles(), regionSizeDistribution::regionSum(), meshRefinement::splitMesh(), and regionSizeDistribution::write().
1.8.13
