A subset of mesh cells. More...
Public Member Functions | |
TypeName ("cellZone") | |
Runtime type information. More... | |
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 label index, const cellZoneMesh &zm) | |
Construct an empty zone. More... | |
cellZone (const word &name, const labelUList &addr, const label index, const cellZoneMesh &zm) | |
Construct from components. More... | |
cellZone (const word &name, labelList &&addr, const label index, const cellZoneMesh &zm) | |
Construct from components, transferring addressing. More... | |
cellZone (const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm) | |
Construct from dictionary. More... | |
cellZone (const cellZone &origZone, const labelUList &addr, const label index, const cellZoneMesh &zm) | |
cellZone (const cellZone &origZone, labelList &&addr, const label index, const cellZoneMesh &zm) | |
virtual autoPtr< cellZone > | clone (const cellZoneMesh &zm) const |
Construct and return a clone, resetting the zone mesh. More... | |
virtual autoPtr< cellZone > | clone (const labelUList &addr, const label index, const cellZoneMesh &zm) const |
virtual | ~cellZone ()=default |
Destructor. More... | |
label | whichCell (const label globalCellID) const |
Helper function to re-direct to zone::localID(...) More... | |
const cellZoneMesh & | zoneMesh () const |
Return zoneMesh reference. 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 zone is synchronised across coupled boundaries. More... | |
virtual void | writeDict (Ostream &os) const |
Write dictionary. More... | |
void | operator= (const cellZone &zn) |
Assign to zone, clearing demand-driven data. More... | |
void | operator= (const labelUList &addr) |
Assign addressing, clearing demand-driven data. More... | |
void | operator= (labelList &&addr) |
Move assign addressing, clearing demand-driven data. More... | |
Public Member Functions inherited from zone | |
TypeName ("zone") | |
Runtime type information. More... | |
zone (const word &name, const label index) | |
Construct an empty zone. More... | |
zone (const word &name, const labelUList &addr, const label index) | |
Copy construct from components. More... | |
zone (const word &name, labelList &&addr, const label index) | |
Move construct from components. More... | |
zone (const word &name, const dictionary &dict, const word &labelsName, const label index) | |
Construct from dictionary. More... | |
zone (const zone &origZone, const labelUList &addr, const label index) | |
zone (const zone &origZone, labelList &&addr, const label index) | |
virtual | ~zone () |
Destructor. More... | |
const word & | name () 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 void | clearAddressing () |
Clear addressing. 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... | |
virtual void | movePoints (const pointField &pts) |
Correct patch after moving points. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
Public Member Functions inherited from List< T > | |
constexpr | List () noexcept |
Null constructor. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const T &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const T &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, T &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< T > &a) | |
Copy construct from list. More... | |
List (const UList< T > &a) | |
Copy construct contents from list. More... | |
List (List< T > &a, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< T > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
template<unsigned N> | |
List (const UList< T > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
template<class InputIterator > | |
List (InputIterator begIter, InputIterator endIter) | |
Construct given begin/end iterators. More... | |
template<unsigned N> | |
List (const FixedList< T, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< T > &list) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< T > &list) | |
Construct as copy of SLList<T> More... | |
template<class Addr > | |
List (const IndirectListBase< T, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< T > list) | |
Construct from an initializer list. More... | |
List (List< T > &&list) | |
Move construct from List. More... | |
template<int SizeMin> | |
List (DynamicList< T, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (SortableList< T > &&list) | |
Move construct from SortableList. More... | |
List (SLList< T > &&list) | |
Move construct from SLList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< T > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | resize (const label newSize) |
Adjust allocated size of list. More... | |
void | resize (const label newSize, const T &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | setSize (const label newSize) |
Alias for resize(const label) More... | |
void | setSize (const label newSize, const T &val) |
Alias for resize(const label, const T&) More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | append (const T &val) |
Append an element at the end of the list. More... | |
void | append (T &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< T > &list) |
Append a List to the end of this list. More... | |
template<class Addr > | |
void | append (const IndirectListBase< T, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
void | transfer (List< T > &list) |
template<int SizeMin> | |
void | transfer (DynamicList< T, SizeMin > &list) |
void | transfer (SortableList< T > &list) |
T & | newElmt (const label i) |
void | operator= (const UList< T > &a) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< T > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const SLList< T > &list) |
Assignment to SLList operator. Takes linear time. More... | |
template<class Addr > | |
void | operator= (const IndirectListBase< T, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
template<unsigned N> | |
void | operator= (const FixedList< T, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< T > list) |
Assignment to an initializer list. More... | |
void | operator= (const T &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< T > &&list) |
Move assignment. Takes constant time. More... | |
template<int SizeMin> | |
void | operator= (DynamicList< T, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SortableList< T > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SLList< T > &&list) |
Move assignment. Takes constant time. More... | |
void | shallowCopy (const UList< T > &)=delete |
No shallowCopy permitted. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
template<> | |
void | resize (const label newSize) |
Static Public Member Functions | |
static autoPtr< cellZone > | New (const word &name, const dictionary &dict, const label index, const cellZoneMesh &zm) |
Static Public Member Functions inherited from List< T > | |
static const List< T > & | null () |
Return a null List. More... | |
Static Public Attributes | |
static const char *const | labelsName = "cellLabels" |
The name associated with the zone-labels dictionary entry. More... | |
Protected Member Functions | |
cellZone (const cellZone &)=delete | |
No copy construct. More... | |
Protected Member Functions inherited from zone | |
void | calcLookupMap () const |
Construct the look-up map. More... | |
Protected Attributes | |
const cellZoneMesh & | zoneMesh_ |
Reference to zone list. 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 | |
Ostream & | operator<< (Ostream &os, const cellZone &zn) |
Ostream Operator. More... | |
Additional Inherited Members | |
Public Types inherited from List< T > | |
typedef SubList< T > | subList |
Declare type of subList. 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 cellZoneMesh, where all the zoned cells are registered with their zone number.
Definition at line 62 of file cellZone.H.
cellZone | ( | const word & | name, |
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct an empty zone.
Definition at line 52 of file cellZone.C.
cellZone | ( | const word & | name, |
const labelUList & | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct from components.
Definition at line 64 of file cellZone.C.
cellZone | ( | const word & | name, |
labelList && | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct from components, transferring addressing.
Definition at line 77 of file cellZone.C.
cellZone | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct from dictionary.
Definition at line 90 of file cellZone.C.
cellZone | ( | const cellZone & | origZone, |
const labelUList & | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct given the original zone (name is used), and resetting the cell list and zone mesh information
Definition at line 103 of file cellZone.C.
cellZone | ( | const cellZone & | origZone, |
labelList && | addr, | ||
const label | index, | ||
const cellZoneMesh & | zm | ||
) |
Construct with a new index and zone mesh information, the name of the original zone, resetting the cell addressing.
Definition at line 116 of file cellZone.C.
|
virtualdefault |
Destructor.
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 163 of file cellZone.H.
References zone::index(), and autoPtr< T >::New().
|
inlinevirtual |
Construct and return a clone, resetting the cell list and zone mesh
Definition at line 171 of file cellZone.H.
References zone::index(), and autoPtr< T >::New().
|
static |
Return a pointer to a new cell zone created on freestore from dictionary
Definition at line 35 of file cellZoneNew.C.
References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::name().
Foam::label whichCell | ( | const label | globalCellID | ) | const |
Helper function to re-direct to zone::localID(...)
Definition at line 130 of file cellZone.C.
References zone::localID().
const Foam::cellZoneMesh & zoneMesh | ( | ) | const |
Return zoneMesh reference.
Definition at line 136 of file cellZone.C.
Check zone definition. Return true if in error.
Implements zone.
Definition at line 142 of file cellZone.C.
References zone::checkDefinition().
Check whether zone is synchronised across coupled boundaries.
Definition at line 211 of file cellZone.H.
|
virtual |
Write dictionary.
Implements zone.
Definition at line 148 of file cellZone.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, and Foam::type().
void operator= | ( | const cellZone & | zn | ) |
Assign to zone, clearing demand-driven data.
Definition at line 161 of file cellZone.C.
References List< label >::operator=().
void operator= | ( | const labelUList & | addr | ) |
Assign addressing, clearing demand-driven data.
Definition at line 168 of file cellZone.C.
References List< label >::operator=().
void operator= | ( | labelList && | addr | ) |
Move assign addressing, clearing demand-driven data.
Definition at line 175 of file cellZone.C.
References List< label >::transfer().
|
protected |
Reference to zone list.
Definition at line 71 of file cellZone.H.
|
static |
The name associated with the zone-labels dictionary entry.
Definition at line 85 of file cellZone.H.