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

A cell is defined as a list of faces with extra functionality. More...

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

Public Member Functions

 cell ()
 Construct null. More...
 
 cell (label)
 Construct given size. More...
 
 cell (const labelUList &)
 Construct from list of labels. More...
 
 cell (const Xfer< labelList > &)
 Construct by transferring the parameter contents. More...
 
 cell (Istream &)
 Construct from Istream. More...
 
label nFaces () const
 Return number of faces. More...
 
labelList labels (const faceUList &) const
 Return labels of cell vertices. More...
 
pointField points (const faceUList &, const pointField &) const
 Return the cell vertices. More...
 
edgeList edges (const faceUList &) const
 Return cell edges. More...
 
label opposingFaceLabel (const label masterFaceLabel, const faceUList &meshFaces) const
 Return index of opposite face. More...
 
oppositeFace opposingFace (const label masterFaceLabel, const faceUList &meshFaces) const
 Return opposite face oriented the same way as the master face. More...
 
point centre (const pointField &, const faceUList &) const
 Returns cell centre. More...
 
scalar mag (const pointField &, const faceUList &) const
 Returns cell volume. More...
 
- Public Member Functions inherited from List< label >
label size () const
 Return the number of elements in the UList. More...
 
 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 List< label > &)
 Copy constructor. More...
 
 List (const Xfer< List< label > > &)
 Construct by transferring the parameter contents. 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 (Istream &)
 Construct from Istream. 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...
 
Xfer< List< label > > xfer ()
 Transfer contents to the Xfer container. More...
 
labelnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< label > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< label > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< label > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< label > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< label > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const label &)
 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 Attributes

static const char *const typeName = "cell"
 

Friends

bool operator== (const cell &, const cell &)
 
bool operator!= (const cell &, const cell &)
 

Additional Inherited Members

- Public Types inherited from List< label >
typedef SubList< labelsubList
 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< label >
static const List< label > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Protected Member Functions inherited from List< label >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

A cell is defined as a list of faces with extra functionality.

Source files

Definition at line 56 of file cell.H.

Constructor & Destructor Documentation

cell ( )
inline

Construct null.

Definition at line 31 of file cellI.H.

cell ( label  s)
inlineexplicit

Construct given size.

Definition at line 36 of file cellI.H.

cell ( const labelUList lst)
inlineexplicit

Construct from list of labels.

Definition at line 43 of file cellI.H.

cell ( const Xfer< labelList > &  lst)
inlineexplicit

Construct by transferring the parameter contents.

Definition at line 49 of file cellI.H.

cell ( Istream is)
inline

Construct from Istream.

Definition at line 56 of file cellI.H.

Member Function Documentation

Foam::label nFaces ( ) const
inline

Return number of faces.

Definition at line 65 of file cellI.H.

References List< label >::size().

Here is the call graph for this function:

Foam::labelList labels ( const faceUList f) const

Return labels of cell vertices.

Definition at line 35 of file cell.C.

References UList< T >::first(), forAll, found, p, cell::points(), List< T >::setSize(), List< T >::size(), and UList< T >::size().

Referenced by cell::points().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::pointField points ( const faceUList f,
const pointField meshPoints 
) const

Return the cell vertices.

Definition at line 102 of file cell.C.

References forAll, cell::labels(), p, pointLabels(), and List< T >::size().

Referenced by cell::labels(), and meshToMeshMethod::writeConnectivity().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::edgeList edges ( const faceUList f) const

Return cell edges.

Definition at line 120 of file cell.C.

References cell::centre(), forAll, and List< T >::setSize().

Referenced by layerAdditionRemoval::changeTopology().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label opposingFaceLabel ( const label  masterFaceLabel,
const faceUList meshFaces 
) const

Return index of opposite face.

Definition at line 40 of file oppositeCellFace.C.

References Foam::endl(), forAll, Foam::Info, cell::opposingFace(), and List< T >::size().

Here is the call graph for this function:

Foam::oppositeFace opposingFace ( const label  masterFaceLabel,
const faceUList meshFaces 
) const

Return opposite face oriented the same way as the master face.

Definition at line 115 of file oppositeCellFace.C.

References Foam::constant::electromagnetic::e, forAll, and List< T >::size().

Referenced by cell::opposingFaceLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::point centre ( const pointField p,
const faceUList f 
) const

Returns cell centre.

Definition at line 173 of file cell.C.

References forAll, cell::mag(), and Vector< Cmpt >::zero.

Referenced by cell::edges().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar mag ( const pointField p,
const faceUList f 
) const

Returns cell volume.

Definition at line 239 of file cell.C.

References forAll, Foam::mag(), and Vector< Cmpt >::zero.

Referenced by cell::centre().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

bool operator== ( const cell ,
const cell  
)
friend
bool operator!= ( const cell ,
const cell  
)
friend

Member Data Documentation

const char *const typeName = "cell"
static

Definition at line 65 of file cell.H.


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