Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
cellZone Class Reference

A subset of mesh cells. More...

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

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 labelUList &addr, const label index, const cellZoneMesh &)
 Construct from components. More...
 
 cellZone (const word &name, const Xfer< labelList > &addr, const label index, const cellZoneMesh &)
 Construct from components, transferring contents. More...
 
 cellZone (const word &name, const dictionary &, const label index, const cellZoneMesh &)
 Construct from dictionary. More...
 
 cellZone (const cellZone &, const labelUList &addr, const label index, const cellZoneMesh &)
 Construct given the original zone and resetting the. More...
 
 cellZone (const cellZone &, const Xfer< labelList > &addr, const label index, const cellZoneMesh &)
 Construct given the original zone, resetting the. More...
 
virtual autoPtr< cellZoneclone (const cellZoneMesh &zm) const
 Construct and return a clone, resetting the zone mesh. More...
 
virtual autoPtr< cellZoneclone (const labelUList &addr, const label index, const cellZoneMesh &zm) const
 Construct and return a clone, resetting the cell list. More...
 
virtual ~cellZone ()
 Destructor. More...
 
label whichCell (const label globalCellID) const
 Helper function to re-direct to zone::localID(...) More...
 
const cellZoneMeshzoneMesh () 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. Return. More...
 
virtual void writeDict (Ostream &) const
 Write dictionary. More...
 
void operator= (const cellZone &)
 Assign to zone, clearing demand-driven data. More...
 
void operator= (const labelUList &)
 Assign addressing, clearing demand-driven data. More...
 
void operator= (const Xfer< labelList > &)
 Assign addressing, 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, 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 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...
 
- 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
 

Static Public Member Functions

static autoPtr< cellZoneNew (const word &name, const dictionary &, const label index, const cellZoneMesh &)
 Return a pointer to a new cell zone. 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...
 

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 &)
 Disallow default bitwise copy construct. More...
 
- Protected Member Functions inherited from zone
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

const cellZoneMeshzoneMesh_
 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

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

Detailed Description

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.

Source files

Definition at line 61 of file cellZone.H.

Constructor & Destructor Documentation

cellZone ( const cellZone )
protected

Disallow default bitwise copy construct.

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

Here is the caller graph for this function:

cellZone ( const word name,
const labelUList addr,
const label  index,
const cellZoneMesh zm 
)

Construct from components.

Definition at line 48 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

cellZone ( const word name,
const Xfer< labelList > &  addr,
const label  index,
const cellZoneMesh zm 
)

Construct from components, transferring contents.

Definition at line 61 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

cellZone ( const word name,
const dictionary dict,
const label  index,
const cellZoneMesh zm 
)

Construct from dictionary.

Definition at line 74 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

cellZone ( const cellZone cz,
const labelUList addr,
const label  index,
const cellZoneMesh zm 
)

Construct given the original zone and resetting the.

cell list and zone mesh information

Definition at line 87 of file cellZone.C.

References cellZone::cellZone().

Here is the call graph for this function:

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 99 of file cellZone.C.

~cellZone ( )
virtual

Destructor.

Definition at line 113 of file cellZone.C.

Referenced by cellZone::clone().

Here is the caller graph for this function:

Member Function Documentation

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)   
)
virtual autoPtr<cellZone> clone ( const cellZoneMesh zm) const
inlinevirtual

Construct and return a clone, resetting the zone mesh.

Definition at line 159 of file cellZone.H.

References cellZone::cellZone(), List< T >::clone(), and zone::index().

Here is the call graph for this function:

virtual autoPtr<cellZone> clone ( const labelUList addr,
const label  index,
const cellZoneMesh zm 
) const
inlinevirtual

Construct and return a clone, resetting the cell list.

and zone mesh

Definition at line 170 of file cellZone.H.

References cellZone::cellZone(), cellZone::checkDefinition(), cellZone::checkParallelSync(), cellZone::New(), cellZone::operator<<, cellZone::operator=(), cellZone::whichCell(), cellZone::writeDict(), cellZone::zoneMesh(), and cellZone::~cellZone().

Here is the call graph for this function:

Foam::autoPtr< Foam::cellZone > New ( const word name,
const dictionary dict,
const label  index,
const cellZoneMesh zm 
)
static

Return a pointer to a new cell zone.

created on freestore from dictionary

Definition at line 32 of file cellZoneNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label whichCell ( const label  globalCellID) const

Helper function to re-direct to zone::localID(...)

Definition at line 119 of file cellZone.C.

References zone::localID().

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::cellZoneMesh & zoneMesh ( ) const

Return zoneMesh reference.

Definition at line 125 of file cellZone.C.

Referenced by cellZone::clone().

Here is the caller graph for this function:

bool checkDefinition ( const bool  report = false) const
virtual

Check zone definition. Return true if in error.

Implements zone.

Definition at line 131 of file cellZone.C.

References zone::checkDefinition().

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool checkParallelSync ( const bool  report = false) const
inlinevirtual

Check whether zone is synchronised across coupled boundaries. Return.

true if in error.

Definition at line 213 of file cellZone.H.

Referenced by cellZone::clone().

Here is the caller graph for this function:

void writeDict ( Ostream os) const
virtual

Write dictionary.

Implements zone.

Definition at line 137 of file cellZone.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::name(), Foam::nl, and Foam::type().

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const cellZone zn)

Assign to zone, clearing demand-driven data.

Definition at line 150 of file cellZone.C.

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

Referenced by cellZone::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const labelUList addr)

Assign addressing, clearing demand-driven data.

Definition at line 157 of file cellZone.C.

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

Here is the call graph for this function:

void operator= ( const Xfer< labelList > &  addr)

Assign addressing, clearing demand-driven data.

Definition at line 164 of file cellZone.C.

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

Here is the call graph for this function:

Friends And Related Function Documentation

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

Ostream Operator.

Referenced by cellZone::clone().

Member Data Documentation

const cellZoneMesh& zoneMesh_
protected

Reference to zone list.

Definition at line 71 of file cellZone.H.

const char *const labelsName = "cellLabels"
static

The name associated with the zone-labels dictionary entry.

Definition at line 85 of file cellZone.H.


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