A subset of mesh cells. More...
Public Types | |
typedef cellZoneList | ZonesType |
Public Types inherited from List< label > | |
typedef SubList< label > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< label > | |
typedef label | value_type |
Type of values the UList contains. More... | |
typedef label & | reference |
Type that can be used for storing into. More... | |
typedef const label & | 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 label * | iterator |
Random access iterator for traversing UList. More... | |
typedef const label * | const_iterator |
Random access iterator for traversing UList. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator for reverse traversal of UList. More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. More... | |
Public Member Functions | |
TypeName ("cellZone") | |
Runtime type information. More... | |
virtual autoPtr< cellZone > | clone (const cellZoneList &mz) const |
Construct and return a clone, resetting the mesh zones. More... | |
virtual autoPtr< cellZone > | clone (const labelUList &addr, const cellZoneList &mz) const |
Construct and return a clone, resetting the cell list. More... | |
const pointField & | meshCentres () const |
Return the mesh cell centres. 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 zone is synchronised across coupled boundaries. Return. More... | |
virtual void | topoChange (const polyTopoChangeMap &map) |
Update zone using the given map. More... | |
virtual void | writeDict (Ostream &) const |
Write dictionary. More... | |
Zone (const word &name, const labelUList &indices, const ZonesType &zones) | |
Construct from components. More... | |
Zone (const word &name, labelList &&indices, const ZonesType &zones) | |
Construct from components, moving contents. More... | |
Zone (const word &name, const dictionary &, const ZonesType &zones) | |
Construct from dictionary. More... | |
Zone (const Zone &, const labelUList &indices, const ZonesType &zones) | |
Construct given the original zone and resetting the. More... | |
Zone (const Zone &, labelList &&indices, const ZonesType &zones) | |
Construct given the original zone, resetting the. More... | |
Zone (const Zone &)=delete | |
Disallow default bitwise copy construction. More... | |
void | operator= (const Zone &) |
Assignment operator. More... | |
void | operator= (Zone &&) |
Move assignment operator. More... | |
void | operator= (const labelUList &) |
Assignment operator to indices. More... | |
void | operator= (labelList &&) |
Move assignment of indices. More... | |
Public Member Functions inherited from Zone< cellZone, cellZoneList > | |
declareRunTimeSelectionTable (autoPtr, cellZone, dictionary,(const word &name, const dictionary &dict, const cellZoneList &mz),(name, dict, mz)) | |
Zone (const word &name, const labelUList &indices, const cellZoneList &zones) | |
Construct from components. More... | |
Zone (const word &name, labelList &&indices, const cellZoneList &zones) | |
Construct from components, moving contents. More... | |
Zone (const word &name, const dictionary &, const cellZoneList &zones) | |
Construct from dictionary. More... | |
Zone (const Zone &, const labelUList &indices, const cellZoneList &zones) | |
Construct given the original zone and resetting the. More... | |
Zone (const Zone &, labelList &&indices, const cellZoneList &zones) | |
Construct given the original zone, resetting the. More... | |
Zone (const Zone &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~Zone () |
Destructor. More... | |
const word & | name () const |
Return name. More... | |
const word & | keyword () const |
Return name as the keyword. More... | |
const cellZoneList & | zones () const |
Return ZonesType reference. More... | |
label | localIndex (const label globalIndex) const |
Map storing the local index for every global index. Used to find. More... | |
const Map< label > & | lookupMap () const |
Return a reference to the look-up map. More... | |
virtual void | clearAddressing () |
Clear addressing. More... | |
bool | checkDefinition (const label maxSize, const bool report=false) const |
Check zone definition with max size given. Return true if in error. More... | |
void | insert (const labelHashSet &newIndices) |
Insert given indices into zone. More... | |
void | swap (Zone &) |
Swap two zones. More... | |
virtual void | movePoints (const pointField &) |
Correct patch after moving points. More... | |
virtual void | mapMesh (const polyMeshMap &) |
Update from another mesh using the given map. More... | |
virtual void | distribute (const polyDistributionMap &) |
Redistribute or update using the given distribution map. More... | |
void | operator= (const Zone &) |
Assignment operator. More... | |
void | operator= (Zone &&) |
Move assignment operator. More... | |
void | operator= (const labelUList &) |
Assignment operator to indices. More... | |
void | operator= (labelList &&) |
Move assignment of indices. 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 reuse 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... | |
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= (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 label * | cdata () const |
Return a const pointer to the first data element,. More... | |
label * | data () |
Return a pointer to the first data element,. More... | |
label & | first () |
Return the first element of the list. More... | |
const label & | first () const |
Return first element of the list. More... | |
label & | last () |
Return the last element of the list. More... | |
const label & | 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< label > &) |
Copy the pointer held by the given UList. More... | |
void | deepCopy (const UList< label > &) |
Copy elements of the given UList. More... | |
label & | operator[] (const label) |
Return element of UList. More... | |
const label & | operator[] (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... | |
Static Public Attributes | |
static const char *const | labelsName = "cellLabels" |
The name associated with the zone-labels dictionary entry. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from Zone< cellZone, cellZoneList > | |
static autoPtr< cellZone > | New (const word &name, const dictionary &, const cellZoneList &) |
Return a pointer to a new cell zone. 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 Zone< cellZone, cellZoneList > | |
void | select (const Type &zone) |
Select the. More... | |
void | calcLookupMap () const |
Construct the look-up map. More... | |
void | topoChange (const labelList &map, const labelList &reverseMap) |
Update the addressing using the maps provided. 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 Zone< cellZone, cellZoneList > | |
word | name_ |
Name of zone. More... | |
const cellZoneList & | zones_ |
Reference to zone list. More... | |
Map< label > * | lookupMapPtr_ |
Map of labels in zone for fast location lookup. More... | |
A subset of mesh cells.
Currently set up as an indirect list but will be extended to use a primitive mesh. For quick check whether a cell belongs to the zone use the lookup mechanism in cellZoneList, where all the zoned cells are registered with their zone number.
Definition at line 55 of file cellZone.H.
typedef cellZoneList ZonesType |
Definition at line 62 of file cellZone.H.
TypeName | ( | "cellZone" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone, resetting the mesh zones.
Definition at line 78 of file cellZone.H.
|
inlinevirtual |
Construct and return a clone, resetting the cell list.
and mesh zones
Definition at line 88 of file cellZone.H.
const Foam::pointField & meshCentres | ( | ) | const |
Return the mesh cell centres.
Definition at line 48 of file cellZone.C.
References primitiveMesh::cellCentres(), ZoneList< ZoneType, ZonesType, MeshType >::mesh(), and Zone< cellZone, cellZoneList >::zones_.
bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 54 of file cellZone.C.
References Zone< ZoneType, ZonesType >::checkDefinition().
|
inline |
Check whether zone is synchronised across coupled boundaries. Return.
true if in error.
Definition at line 111 of file cellZone.H.
|
virtual |
Update zone using the given map.
Implements Zone< cellZone, cellZoneList >.
Definition at line 64 of file cellZone.C.
References polyTopoChangeMap::cellMap(), polyTopoChangeMap::reverseCellMap(), and Zone< ZoneType, ZonesType >::topoChange().
|
virtual |
Write dictionary.
Implements Zone< cellZone, cellZoneList >.
Definition at line 70 of file cellZone.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, Foam::type(), and Foam::writeEntry().
|
delete |
Disallow default bitwise copy construction.
|
static |
The name associated with the zone-labels dictionary entry.
Definition at line 67 of file cellZone.H.