A subset of mesh faces organised as a primitive patch. More...
Public Types | |
typedef faceZoneList | ZonesType |
![]() | |
typedef SubList< label > | subList |
Declare type of subList. More... | |
![]() | |
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 ("faceZone") | |
Runtime type information. More... | |
faceZone (const word &name, const labelUList &addr, const boolList &fm, const faceZoneList &mz) | |
Construct from components. More... | |
faceZone (const word &name, labelList &&addr, boolList &&fm, const faceZoneList &) | |
Construct from components, moving contents. More... | |
faceZone (const word &name, const dictionary &, const faceZoneList &) | |
Construct from dictionary. More... | |
faceZone (const faceZone &, const labelUList &addr, const boolList &fm, const faceZoneList &) | |
Construct given the original zone and resetting the. More... | |
faceZone (const faceZone &, labelList &&addr, boolList &&fm, const faceZoneList &) | |
Construct given the original zone, resetting the. More... | |
faceZone (const faceZone &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual autoPtr< faceZone > | clone (const faceZoneList &mz) const |
Construct and return a clone, resetting the mesh zones. More... | |
virtual autoPtr< faceZone > | clone (const labelUList &addr, const boolList &fm, const faceZoneList &mz) const |
Construct and return a clone, resetting the face list. More... | |
virtual | ~faceZone () |
Destructor. More... | |
const boolList & | flipMap () const |
Return face flip map. More... | |
const pointField & | meshCentres () const |
Return the mesh face centres. More... | |
const primitiveFacePatch & | patch () const |
Return reference to primitive patch. More... | |
const labelList & | masterCells () const |
Return labels of master cells (cells next to the master face. More... | |
const labelList & | slaveCells () const |
Return labels of slave cells. More... | |
const labelList & | meshEdges () const |
Return global edge index for local edges. More... | |
virtual void | clearAddressing () |
Clear addressing. More... | |
virtual void | resetAddressing (const labelUList &, const boolList &) |
Reset addressing and flip map (clearing demand-driven data) 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 faces synchronised. Return. More... | |
void | insert (const Map< bool > &newIndices) |
Insert given indices and corresponding face flips into zone. More... | |
void | swap (faceZone &) |
Swap two faceZones. More... | |
virtual void | movePoints (const pointField &) |
Correct patch after moving points. More... | |
virtual void | topoChange (const polyTopoChangeMap &) |
Update zone using the given map. More... | |
virtual void | writeDict (Ostream &) const |
Write dictionary. More... | |
void | operator= (const faceZone &) |
Assignment to zone, clearing demand-driven data. More... | |
void | operator= (faceZone &&) |
Move assignment to zone, clearing demand-driven data. More... | |
![]() | |
declareRunTimeSelectionTable (autoPtr, faceZone, dictionary,(const word &name, const dictionary &dict, const faceZoneList &mz),(name, dict, mz)) | |
Zone (const word &name, const labelUList &indices, const faceZoneList &zones) | |
Construct from components. More... | |
Zone (const word &name, labelList &&indices, const faceZoneList &zones) | |
Construct from components, moving contents. More... | |
Zone (const word &name, const dictionary &, const faceZoneList &zones) | |
Construct from dictionary. More... | |
Zone (const Zone &, const labelUList &indices, const faceZoneList &zones) | |
Construct given the original zone and resetting the. More... | |
Zone (const Zone &, labelList &&indices, const faceZoneList &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 faceZoneList & | 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... | |
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 | 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... | |
![]() | |
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... | |
![]() | |
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 = "faceLabels" |
The name associated with the zone-labels dictionary entry. More... | |
Protected Member Functions | |
void | calcFaceZonePatch () const |
Build primitive patch. More... | |
const Map< label > & | faceLookupMap () const |
Return map of local face indices. More... | |
void | calcCellLayers () const |
Calculate master and slave face layer. More... | |
void | checkAddressing () const |
Check addressing. More... | |
void | reset (const Map< bool > &indices) |
Reset the indices and flipMap from the given map. More... | |
![]() | |
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... | |
![]() | |
void | size (const label) |
Override size to be inconsistent with allocated storage. More... | |
Protected Attributes | |
boolList | flipMap_ |
Flip map for all faces in the zone. Set to true if the. More... | |
primitiveFacePatch * | patchPtr_ |
Primitive patch made out of correctly flipped faces. More... | |
labelList * | masterCellsPtr_ |
Master cell layer. More... | |
labelList * | slaveCellsPtr_ |
Slave cell layer. More... | |
labelList * | mePtr_ |
Global edge addressing. More... | |
![]() | |
word | name_ |
Name of zone. More... | |
const faceZoneList & | zones_ |
Reference to zone list. More... | |
Map< label > * | lookupMapPtr_ |
Map of labels in zone for fast location lookup. More... | |
Additional Inherited Members | |
![]() | |
static autoPtr< faceZone > | New (const word &name, const dictionary &, const faceZoneList &) |
Return a pointer to a new cell zone. More... | |
![]() | |
static const List< label > & | null () |
Return a null List. More... | |
![]() | |
static const UList< label > & | null () |
Return a null UList. More... | |
A subset of mesh faces organised as a primitive patch.
For quick check whether a face belongs to the zone use the lookup mechanism in faceZoneList, where all the zoned faces are registered with their zone number.
Definition at line 56 of file faceZone.H.
typedef faceZoneList ZonesType |
Definition at line 110 of file faceZone.H.
faceZone | ( | const word & | name, |
const labelUList & | addr, | ||
const boolList & | fm, | ||
const faceZoneList & | mz | ||
) |
Construct from components.
Definition at line 205 of file faceZone.C.
References faceZone::checkAddressing().
Referenced by faceZone::clone().
faceZone | ( | const word & | name, |
labelList && | addr, | ||
boolList && | fm, | ||
const faceZoneList & | mz | ||
) |
Construct from components, moving contents.
Definition at line 224 of file faceZone.C.
References faceZone::checkAddressing().
faceZone | ( | const word & | name, |
const dictionary & | dict, | ||
const faceZoneList & | mz | ||
) |
Construct from dictionary.
Definition at line 243 of file faceZone.C.
References faceZone::checkAddressing().
faceZone | ( | const faceZone & | fz, |
const labelUList & | addr, | ||
const boolList & | fm, | ||
const faceZoneList & | mz | ||
) |
Construct given the original zone and resetting the.
face list and mesh zones information
Definition at line 261 of file faceZone.C.
References faceZone::checkAddressing().
faceZone | ( | const faceZone & | fz, |
labelList && | addr, | ||
boolList && | fm, | ||
const faceZoneList & | mz | ||
) |
Construct given the original zone, resetting the.
face list and mesh zones information
Definition at line 280 of file faceZone.C.
References faceZone::checkAddressing().
|
virtual |
Destructor.
Definition at line 301 of file faceZone.C.
|
protected |
Build primitive patch.
Definition at line 49 of file faceZone.C.
References Foam::abort(), Foam::endl(), f(), polyMesh::faces(), Foam::FatalError, FatalErrorInFunction, faceZone::flipMap(), forAll, InfoInFunction, ZoneList< ZoneType, ZonesType, MeshType >::mesh(), faceZone::patch(), faceZone::patchPtr_, points, List< label >::size(), and Zone< faceZone, faceZoneList >::zones().
|
protected |
Calculate master and slave face layer.
Definition at line 96 of file faceZone.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, InfoInFunction, and List< T >::size().
|
protected |
Check addressing.
Definition at line 155 of file faceZone.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, List< T >::size(), and WarningInFunction.
Referenced by faceZone::faceZone().
|
protected |
Reset the indices and flipMap from the given map.
Definition at line 184 of file faceZone.C.
References forAll, List< T >::setSize(), HashTable< T, Key, Hash >::size(), and HashTable< T, Key, Hash >::sorted().
TypeName | ( | "faceZone" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone, resetting the mesh zones.
Definition at line 173 of file faceZone.H.
References faceZone::faceZone(), and faceZone::flipMap().
|
inlinevirtual |
Construct and return a clone, resetting the face list.
and mesh zones
Definition at line 183 of file faceZone.H.
|
inline |
Return face flip map.
Definition at line 204 of file faceZone.H.
References faceZone::flipMap_.
Referenced by faceZone::calcFaceZonePatch(), faceZone::clone(), faceZoneSet::faceZoneSet(), and faceZoneList::zonesFlipFace().
const Foam::pointField & meshCentres | ( | ) | const |
Return the mesh face centres.
Definition at line 309 of file faceZone.C.
const Foam::primitiveFacePatch & patch | ( | ) | const |
Return reference to primitive patch.
Definition at line 315 of file faceZone.C.
Referenced by faceZone::calcFaceZonePatch(), and FacePostProcessing< CloudType >::write().
const Foam::labelList & masterCells | ( | ) | const |
Return labels of master cells (cells next to the master face.
zone in the prescribed direction)
Definition at line 326 of file faceZone.C.
const Foam::labelList & slaveCells | ( | ) | const |
Return labels of slave cells.
Definition at line 337 of file faceZone.C.
const Foam::labelList & meshEdges | ( | ) | const |
Return global edge index for local edges.
Definition at line 348 of file faceZone.C.
|
virtual |
Clear addressing.
Reimplemented from Zone< faceZone, faceZoneList >.
Definition at line 367 of file faceZone.C.
References Zone< ZoneType, ZonesType >::clearAddressing(), and Foam::deleteDemandDrivenData().
|
virtual |
Reset addressing and flip map (clearing demand-driven data)
Definition at line 380 of file faceZone.C.
References List< label >::operator=().
bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 392 of file faceZone.C.
References Zone< ZoneType, ZonesType >::checkDefinition().
bool checkParallelSync | ( | const bool | report = false | ) | const |
Check whether all procs have faces synchronised. Return.
true if in error.
Definition at line 402 of file faceZone.C.
References polyMesh::boundaryMesh(), Foam::endl(), forAll, primitiveMesh::isInternalFace(), IOobject::name(), Foam::name(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), patchi, Foam::Pout, Foam::returnReduce(), syncTools::swapBoundaryFaceList(), and polyBoundaryMesh::whichPatch().
void insert | ( | const Map< bool > & | newIndices | ) |
Insert given indices and corresponding face flips into zone.
Definition at line 489 of file faceZone.C.
References HashTable< T, Key, Hash >::insert().
void swap | ( | faceZone & | fz | ) |
Swap two faceZones.
Definition at line 497 of file faceZone.C.
References faceZone::flipMap_, and Zone< ZoneType, ZonesType >::swap().
|
virtual |
Correct patch after moving points.
Reimplemented from Zone< faceZone, faceZoneList >.
Definition at line 545 of file faceZone.C.
|
virtual |
Update zone using the given map.
Implements Zone< faceZone, faceZoneList >.
Definition at line 504 of file faceZone.C.
References polyTopoChangeMap::faceMap(), Foam::faceMap(), polyTopoChangeMap::flipFaceFlux(), forAll, HashTable< T, Key, Hash >::found(), HashTable< T, Key, Hash >::insert(), and polyTopoChangeMap::reverseFaceMap().
|
virtual |
Write dictionary.
Implements Zone< faceZone, faceZoneList >.
Definition at line 554 of file faceZone.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, Foam::type(), and Foam::writeEntry().
Assignment to zone, clearing demand-driven data.
Definition at line 568 of file faceZone.C.
References faceZone::flipMap_, and Zone< ZoneType, ZonesType >::operator=().
Move assignment to zone, clearing demand-driven data.
Definition at line 575 of file faceZone.C.
References Zone< ZoneType, ZonesType >::operator=().
|
protected |
Flip map for all faces in the zone. Set to true if the.
face needs to be flipped to achieve the correct orientation.
Definition at line 72 of file faceZone.H.
Referenced by faceZone::flipMap(), faceZone::operator=(), and faceZone::swap().
|
mutableprotected |
Primitive patch made out of correctly flipped faces.
Definition at line 78 of file faceZone.H.
Referenced by faceZone::calcFaceZonePatch().
|
mutableprotected |
Master cell layer.
Definition at line 81 of file faceZone.H.
|
mutableprotected |
Slave cell layer.
Definition at line 84 of file faceZone.H.
|
mutableprotected |
Global edge addressing.
Definition at line 87 of file faceZone.H.
|
static |
The name associated with the zone-labels dictionary entry.
Definition at line 115 of file faceZone.H.