cell Class Reference

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

Inheritance diagram for cell:
Collaboration diagram for cell:

Public Member Functions

 cell ()
 Construct null. More...
 
 cell (label)
 Construct given size. More...
 
 cell (const labelUList &)
 Construct from list of labels. More...
 
 cell (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...
 
boundBox bb (const pointField &, const faceUList &) const
 Returns the cell bounding box. More...
 
void operator= (labelList &&)
 Move assignment labelList. More...
 
- Public Member Functions inherited from List< label >
 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 label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< label > &)
 Copy constructor. More...
 
 List (const UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< label > &&)
 Move constructor. More...
 
 List (List< label > &, bool reuse)
 Construct as copy or reuse 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 (std::initializer_list< label >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
label size () const
 Return the number of elements in the UList. 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...
 
labelnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< label > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< label > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< label > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< label > &&)
 Move assignment operator. More...
 
void operator= (const SLList< label > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< label > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< label > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< label >)
 Assignment to an initialiser list. More...
 
void operator= (const label &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
- Public Member Functions inherited from UList< label >
void operator= (const label &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
 UList ()
 Null constructor. More...
 
 UList (label *__restrict__ v, label size)
 Construct from components. More...
 
 UList (const UList< label > &)=default
 Copy construct. 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 labelcdata () const
 Return a const pointer to the first data element,. More...
 
labeldata ()
 Return a pointer to the first data element,. More...
 
labelfirst ()
 Return the first element of the list. More...
 
const labelfirst () const
 Return first element of the list. More...
 
labellast ()
 Return the last element of the list. More...
 
const labellast () 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 shallowCopy (const UList< label > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< label > &)
 Copy elements of the given UList. More...
 
labeloperator[] (const label)
 Return element of UList. More...
 
const labeloperator[] (const label) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
 operator const Foam::List< label > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant 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...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_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 rend () const
 Return const_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...
 
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< label > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< label > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< label > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< label > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< label > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< label > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< label > &) const
 Return true if !(a < b). Takes linear time. More...
 

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< label >
typedef label value_type
 Type of values the UList contains. More...
 
typedef labelreference
 Type that can be used for storing into. More...
 
typedef const labelconst_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 labeliterator
 Random access iterator for traversing UList. More...
 
typedef const labelconst_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_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< label >
static const UList< label > & 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 57 of file cell.H.

Constructor & Destructor Documentation

◆ cell() [1/5]

cell ( )
inline

Construct null.

Definition at line 30 of file cellI.H.

◆ cell() [2/5]

cell ( label  s)
inlineexplicit

Construct given size.

Definition at line 34 of file cellI.H.

◆ cell() [3/5]

cell ( const labelUList lst)
inlineexplicit

Construct from list of labels.

Definition at line 40 of file cellI.H.

◆ cell() [4/5]

cell ( labelList &&  lst)
inlineexplicit

Construct by transferring the parameter contents.

Definition at line 46 of file cellI.H.

◆ cell() [5/5]

cell ( Istream is)
inline

Construct from Istream.

Definition at line 52 of file cellI.H.

Member Function Documentation

◆ nFaces()

Foam::label nFaces ( ) const
inline

Return number of faces.

Definition at line 60 of file cellI.H.

◆ labels()

Foam::labelList labels ( const faceUList f) const

Return labels of cell vertices.

Definition at line 35 of file cell.C.

References f(), UList< label >::first(), forAll, found, p, and List< T >::size().

Here is the call graph for this function:

◆ points()

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

Return the cell vertices.

Definition at line 101 of file cell.C.

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

Here is the call graph for this function:

◆ edges()

Foam::edgeList edges ( const faceUList f) const

Return cell edges.

Definition at line 120 of file cell.C.

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

Here is the call graph for this function:

◆ opposingFaceLabel()

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

Return index of opposite face.

Definition at line 39 of file oppositeCellFace.C.

References forAll, and List< T >::size().

Here is the call graph for this function:

◆ opposingFace()

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

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

Definition at line 113 of file oppositeCellFace.C.

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

Here is the call graph for this function:

◆ centre()

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

Returns cell centre.

Definition at line 172 of file cell.C.

References f(), forAll, p, and Foam::Zero.

Here is the call graph for this function:

◆ mag()

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

Returns cell volume.

Definition at line 238 of file cell.C.

References f(), forAll, Foam::mag(), p, and Foam::Zero.

Here is the call graph for this function:

◆ bb()

Foam::boundBox bb ( const pointField ps,
const faceUList fs 
) const

Returns the cell bounding box.

Definition at line 279 of file cell.C.

References Foam::constant::universal::c, f(), forAll, boundBox::invertedBox, boundBox::max(), Foam::max(), boundBox::min(), Foam::min(), and p.

Here is the call graph for this function:

◆ operator=()

void operator= ( labelList &&  l)
inline

Move assignment labelList.

Definition at line 74 of file cellI.H.

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator==

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

◆ operator!=

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

Member Data Documentation

◆ typeName

const char *const typeName = "cell"
static

Definition at line 66 of file cell.H.


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