faceZone Class Reference

A subset of mesh faces organised as a primitive patch. More...

Inheritance diagram for faceZone:
Collaboration diagram for faceZone:

Public Member Functions

 TypeName ("faceZone")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, faceZone, dictionary,(const word &name, const dictionary &dict, const label index, const meshFaceZones &mz),(name, dict, index, mz))
 
 faceZone (const word &name, const labelUList &addr, const boolList &fm, const label index, const meshFaceZones &mz)
 Construct from components. More...
 
 faceZone (const word &name, labelList &&addr, boolList &&fm, const label index, const meshFaceZones &)
 Construct from components, moving contents. More...
 
 faceZone (const word &name, const dictionary &, const label index, const meshFaceZones &)
 Construct from dictionary. More...
 
 faceZone (const faceZone &, const labelUList &addr, const boolList &fm, const label index, const meshFaceZones &)
 Construct given the original zone and resetting the. More...
 
 faceZone (const faceZone &, labelList &&addr, boolList &&fm, const label index, const meshFaceZones &)
 Construct given the original zone, resetting the. More...
 
 faceZone (const faceZone &)=delete
 Disallow default bitwise copy construction. More...
 
virtual autoPtr< faceZoneclone (const meshFaceZones &mz) const
 Construct and return a clone, resetting the mesh zones. More...
 
virtual autoPtr< faceZoneclone (const labelUList &addr, const boolList &fm, const label index, const meshFaceZones &mz) const
 Construct and return a clone, resetting the face list. More...
 
virtual ~faceZone ()
 Destructor. More...
 
const boolListflipMap () const
 Return face flip map. More...
 
label whichFace (const label globalCellID) const
 Helper function to re-direct to zone::localID(...) More...
 
const primitiveFacePatchoperator() () const
 Return reference to primitive patch. More...
 
const meshFaceZonesmeshZones () const
 Return meshZones reference. More...
 
