Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
zone Class Referenceabstract

Base class for zones. More...

Inheritance diagram for zone:
Inheritance graph
[legend]
Collaboration diagram for zone:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("zone")
 Runtime type information. More...
 
 zone (const word &name, const labelUList &addr, const label index)
 Construct from components. More...
 
 zone (const word &name, const Xfer< labelList > &addr, const label index)
 Construct from components, transferring 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 &, const Xfer< labelList > &addr, const label index)
 Construct given the original zone, resetting the. 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...
 
virtual void clearAddressing ()
 Clear addressing. More...
 
virtual bool checkDefinition (const bool report=false) const =0
 Check zone definition. Return true if in error. 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 &)
 Correct patch after moving points. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void writeDict (Ostream &) const =0
 Write dictionary. More...
 
- Public Member Functions inherited from List< T >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const T &)
 Construct with given size and value for all elements. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< T > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
label size () const
 Return the number of elements in the UList. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const T &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const T &)
 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 T &)
 Append an element at the end of the list. More...
 
void append (const UList< T > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< T > &)
 Transfer the contents of the argument List into this list. More...
 
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. 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 Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the 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...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return 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 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...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () 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< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
template<>
const bool & operator[] (const label i) const
 

Protected Member Functions

const Map< label > & lookupMap () const
 Return a reference to the look-up map. More...
 
void calcLookupMap () const
 Construct the look-up map. More...
 
 zone (const zone &)
 Disallow default bitwise copy construct. More...
 
- Protected Member Functions inherited from List< T >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Protected Attributes

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 zone &)
 Ostream Operator. More...
 

Additional Inherited Members

- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_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 Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 

Detailed Description

Base class for zones.

Source files

Definition at line 57 of file zone.H.

Constructor & Destructor Documentation

zone ( const zone )
protected

Disallow default bitwise copy construct.

Referenced by zone::calcLookupMap(), and zone::zone().

Here is the caller graph for this function:

zone ( const word name,
const labelUList addr,
const label  index 
)

Construct from components.

Definition at line 90 of file zone.C.

References zone::zone().

Here is the call graph for this function:

zone ( const word name,
const Xfer< labelList > &  addr,
const label  index 
)

Construct from components, transferring contents.

Definition at line 104 of file zone.C.

References zone::zone().

Here is the call graph for this function:

zone ( const word name,
const dictionary dict,
const word labelsName,
const label  index 
)

Construct from dictionary.

Definition at line 118 of file zone.C.

References zone::zone().

Here is the call graph for this function:

zone ( const zone z,
const labelUList addr,
const label  index 
)

Construct given the original zone and resetting the.

cell list and zone mesh information

Definition at line 133 of file zone.C.

References zone::zone().

Here is the call graph for this function:

zone ( const zone z,
const Xfer< labelList > &  addr,
const label  index 
)

Construct given the original zone, resetting the.

cell list and zone mesh information

Definition at line 147 of file zone.C.

~zone ( )
virtual

Destructor.

Definition at line 162 of file zone.C.

Member Function Documentation

const Foam::Map< Foam::label > & lookupMap ( ) const
protected

Return a reference to the look-up map.

Definition at line 41 of file zone.C.

void calcLookupMap ( ) const
protected

Construct the look-up map.

Definition at line 52 of file zone.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, Foam::Info, HashTable< T, label, Hash< label > >::insert(), Foam::nl, List< T >::size(), and zone::zone().

Here is the call graph for this function:

TypeName ( "zone"  )

Runtime type information.

const word& name ( ) const
inline

Return name.

Definition at line 150 of file zone.H.

References zone::localID(), and zone::name_.

Referenced by meshRefinement::checkCoupledFaceZones(), NamedEnum< Enum, nEnum >::names(), fvMeshDistribute::printMeshInfo(), FacePostProcessing< CloudType >::write(), and meshRefinement::zonify().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label localID ( const label  globalID) const

Map storing the local index for every global index. Used to find.

the index of the item in the zone from the known global index. If the item is not in the zone, returns -1

Definition at line 170 of file zone.C.

References HashTableCore::end(), and HashTable< T, Key, Hash >::find().

Referenced by zone::name(), cellZone::whichCell(), faceZone::whichFace(), and pointZone::whichPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

label index ( ) const
inline

Return the index of this zone in zone list.

Definition at line 161 of file zone.H.

References zone::checkDefinition(), zone::clearAddressing(), and zone::index_.

Referenced by pointZone::clone(), cellZone::clone(), and faceZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void clearAddressing ( )
virtual

Clear addressing.

Reimplemented in faceZone.

Definition at line 187 of file zone.C.

References Foam::deleteDemandDrivenData().

Referenced by faceZone::clearAddressing(), and zone::index().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool checkDefinition ( const bool  report = false) const
pure virtual

Check zone definition. Return true if in error.

Implemented in faceZone, cellZone, and pointZone.

Referenced by pointZone::checkDefinition(), cellZone::checkDefinition(), faceZone::checkDefinition(), and zone::index().

Here is the caller graph for this function:

bool checkDefinition ( const label  maxSize,
const bool  report = false 
) const
virtual

Check zone definition with max size given. Return true if in error.

Definition at line 193 of file zone.C.

References Foam::endl(), forAll, HashSet< Key, Hash >::insert(), Foam::nl, SeriousErrorIn, and WarningIn.

Here is the call graph for this function:

virtual void movePoints ( const pointField )
inlinevirtual

Correct patch after moving points.

Reimplemented in faceZone, and pointZone.

Definition at line 180 of file zone.H.

References zone::operator<<, zone::write(), and zone::writeDict().

Here is the call graph for this function:

void write ( Ostream os) const
virtual

Write.

Reimplemented in faceZone.

Definition at line 243 of file zone.C.

References Foam::nl.

Referenced by zone::movePoints(), and Foam::operator<<().

Here is the caller graph for this function:

virtual void writeDict ( Ostream ) const
pure virtual

Write dictionary.

Implemented in faceZone, cellZone, and pointZone.

Referenced by zone::movePoints().

Here is the caller graph for this function:

Friends And Related Function Documentation

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

Ostream Operator.

Referenced by zone::movePoints().

Member Data Documentation

word name_
protected

Name of zone.

Definition at line 67 of file zone.H.

Referenced by zone::name().

label index_
protected

Index of zone.

Definition at line 70 of file zone.H.

Referenced by zone::index().

Map<label>* lookupMapPtr_
mutableprotected

Map of labels in zone for fast location lookup.

Definition at line 76 of file zone.H.


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