A subset of mesh faces organised as a primitive patch. More...
#include <OpenFOAM/faceZone.H>
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 faceZoneMesh, where all the zoned faces are registered with their zone number.
Definition at line 68 of file faceZone.H.
Public Member Functions | |
TypeName ("faceZone") | |
Runtime type information. | |
declareRunTimeSelectionTable (autoPtr, faceZone, dictionary,(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm),(name, dict, index, zm)) | |
faceZone (const word &name, const labelList &addr, const boolList &fm, const label index, const faceZoneMesh &zm) | |
Construct from components. | |
faceZone (const word &name, const Xfer< labelList > &addr, const Xfer< boolList > &fm, const label index, const faceZoneMesh &) | |
Construct from components, transferring contents. | |
faceZone (const word &name, const dictionary &, const label index, const faceZoneMesh &) | |
Construct from dictionary. | |
faceZone (const faceZone &, const labelList &addr, const boolList &fm, const label index, const faceZoneMesh &) | |
Construct given the original zone and resetting the. | |
faceZone (const faceZone &, const Xfer< labelList > &addr, const Xfer< boolList > &fm, const label index, const faceZoneMesh &) | |
Construct given the original zone, resetting the. | |
virtual autoPtr< faceZone > | clone (const faceZoneMesh &zm) const |
Construct and return a clone, resetting the zone mesh. | |
virtual autoPtr< faceZone > | clone (const labelList &addr, const boolList &fm, const label index, const faceZoneMesh &zm) const |
Construct and return a clone, resetting the face list. | |
virtual | ~faceZone () |
Destructor. | |
const word & | name () const |
Return name. | |
const boolList & | flipMap () const |
Return face flip map. | |
label | whichFace (const label globalFaceID) const |
Map storing the local face index for every global face index. | |
const primitiveFacePatch & | operator() () const |
Return reference to primitive patch. | |
label | index () const |
Return the index of this zone in zone list. | |
const faceZoneMesh & | zoneMesh () const |
Return zoneMesh reference. | |
const labelList & | masterCells () const |
Return labels of master cells (cells next to the master face. | |
const labelList & | slaveCells () const |
Return labels of slave cells. | |
const labelList & | meshEdges () const |
Return global edge index for local edges. | |
void | clearAddressing () |
Clear addressing. | |
void | resetAddressing (const labelList &, const boolList &) |
Reset addressing and flip map (clearing demand-driven data) | |
bool | checkDefinition (const bool report=false) const |
Check zone definition. Return true if in error. | |
bool | checkParallelSync (const bool report=false) const |
Check whether all procs have faces synchronised. Return. | |
virtual void | movePoints (const pointField &) |
Correct patch after moving points. | |
void | updateMesh (const mapPolyMesh &mpm) |
Update for changes in topology. | |
virtual void | write (Ostream &) const |
Write. | |
virtual void | writeDict (Ostream &) const |
Write dictionary. | |
![]() | |
label | size () const |
Return the number of elements in the UList. | |
List () | |
Null constructor. | |
List (const label) | |
Construct with given size. | |
List (const label, const label &) | |
Construct with given size and value for all elements. | |
List (const List< label > &) | |
Copy constructor. | |
List (const Xfer< List< label > > &) | |
Construct by transferring the parameter contents. | |
List (List< label > &, bool reUse) | |
Construct as copy or re-use as specified. | |
List (const UList< label > &, const unallocLabelList &mapAddressing) | |
Construct as subset. | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. | |
List (const FixedList< label, Size > &) | |
Construct as copy of FixedList<T, Size> | |
List (const PtrList< label > &) | |
Construct as copy of PtrList<T> | |
List (const SLList< label > &) | |
Construct as copy of SLList<T> | |
List (const IndirectList< label > &) | |
Construct as copy of IndirectList<T> | |
List (const UIndirectList< label > &) | |
Construct as copy of UIndirectList<T> | |
List (const BiIndirectList< label > &) | |
Construct as copy of BiIndirectList<T> | |
List (Istream &) | |
Construct from Istream. | |
autoPtr< List< label > > | clone () const |
Clone. | |
~List () | |
void | resize (const label) |
Reset size of List. | |
void | resize (const label, const label &) |
Reset size of List and value for new elements. | |
void | setSize (const label) |
Reset size of List. | |
void | setSize (const label, const label &) |
Reset size of List and value for new elements. | |
void | clear () |
Clear the list, i.e. set size to zero. | |
void | append (const UList< label > &) |
Append a List at the end of this list. | |
void | append (const UIndirectList< label > &) |
Append a UIndirectList at the end of this list. | |
void | transfer (List< label > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (DynamicList< label, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (SortableList< label > &) |
Transfer the contents of the argument List into this list. | |
Xfer< List< label > > | xfer () |
Transfer contents to the Xfer container. | |
label & | newElmt (const label) |
Return subscript-checked element of UList. | |
void | operator= (const UList< label > &) |
Assignment from UList operator. Takes linear time. | |
void | operator= (const List< label > &) |
Assignment operator. Takes linear time. | |
void | operator= (const SLList< label > &) |
Assignment from SLList operator. Takes linear time. | |
void | operator= (const IndirectList< label > &) |
Assignment from IndirectList operator. Takes linear time. | |
void | operator= (const UIndirectList< label > &) |
Assignment from UIndirectList operator. Takes linear time. | |
void | operator= (const BiIndirectList< label > &) |
Assignment from BiIndirectList operator. Takes linear time. | |
void | operator= (const label &) |
Assignment of all entries to the given value. | |
![]() | |
UList () | |
Null constructor. | |
UList (label *__restrict__ v, label size) | |
Construct from components. | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. | |
label | byteSize () const |
Return the binary size in number of characters of the UList. | |
const label * | cdata () const |
Return a const pointer to the first data element,. | |
label * | data () |
Return a pointer to the first data element,. | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1). | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size). | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1). | |
void | writeEntry (Ostream &) const |
Write the UList as a dictionary entry. | |
void | writeEntry (const word &keyword, Ostream &) const |
Write the UList as a dictionary entry with keyword. | |
void | assign (const UList< label > &) |
Assign elements to those from UList. | |
label & | operator[] (const label) |
Return element of UList. | |
const label & | operator[] (const label) const |
Return element of constant UList. | |
operator const Foam::List< label > & () const | |
Allow cast to a const List<T>&. | |
iterator | begin () |
Return an iterator to begin traversing the UList. | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. | |
iterator | end () |
Return an iterator to end traversing the UList. | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant UList. | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant UList. | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
label | max_size () const |
Return size of the largest possible UList. | |
bool | empty () const |
Return true if the UList is empty (ie, size() is zero). | |
void | swap (UList< label > &) |
Swap two ULists of the same type in constant time. | |
bool | operator== (const UList< label > &) const |
Equality operation on ULists of the same type. | |
bool | operator!= (const UList< label > &) const |
The opposite of the equality operation. Takes linear time. | |
bool | operator< (const UList< label > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator> (const UList< label > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator<= (const UList< label > &) const |
Return true if !(a > b). Takes linear time. | |
bool | operator>= (const UList< label > &) const |
Return true if !(a < b). Takes linear time. |
Static Public Member Functions | |
static autoPtr< faceZone > | New (const word &name, const dictionary &, const label index, const faceZoneMesh &) |
Return a pointer to a new face zone. | |
![]() | |
static const List< label > & | null () |
Return a null List. |
Friends | |
Ostream & | operator<< (Ostream &, const faceZone &) |
Additional Inherited Members | |
![]() | |
typedef SubList< label > | subList |
Declare type of subList. | |
![]() | |
typedef label | value_type |
Type of values the UList contains. | |
typedef label & | reference |
Type that can be used for storing into. | |
typedef const label & | const_reference |
Type that can be used for storing into. | |
typedef label | difference_type |
The type that can represent the difference between any two. | |
typedef label | size_type |
The type that can represent the size of a UList. | |
typedef label * | iterator |
Random access iterator for traversing UList. | |
typedef const label * | const_iterator |
Random access iterator for traversing UList. | |
typedef label * | reverse_iterator |
Reverse iterator for reverse traversal of UList. | |
typedef const label * | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. | |
![]() | |
void | size (const label) |
Override size to be inconsistent with allocated storage. |
faceZone | ( | const word & | name, |
const labelList & | addr, | ||
const boolList & | fm, | ||
const label | index, | ||
const faceZoneMesh & | zm | ||
) |
Construct from components.
Definition at line 230 of file faceZone.C.
faceZone | ( | const word & | name, |
const Xfer< labelList > & | addr, | ||
const Xfer< boolList > & | fm, | ||
const label | index, | ||
const faceZoneMesh & | zm | ||
) |
Construct from components, transferring contents.
Definition at line 254 of file faceZone.C.
faceZone | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index, | ||
const faceZoneMesh & | zm | ||
) |
Construct from dictionary.
Definition at line 279 of file faceZone.C.
faceZone | ( | const faceZone & | fz, |
const labelList & | addr, | ||
const boolList & | fm, | ||
const label | index, | ||
const faceZoneMesh & | zm | ||
) |
Construct given the original zone and resetting the.
face list and zone mesh information
Definition at line 304 of file faceZone.C.
faceZone | ( | const faceZone & | fz, |
const Xfer< labelList > & | addr, | ||
const Xfer< boolList > & | fm, | ||
const label | index, | ||
const faceZoneMesh & | zm | ||
) |
Construct given the original zone, resetting the.
face list and zone mesh information
Definition at line 328 of file faceZone.C.
|
virtual |
Destructor.
Definition at line 353 of file faceZone.C.
TypeName | ( | "faceZone" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
faceZone | , | ||
dictionary | , | ||
(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm) | , | ||
(name, dict, index, zm) | |||
) |
|
inlinevirtual |
Construct and return a clone, resetting the zone mesh.
Definition at line 207 of file faceZone.H.
References faceZone::flipMap(), and faceZone::index().
|
inlinevirtual |
Construct and return a clone, resetting the face list.
and zone mesh
Definition at line 218 of file faceZone.H.
|
static |
Return a pointer to a new face zone.
created on freestore from dictionary
Definition at line 36 of file newFaceZone.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, dictionary::lookup(), and name().
|
inline |
Return name.
Definition at line 253 of file faceZone.H.
Referenced by meshRefinement::checkCoupledFaceZones(), and fvMeshDistribute::printMeshInfo().
|
inline |
Return face flip map.
Definition at line 259 of file faceZone.H.
Referenced by repatchPolyTopoChanger::changeAnchorPoint(), repatchPolyTopoChanger::changePatchID(), faceZone::clone(), faceZoneSet::faceZoneSet(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), duplicatePoints::setRefinement(), removeCells::setRefinement(), perfectInterface::setRefinement(), edgeCollapser::setRefinement(), combineFaces::setRefinement(), addPatchCellLayer::setRefinement(), and combineFaces::setUnrefinement().
Foam::label whichFace | ( | const label | globalFaceID | ) | const |
Map storing the local face index for every global face index.
Used to find out the index of face in the zone from the known global face index. If the face is not in the zone, returns -1
Definition at line 361 of file faceZone.C.
References HashTable< T, Key, Hash >::end(), and HashTable< T, Key, Hash >::find().
Referenced by repatchPolyTopoChanger::changeAnchorPoint(), repatchPolyTopoChanger::changePatchID(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), duplicatePoints::setRefinement(), removeCells::setRefinement(), perfectInterface::setRefinement(), edgeCollapser::setRefinement(), combineFaces::setRefinement(), addPatchCellLayer::setRefinement(), and combineFaces::setUnrefinement().
const Foam::primitiveFacePatch & operator() | ( | ) | const |
Return reference to primitive patch.
Definition at line 384 of file faceZone.C.
|
inline |
Return the index of this zone in zone list.
Definition at line 273 of file faceZone.H.
Referenced by faceZone::clone().
const Foam::faceZoneMesh & zoneMesh | ( | ) | const |
Return zoneMesh reference.
Definition at line 378 of file faceZone.C.
const Foam::labelList & masterCells | ( | ) | const |
Return labels of master cells (cells next to the master face.
zone in the prescribed direction)
Definition at line 395 of file faceZone.C.
Referenced by layerAdditionRemoval::changeTopology().
const Foam::labelList & slaveCells | ( | ) | const |
Return labels of slave cells.
Definition at line 406 of file faceZone.C.
const Foam::labelList & meshEdges | ( | ) | const |
Return global edge index for local edges.
Definition at line 417 of file faceZone.C.
References mesh.
void clearAddressing | ( | ) |
Clear addressing.
Definition at line 458 of file faceZone.C.
References Foam::deleteDemandDrivenData().
Reset addressing and flip map (clearing demand-driven data)
Definition at line 471 of file faceZone.C.
References List< T >::operator=().
bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 512 of file faceZone.C.
References Foam::endl(), forAll, mesh, Foam::name(), Foam::nl, and SeriousErrorIn.
bool checkParallelSync | ( | const bool | report = false | ) | const |
Check whether all procs have faces synchronised. Return.
true if in error.
Definition at line 541 of file faceZone.C.
References polyMesh::boundaryMesh(), Foam::endl(), forAll, primitiveMesh::isInternalFace(), mesh, Foam::name(), IOobject::name(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), Foam::Pout, Foam::returnReduce(), syncTools::swapBoundaryFaceList(), and polyBoundaryMesh::whichPatch().
|
virtual |
Correct patch after moving points.
Definition at line 621 of file faceZone.C.
void updateMesh | ( | const mapPolyMesh & | mpm | ) |
Update for changes in topology.
Definition at line 482 of file faceZone.C.
References forAll, mapPolyMesh::reverseFaceMap(), and List< T >::setSize().
|
virtual |
Write.
Definition at line 629 of file faceZone.C.
References Foam::name(), and Foam::nl.
Referenced by Foam::operator<<().
|
virtual |
Write dictionary.
Definition at line 637 of file faceZone.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, Foam::type(), and UList< T >::writeEntry().