const labelListmasterCells () const
 Return labels of master cells (cells next to the master face. More...
 
const labelListslaveCells () const
 Return labels of slave cells. More...
 
const labelListmeshEdges () 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...
 
virtual bool checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error. More...
 
virtual bool checkParallelSync (const bool report=false) const
 Check whether all procs have faces synchronised. Return. More...
 
virtual void movePoints (const pointField &)
 Correct patch after moving points. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void write (Ostream &) const
 Write. 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...
 
- Public Member Functions inherited from zone
 TypeName ("zone")
 Runtime type information. More...
 
 zone (const word &name, const labelUList &addr, const label index)
 Construct from components. More...
 
 zone (const word &name, labelList &&addr, const label index)
 Construct from components, moving contents. More...
 
 zone (const word &name, const dictionary &, const word &labelsName, const label index)
 Construct from dictionary. More...
 
 zone (const zone &, const labelUList &addr, const label index)
 Construct given the original zone and resetting the. More...
 
 zone (const zone &, labelList &&addr, const label index)
 Construct given the original zone, resetting the. More...
 
 zone (const zone &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~zone ()
 Destructor. More...
 
const wordname () const
 Return name. More...
 
label localID (const label globalID) const
 Map storing the local index for every global index. Used to find. More...
 
label index () const
 Return the index of this zone in zone list. More...
 
const Map< label > & lookupMap () const
 Return a reference to the look-up map. More...
 
virtual bool checkDefinition (const label maxSize, const bool report=false) const
 Check zone definition with max size given. Return true if in error. More...
 
void operator= (const zone &)
 Assignment operator. More...
 
void operator= (zone &&)
 Move assignment operator. More...
 
void operator= (const labelUList &)
 Assignment operator to addressing. More...
 
void operator= (labelList &&)
 Move assignment of addressing. 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...
 

Static Public Member Functions

static autoPtr< faceZoneNew (const word &name, const dictionary &, const label index, const meshFaceZones &)
 Return a pointer to a new face 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...
 

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...
 
- Protected Member Functions inherited from zone
void calcLookupMap () const
 Construct the look-up map. More...
 
- Protected Member Functions inherited from List< label >
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...
 
const meshFaceZonesmeshZones_
 Reference to zone list. More...
 
primitiveFacePatchpatchPtr_
 Primitive patch made out of correctly flipped faces. More...
 
labelListmasterCellsPtr_
 Master cell layer. More...
 
labelListslaveCellsPtr_
 Slave cell layer. More...
 
labelListmePtr_
 Global edge addressing. More...
 
- Protected Attributes inherited from zone
word name_
 Name of zone. More...
 
label index_
 Index of zone. More...
 
Map< label > * lookupMapPtr_
 Map of labels in zone for fast location lookup. More...
 

Friends

Ostreamoperator<< (Ostream &, const faceZone &)
 Ostream Operator. 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...
 

Detailed Description

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 meshFaceZones, where all the zoned faces are registered with their zone number.

Source files

Definition at line 65 of file faceZone.H.

Constructor & Destructor Documentation

◆ faceZone() [1/6]

faceZone ( const word name,
const labelUList addr,
const boolList fm,
const label  index,
const meshFaceZones mz 
)

Construct from components.

Definition at line 187 of file faceZone.C.

References faceZone::checkAddressing().

Referenced by faceZone::clone().

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

◆ faceZone() [2/6]

faceZone ( const word name,
labelList &&  addr,
boolList &&  fm,
const label  index,
const meshFaceZones mz 
)

Construct from components, moving contents.

Definition at line 208 of file faceZone.C.

References faceZone::checkAddressing().

Here is the call graph for this function:

◆ faceZone() [3/6]

faceZone ( const word name,
const dictionary dict,
const label  index,
const meshFaceZones mz 
)

Construct from dictionary.

Definition at line 229 of file faceZone.C.

References faceZone::checkAddressing().

Here is the call graph for this function:

◆ faceZone() [4/6]

faceZone ( const faceZone fz,
const labelUList addr,
const boolList fm,
const label  index,
const meshFaceZones mz 
)

Construct given the original zone and resetting the.

face list and mesh zones information

Definition at line 249 of file faceZone.C.

References faceZone::checkAddressing().

Here is the call graph for this function:

◆ faceZone() [5/6]

faceZone ( const faceZone fz,
labelList &&  addr,
boolList &&  fm,
const label  index,
const meshFaceZones mz 
)

Construct given the original zone, resetting the.

face list and mesh zones information

Definition at line 270 of file faceZone.C.

References faceZone::checkAddressing().

Here is the call graph for this function:

◆ faceZone() [6/6]

faceZone ( const faceZone )
delete

Disallow default bitwise copy construction.

◆ ~faceZone()

~faceZone ( )
virtual

Destructor.

Definition at line 293 of file faceZone.C.

Member Function Documentation

◆ calcFaceZonePatch()

void calcFaceZonePatch ( ) const
protected

◆ faceLookupMap()

const Map<label>& faceLookupMap ( ) const
protected

Return map of local face indices.

◆ calcCellLayers()

void calcCellLayers ( ) const
protected

Calculate master and slave face layer.

Definition at line 97 of file faceZone.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, InfoInFunction, and List< T >::size().

Here is the call graph for this function:

◆ checkAddressing()

void checkAddressing ( ) const
protected

Check addressing.

Definition at line 156 of file faceZone.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, List< T >::size(), and WarningInFunction.

Referenced by faceZone::faceZone().

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

◆ TypeName()

TypeName ( "faceZone"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
faceZone  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const meshFaceZones &mz)  ,
(name, dict, index, mz)   
)

◆ clone() [1/2]

virtual autoPtr<faceZone> clone ( const meshFaceZones mz) const
inlinevirtual

Construct and return a clone, resetting the mesh zones.

Definition at line 204 of file faceZone.H.

References faceZone::faceZone(), faceZone::flipMap(), and zone::index().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<faceZone> clone ( const labelUList addr,
const boolList fm,
const label  index,
const meshFaceZones mz 
) const
inlinevirtual

Construct and return a clone, resetting the face list.

and mesh zones

Definition at line 214 of file faceZone.H.

◆ New()

Foam::autoPtr< Foam::faceZone > New ( const word name,
const dictionary dict,
const label  index,
const meshFaceZones mz 
)
static

Return a pointer to a new face zone.

created on freestore from dictionary

Definition at line 31 of file faceZoneNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, zone::index(), InfoInFunction, zone::name(), and Foam::nl.

Here is the call graph for this function:

◆ flipMap()

◆ whichFace()

◆ operator()()

const Foam::primitiveFacePatch & operator() ( ) const

Return reference to primitive patch.

Definition at line 313 of file faceZone.C.

◆ meshZones()

const Foam::meshFaceZones & meshZones ( ) const

Return meshZones reference.

Definition at line 301 of file faceZone.C.

Referenced by faceZone::calcFaceZonePatch().

Here is the caller graph for this function:

◆ masterCells()

const Foam::labelList & masterCells ( ) const

Return labels of master cells (cells next to the master face.

zone in the prescribed direction)

Definition at line 324 of file faceZone.C.

Referenced by layerAdditionRemoval::changeTopology().

Here is the caller graph for this function:

◆ slaveCells()

const Foam::labelList & slaveCells ( ) const

Return labels of slave cells.

Definition at line 335 of file faceZone.C.

◆ meshEdges()

const Foam::labelList & meshEdges ( ) const

Return global edge index for local edges.

Definition at line 346 of file faceZone.C.

◆ clearAddressing()

void clearAddressing ( )
virtual

Clear addressing.

Reimplemented from zone.

Definition at line 365 of file faceZone.C.

References zone::clearAddressing(), and Foam::deleteDemandDrivenData().

Here is the call graph for this function:

◆ resetAddressing()

void resetAddressing ( const labelUList addr,
const boolList flipMap 
)
virtual

Reset addressing and flip map (clearing demand-driven data)

Definition at line 378 of file faceZone.C.

References List< label >::operator=().

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool  report = false) const
virtual

