A subset of mesh cells. More...
#include <OpenFOAM/cellZone.H>
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 cellZoneMesh, where all the zoned cells are registered with their zone number.
Definition at line 66 of file cellZone.H.
Public Member Functions | |
TypeName ("cellZone") | |
Runtime type information. | |
declareRunTimeSelectionTable (autoPtr, cellZone, dictionary,(const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm),(name, dict, index, zm)) | |
cellZone (const word &name, const labelList &addr, const label index, const cellZoneMesh &) | |
Construct from components. | |
cellZone (const word &name, const Xfer< labelList > &addr, const label index, const cellZoneMesh &) | |
Construct from components, transferring contents. | |
cellZone (const word &name, const dictionary &, const label index, const cellZoneMesh &) | |
Construct from dictionary. | |
cellZone (const cellZone &, const labelList &addr, const label index, const cellZoneMesh &) | |
Construct given the original zone and resetting the. | |
cellZone (const cellZone &, const Xfer< labelList > &addr, const label index, const cellZoneMesh &) | |
Construct given the original zone, resetting the. | |
virtual autoPtr< cellZone > | clone (const cellZoneMesh &zm) const |
Construct and return a clone, resetting the zone mesh. | |
virtual autoPtr< cellZone > | clone (const labelList &addr, const label index, const cellZoneMesh &zm) const |
Construct and return a clone, resetting the cell list. | |
virtual | ~cellZone () |
Destructor. | |
const word & | name () const |
Return name. | |
label | whichCell (const label globalCellID) const |
Map storing the local cell index for every global cell. | |
label | index () const |
Return the index of this zone in zone list. | |
const cellZoneMesh & | zoneMesh () const |
Return zoneMesh reference. | |
void | clearAddressing () |
Clear addressing. | |
bool | checkDefinition (const bool report=false) const |
Check zone definition. Return true if in error. | |
virtual void | movePoints (const pointField &) |
Correct patch after moving points. | |
virtual void | write (Ostream &) const |
Write. | |
virtual void | writeDict (Ostream &) const |
Write dictionary. | |
void | operator= (const cellZone &) |
Assign to zone clearing demand-driven data. | |
void | operator= (const labelList &) |
Assign addressing clearing demand-driven data. | |
![]() | |
List () | |
Null constructor. | |
List (const label) | |
Construct with given size. | |
List (const label, const T &) | |
Construct with given size and value for all elements. | |
List (const List< T > &) | |
Copy constructor. | |
List (const Xfer< List< T > > &) | |
Construct by transferring the parameter contents. | |
List (List< T > &, bool reUse) | |
Construct as copy or re-use as specified. | |
List (const UList< T > &, const unallocLabelList &mapAddressing) | |
Construct as subset. | |
template<class InputIterator > | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. | |
template<unsigned Size> | |
List (const FixedList< T, Size > &) | |
Construct as copy of FixedList<T, Size> | |
List (const PtrList< T > &) | |
Construct as copy of PtrList<T> | |
List (const SLList< T > &) | |
Construct as copy of SLList<T> | |
List (const IndirectList< T > &) | |
Construct as copy of IndirectList<T> | |
List (const UIndirectList< T > &) | |
Construct as copy of UIndirectList<T> | |
List (const BiIndirectList< T > &) | |
Construct as copy of BiIndirectList<T> | |
List (Istream &) | |
Construct from Istream. | |
autoPtr< List< T > > | clone () const |
Clone. | |
~List () | |
label | size () const |
Return the number of elements in the UList. | |
void | resize (const label) |
Reset size of List. | |
void | resize (const label, const T &) |
Reset size of List and value for new elements. | |
void | setSize (const label) |
Reset size of List. | |
void | setSize (const label, const T &) |
Reset size of List and value for new elements. | |
void | clear () |
Clear the list, i.e. set size to zero. | |
void | append (const UList< T > &) |
Append a List at the end of this list. | |
void | append (const UIndirectList< T > &) |
Append a UIndirectList at the end of this list. | |
void | transfer (List< T > &) |
Transfer the contents of the argument List into this list. | |
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv> | |
void | transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (SortableList< T > &) |
Transfer the contents of the argument List into this list. | |
Xfer< List< T > > | xfer () |
Transfer contents to the Xfer container. | |
T & | newElmt (const label) |
Return subscript-checked element of UList. | |
void | operator= (const UList< T > &) |
Assignment from UList operator. Takes linear time. | |
void | operator= (const List< T > &) |
Assignment operator. Takes linear time. | |
void | operator= (const SLList< T > &) |
Assignment from SLList operator. Takes linear time. | |
void | operator= (const IndirectList< T > &) |
Assignment from IndirectList operator. Takes linear time. | |
void | operator= (const UIndirectList< T > &) |
Assignment from UIndirectList operator. Takes linear time. | |
void | operator= (const BiIndirectList< T > &) |
Assignment from BiIndirectList operator. Takes linear time. | |
void | operator= (const T &) |
Assignment of all entries to the given value. | |
![]() | |
UList () | |
Null constructor. | |
UList (T *__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 T * | cdata () const |
Return a const pointer to the first data element,. | |
T * | 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< T > &) |
Assign elements to those from UList. | |
T & | operator[] (const label) |
Return element of UList. | |
const T & | operator[] (const label) const |
Return element of constant UList. | |
operator const Foam::List< T > & () const | |
Allow cast to a const List<T>&. | |
iterator | begin () |
Return an iterator to begin traversing the UList. | |
iterator | end () |
Return an iterator to end traversing the 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. | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. | |
reverse_iterator | rend () |
Return 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. | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | rend () 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< T > &) |
Swap two ULists of the same type in constant time. | |
bool | operator== (const UList< T > &) const |
Equality operation on ULists of the same type. | |
bool | operator!= (const UList< T > &) const |
The opposite of the equality operation. Takes linear time. | |
bool | operator< (const UList< T > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator> (const UList< T > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator<= (const UList< T > &) const |
Return true if !(a > b). Takes linear time. | |
bool | operator>= (const UList< T > &) const |
Return true if !(a < b). Takes linear time. | |
template<> | |
const bool & | operator[] (const label i) const |
Static Public Member Functions | |
static autoPtr< cellZone > | New (const word &name, const dictionary &, const label index, const cellZoneMesh &) |
Return a pointer to a new cell zone. | |
![]() | |
static const List< T > & | null () |
Return a null List. |
Friends | |
Ostream & | operator<< (Ostream &, const cellZone &) |
Additional Inherited Members | |
![]() | |
typedef SubList< T > | subList |
Declare type of subList. | |
![]() | |
typedef T | value_type |
Type of values the UList contains. | |
typedef T & | reference |
Type that can be used for storing into. | |
typedef const T & | 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 T * | iterator |
Random access iterator for traversing UList. | |
typedef const T * | const_iterator |
Random access iterator for traversing UList. | |
typedef T * | reverse_iterator |
Reverse iterator for reverse traversal of UList. | |
typedef const T * | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. | |
![]() | |
void | size (const label) |
Override size to be inconsistent with allocated storage. |
cellZone | ( | const word & | name, |
const labelList & | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct from components.
Definition at line 101 of file cellZone.C.
cellZone | ( | const word & | name, |
const Xfer< labelList > & | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct from components, transferring contents.
Definition at line 117 of file cellZone.C.
cellZone | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct from dictionary.
Definition at line 134 of file cellZone.C.
cellZone | ( | const cellZone & | cz, |
const labelList & | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct given the original zone and resetting the.
cell list and zone mesh information
Definition at line 152 of file cellZone.C.
cellZone | ( | const cellZone & | cz, |
const Xfer< labelList > & | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct given the original zone, resetting the.
cell list and zone mesh information
Definition at line 167 of file cellZone.C.
|
virtual |
Destructor.
Definition at line 184 of file cellZone.C.
TypeName | ( | "cellZone" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
cellZone | , | ||
dictionary | , | ||
(const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm) | , | ||
(name, dict, index, zm) | |||
) |
|
inlinevirtual |
Construct and return a clone, resetting the zone mesh.
Definition at line 172 of file cellZone.H.
References cellZone::index().
|
inlinevirtual |
Construct and return a clone, resetting the cell list.
and zone mesh
Definition at line 183 of file cellZone.H.
|
static |
Return a pointer to a new cell zone.
created on freestore from dictionary
Definition at line 36 of file newCellZone.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, dictionary::lookup(), and name().
|
inline |
Return name.
Definition at line 217 of file cellZone.H.
Referenced by fvMeshDistribute::printMeshInfo().
Foam::label whichCell | ( | const label | globalCellID | ) | const |
Map storing the local cell index for every global cell.
index. Used to find out the index of cell in the zone from the known global cell index. If the cell is not in the zone, returns -1
Definition at line 192 of file cellZone.C.
References HashTable< T, Key, Hash >::end(), and HashTable< T, Key, Hash >::find().
|
inline |
Return the index of this zone in zone list.
Definition at line 229 of file cellZone.H.
Referenced by cellZone::clone().
const Foam::cellZoneMesh & zoneMesh | ( | ) | const |
Return zoneMesh reference.
Definition at line 209 of file cellZone.C.
void clearAddressing | ( | ) |
Clear addressing.
Definition at line 215 of file cellZone.C.
References Foam::deleteDemandDrivenData().
bool checkDefinition | ( | const bool | report = false | ) | const |
Check zone definition. Return true if in error.
Definition at line 221 of file cellZone.C.
References Foam::endl(), forAll, Foam::name(), Foam::nl, and SeriousErrorIn.
|
inlinevirtual |
Correct patch after moving points.
Definition at line 244 of file cellZone.H.
|
virtual |
Write.
Definition at line 250 of file cellZone.C.
References Foam::name(), and Foam::nl.
Referenced by Foam::operator<<().
|
virtual |
Write dictionary.
Definition at line 257 of file cellZone.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, and Foam::type().
Assign to zone clearing demand-driven data.
Definition at line 270 of file cellZone.C.
References List< T >::operator=().
Assign addressing clearing demand-driven data.
Definition at line 277 of file cellZone.C.
References List< T >::operator=().