regionSplit Class Reference

This class separates the mesh into distinct unconnected regions, each of which is then given a label according to globalNumbering(). More...

Inheritance diagram for regionSplit:
Collaboration diagram for regionSplit:

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...
 
 regionSplit (const regionSplit &)=delete
 Disallow default bitwise copy construction. More...
 
const polyMeshmesh () const
 Return reference to the polyMesh. More...
 
const globalIndexglobalNumbering () 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 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 initialising all elements to zero. More...
 
 List (const List< label > &)
 Copy constructor. More...
 
 List (const UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< label > &&)
 Move constructor. 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 initialiser 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...
 
labelnewElmt (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= (List< label > &&)
 Move assignment operator. 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 initialiser 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< label >
void operator= (const label &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
 UList ()
 Null constructor. More...
 
 UList (label *__restrict__ v, label size)
 Construct from components. More...
 
 UList (const UList< label > &)=default
 Copy construct. 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 labelcdata () const
 Return a const pointer to the first data element,. More...
 
labeldata ()
 Return a pointer to the first data element,. More...
 
labelfirst ()
 Return the first element of the list. More...
 
const labelfirst () const
 Return first element of the list. More...
 
labellast ()
 Return the last element of the list. More...
 
const labellast () 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< label > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< label > &)
 Copy elements of the given UList. More...
 
labeloperator[] (const label)
 Return element of UList. More...
 
const labeloperator[] (const label) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
 operator const Foam::List< label > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant 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...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_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 rend () const
 Return const_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...
 
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< label > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< label > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< label > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< label > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< label > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< label > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< label > &) const
 Return true if !(a < b). Takes linear time. More...
 

Additional Inherited Members

- Public Types inherited from List< label >
typedef SubList< labelsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< label >
typedef label value_type
 Type of values the UList contains. More...
 
typedef labelreference
 Type that can be used for storing into. More...
 
typedef const labelconst_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 labeliterator
 Random access iterator for traversing UList. More...
 
typedef const labelconst_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. 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< label >
static const UList< label > & null ()
 Return a null UList. More...
 
- Protected Member Functions inherited from List< label >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

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:

  • 0 which is local to it. proc1 uses regions
  • 0 which originates from proc0
  • 2 which is local to it proc2 uses regions
  • 2 which originates from proc1

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.

Source files

Definition at line 115 of file regionSplit.H.

Constructor & Destructor Documentation

◆ regionSplit() [1/4]

regionSplit ( const polyMesh mesh,
const bool  doGlobalRegions = Pstream::parRun() 
)

Construct from mesh.

Definition at line 395 of file regionSplit.C.

◆ regionSplit() [2/4]

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 410 of file regionSplit.C.

◆ regionSplit() [3/4]

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 430 of file regionSplit.C.

◆ regionSplit() [4/4]

regionSplit ( const regionSplit )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ ClassName()

ClassName ( "regionSplit"  )

Runtime type information.

◆ mesh()

const polyMesh& mesh ( ) const
inline

Return reference to the polyMesh.

Definition at line 190 of file regionSplit.H.

◆ globalNumbering()

const globalIndex& globalNumbering ( ) const
inline

Return global region numbering.

Definition at line 196 of file regionSplit.H.

Referenced by regionSplit::nLocalRegions(), and regionSplit::nRegions().

Here is the caller graph for this function:

◆ nLocalRegions()

label nLocalRegions ( ) const
inline

Return local number of regions.

Definition at line 202 of file regionSplit.H.

References regionSplit::globalNumbering(), globalIndex::localSize(), and UPstream::myProcNo().

Referenced by decompositionMethod::decompose().

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

◆ nRegions()

label nRegions ( ) const
inline

Return total number of regions.

Definition at line 208 of file regionSplit.H.

References regionSplit::globalNumbering(), and globalIndex::size().

Referenced by regionSizeDistribution::regionSum(), and regionSizeDistribution::write().

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

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