A cell is defined as a list of faces with extra functionality. More...
#include <OpenFOAM/cell.H>
A cell is defined as a list of faces with extra functionality.
Public Member Functions | |
cell () | |
Construct null. | |
cell (label) | |
Construct given size. | |
cell (const UList< label > &) | |
Construct from list of labels. | |
cell (const Xfer< labelList > &) | |
Construct by transferring the parameter contents. | |
cell (Istream &) | |
Construct from Istream. | |
label | nFaces () const |
Return number of faces. | |
labelList | labels (const unallocFaceList &) const |
Return labels of cell vertices. | |
pointField | points (const unallocFaceList &, const pointField &) const |
Return the cell vertices. | |
edgeList | edges (const unallocFaceList &) const |
Return cell edges. | |
label | opposingFaceLabel (const label masterFaceLabel, const unallocFaceList &meshFaces) const |
Return index of opposite face. | |
oppositeFace | opposingFace (const label masterFaceLabel, const unallocFaceList &meshFaces) const |
Return opposite face oriented the same way as the master face. | |
point | centre (const pointField &, const unallocFaceList &) const |
Returns cell centre. | |
scalar | mag (const pointField &, const unallocFaceList &) const |
Returns cell volume. | |
![]() | |
label | size () const |
Return the number of elements in the UList. | |
List () | |
Null constructor. | |
List (const label) | |
Construct with given size. | |
List (const label, const label &) | |
Construct with given size and value for all elements. | |
List (const List< label > &) | |
Copy constructor. | |
List (const Xfer< List< label > > &) | |
Construct by transferring the parameter contents. | |
List (List< label > &, bool reUse) | |
Construct as copy or re-use as specified. | |
List (const UList< label > &, const unallocLabelList &mapAddressing) | |
Construct as subset. | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. | |
List (const FixedList< label, Size > &) | |
Construct as copy of FixedList<T, Size> | |
List (const PtrList< label > &) | |
Construct as copy of PtrList<T> | |
List (const SLList< label > &) | |
Construct as copy of SLList<T> | |
List (const IndirectList< label > &) | |
Construct as copy of IndirectList<T> | |
List (const UIndirectList< label > &) | |
Construct as copy of UIndirectList<T> | |
List (const BiIndirectList< label > &) | |
Construct as copy of BiIndirectList<T> | |
List (Istream &) | |
Construct from Istream. | |
autoPtr< List< label > > | clone () const |
Clone. | |
~List () | |
void | resize (const label) |
Reset size of List. | |
void | resize (const label, const label &) |
Reset size of List and value for new elements. | |
void | setSize (const label) |
Reset size of List. | |
void | setSize (const label, const label &) |
Reset size of List and value for new elements. | |
void | clear () |
Clear the list, i.e. set size to zero. | |
void | append (const UList< label > &) |
Append a List at the end of this list. | |
void | append (const UIndirectList< label > &) |
Append a UIndirectList at the end of this list. | |
void | transfer (List< label > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (DynamicList< label, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (SortableList< label > &) |
Transfer the contents of the argument List into this list. | |
Xfer< List< label > > | xfer () |
Transfer contents to the Xfer container. | |
label & | newElmt (const label) |
Return subscript-checked element of UList. | |
void | operator= (const UList< label > &) |
Assignment from UList operator. Takes linear time. | |
void | operator= (const List< label > &) |
Assignment operator. Takes linear time. | |
void | operator= (const SLList< label > &) |
Assignment from SLList operator. Takes linear time. | |
void | operator= (const IndirectList< label > &) |
Assignment from IndirectList operator. Takes linear time. | |
void | operator= (const UIndirectList< label > &) |
Assignment from UIndirectList operator. Takes linear time. | |
void | operator= (const BiIndirectList< label > &) |
Assignment from BiIndirectList operator. Takes linear time. | |
void | operator= (const label &) |
Assignment of all entries to the given value. | |
![]() | |
UList () | |
Null constructor. | |
UList (label *__restrict__ v, label size) | |
Construct from components. | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. | |
label | byteSize () const |
Return the binary size in number of characters of the UList. | |
const label * | cdata () const |
Return a const pointer to the first data element,. | |
label * | data () |
Return a pointer to the first data element,. | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1). | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size). | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1). | |
void | writeEntry (Ostream &) const |
Write the UList as a dictionary entry. | |
void | writeEntry (const word &keyword, Ostream &) const |
Write the UList as a dictionary entry with keyword. | |
void | assign (const UList< label > &) |
Assign elements to those from UList. | |
label & | operator[] (const label) |
Return element of UList. | |
const label & | operator[] (const label) const |
Return element of constant UList. | |
operator const Foam::List< label > & () const | |
Allow cast to a const List<T>&. | |
iterator | begin () |
Return an iterator to begin traversing the UList. | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. | |
iterator | end () |
Return an iterator to end traversing the UList. | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant UList. | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant UList. | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
label | max_size () const |
Return size of the largest possible UList. | |
bool | empty () const |
Return true if the UList is empty (ie, size() is zero). | |
void | swap (UList< label > &) |
Swap two ULists of the same type in constant time. | |
bool | operator== (const UList< label > &) const |
Equality operation on ULists of the same type. | |
bool | operator!= (const UList< label > &) const |
The opposite of the equality operation. Takes linear time. | |
bool | operator< (const UList< label > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator> (const UList< label > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator<= (const UList< label > &) const |
Return true if !(a > b). Takes linear time. | |
bool | operator>= (const UList< label > &) const |
Return true if !(a < b). Takes linear time. |
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 | |
![]() | |
typedef SubList< label > | subList |
Declare type of subList. | |
![]() | |
typedef label | value_type |
Type of values the UList contains. | |
typedef label & | reference |
Type that can be used for storing into. | |
typedef const label & | const_reference |
Type that can be used for storing into. | |
typedef label | difference_type |
The type that can represent the difference between any two. | |
typedef label | size_type |
The type that can represent the size of a UList. | |
typedef label * | iterator |
Random access iterator for traversing UList. | |
typedef const label * | const_iterator |
Random access iterator for traversing UList. | |
typedef label * | reverse_iterator |
Reverse iterator for reverse traversal of UList. | |
typedef const label * | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. | |
![]() | |
static const List< label > & | null () |
Return a null List. | |
![]() | |
void | size (const label) |
Override size to be inconsistent with allocated storage. |
Foam::labelList labels | ( | const unallocFaceList & | f | ) | const |
Return labels of cell vertices.
Definition at line 35 of file cell.C.
References forAll, p, List< T >::setSize(), List< T >::size(), and UList< T >::size().
Foam::pointField points | ( | const unallocFaceList & | f, |
const pointField & | meshPoints | ||
) | const |
Return the cell vertices.
Definition at line 102 of file cell.C.
References forAll, p, pointLabels(), and List< T >::size().
Foam::edgeList edges | ( | const unallocFaceList & | f | ) | const |
Return cell edges.
Definition at line 120 of file cell.C.
References forAll, and List< T >::setSize().
Foam::label opposingFaceLabel | ( | const label | masterFaceLabel, |
const unallocFaceList & | meshFaces | ||
) | const |
Return index of opposite face.
Definition at line 40 of file oppositeCellFace.C.
References Foam::endl(), forAll, Foam::Info, and List< T >::size().
Foam::oppositeFace opposingFace | ( | const label | masterFaceLabel, |
const unallocFaceList & | meshFaces | ||
) | const |
Return opposite face oriented the same way as the master face.
Definition at line 115 of file oppositeCellFace.C.
References e, forAll, and List< T >::size().
Foam::point centre | ( | const pointField & | p, |
const unallocFaceList & | f | ||
) | const |
Returns cell centre.
Definition at line 173 of file cell.C.
References forAll, and Vector< scalar >::zero.
Foam::scalar mag | ( | const pointField & | p, |
const unallocFaceList & | f | ||
) | const |
Returns cell volume.
Definition at line 239 of file cell.C.
References forAll, Foam::mag(), and Vector< scalar >::zero.