Check zone definition. Return true if in error.

Implements zone.

Definition at line 426 of file faceZone.C.

References zone::checkDefinition().

Here is the call graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool  report = false) const
virtual

Check whether all procs have faces synchronised. Return.

true if in error.

Definition at line 432 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().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const pointField p)
virtual

Correct patch after moving points.

Reimplemented from zone.

Definition at line 521 of file faceZone.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)
virtual

Update topology using the given map.

Definition at line 390 of file faceZone.C.

References Foam::faceMap(), forAll, polyTopoChangeMap::reverseFaceMap(), and List< T >::setSize().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap )
virtual

Update from another mesh using the given map.

Definition at line 420 of file faceZone.C.

References NotImplemented.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from zone.

Definition at line 529 of file faceZone.C.

References Foam::name(), and Foam::nl.

Referenced by Foam::operator<<().

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

◆ writeDict()

void writeDict ( Ostream os) const
virtual

Write dictionary.

Implements zone.

Definition at line 537 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().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const faceZone zn)

Assignment to zone, clearing demand-driven data.

Definition at line 551 of file faceZone.C.

References faceZone::flipMap_, and zone::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( faceZone &&  zn)

Move assignment to zone, clearing demand-driven data.

Definition at line 559 of file faceZone.C.

References zone::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const faceZone  
)
friend

Ostream Operator.

Member Data Documentation

◆ flipMap_

boolList flipMap_
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 81 of file faceZone.H.

Referenced by faceZone::flipMap(), and faceZone::operator=().

◆ meshZones_

const meshFaceZones& meshZones_
protected

Reference to zone list.

Definition at line 84 of file faceZone.H.

◆ patchPtr_

primitiveFacePatch* patchPtr_
mutableprotected

Primitive patch made out of correctly flipped faces.

Definition at line 90 of file faceZone.H.

Referenced by faceZone::calcFaceZonePatch().

◆ masterCellsPtr_

labelList* masterCellsPtr_
mutableprotected

Master cell layer.

Definition at line 93 of file faceZone.H.

◆ slaveCellsPtr_

labelList* slaveCellsPtr_
mutableprotected

Slave cell layer.

Definition at line 96 of file faceZone.H.

◆ mePtr_

labelList* mePtr_
mutableprotected

Global edge addressing.

Definition at line 99 of file faceZone.H.

◆ labelsName

const char *const labelsName = "faceLabels"
static

The name associated with the zone-labels dictionary entry.

Definition at line 122 of file faceZone.H.


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