cellShape Class Reference

An analytical geometric cellShape. More...

Inheritance diagram for cellShape:
Collaboration diagram for cellShape:

Public Member Functions

 cellShape ()
 Construct null. More...
 
 cellShape (const cellModel &, const labelList &, const bool doCollapse=false)
 Construct from components. More...
 
 cellShape (const word &model, const labelList &, const bool doCollapse=false)
 Construct from components. More...
 
 cellShape (Istream &is)
 Construct from Istream. More...
 
autoPtr< cellShapeclone () const
 Clone. More...
 
pointField points (const pointField &meshPoints) const
 Return the points corresponding to this cellShape. More...
 
const cellModelmodel () const
 Model reference. More...
 
labelList meshFaces (const faceList &allFaces, const cell &) const
 Mesh face labels of this cell (in order of model) More...
 
labelList meshEdges (const edgeList &allEdges, const labelList &) const
 Mesh edge labels of this cell (in order of model) More...
 
faceList faces () const
 Faces of this cell. More...
 
faceList collapsedFaces () const
 Collapsed faces of this cell. More...
 
label nFaces () const
 Number of faces. More...
 
edgeList edges () const
 Edges of this cellShape. More...
 
label nEdges () const
 Number of edges. More...
 
label nPoints () const
 Number of points. More...
 
point centre (const pointField &) const
 Centroid of the cell. More...
 
Foam::InfoProxy< cellShapeinfo () const
 Return info proxy. More...
 
scalar mag (const pointField &) const
 Scalar magnitude. More...
 
void collapse ()
 Collapse shape to correct one after removing duplicate vertices. 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...
 

Friends

bool operator== (const cellShape &, const cellShape &)
 
Istreamoperator>> (Istream &, cellShape &)
 
Ostreamoperator<< (Ostream &, const cellShape &)
 

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

An analytical geometric cellShape.

The optional collapse functionality changes the cellModel to the correct type after removing any duplicate points.

Source files

Definition at line 69 of file cellShape.H.

Constructor & Destructor Documentation

◆ cellShape() [1/4]

cellShape ( )
inline

Construct null.

Definition at line 32 of file cellShapeI.H.

◆ cellShape() [2/4]

cellShape ( const cellModel M,
const labelList l,
const bool  doCollapse = false 
)
inline

Construct from components.

Definition at line 38 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [3/4]

cellShape ( const word model,
const labelList l,
const bool  doCollapse = false 
)
inline

Construct from components.

Definition at line 55 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [4/4]

cellShape ( Istream is)
inline

Construct from Istream.

Definition at line 72 of file cellShapeI.H.

Member Function Documentation

◆ clone()

Foam::autoPtr< Foam::cellShape > clone ( ) const
inline

Clone.

Definition at line 78 of file cellShapeI.H.

◆ points()

Foam::pointField points ( const pointField meshPoints) const
inline

Return the points corresponding to this cellShape.

Definition at line 86 of file cellShapeI.H.

References forAll, and p.

◆ model()

const Foam::cellModel & model ( ) const
inline

Model reference.

Definition at line 106 of file cellShapeI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ meshFaces()

Foam::labelList meshFaces ( const faceList allFaces,
const cell cFaces 
) const
inline

Mesh face labels of this cell (in order of model)

Definition at line 112 of file cellShapeI.H.

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

Here is the call graph for this function:

◆ meshEdges()

Foam::labelList meshEdges ( const edgeList allEdges,
const labelList cEdges 
) const
inline

Mesh edge labels of this cell (in order of model)

Definition at line 146 of file cellShapeI.H.

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

Here is the call graph for this function:

◆ faces()

Foam::faceList faces ( ) const
inline

Faces of this cell.

Definition at line 180 of file cellShapeI.H.

◆ collapsedFaces()

Foam::faceList collapsedFaces ( ) const
inline

Collapsed faces of this cell.

Definition at line 186 of file cellShapeI.H.

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

Referenced by degenerateMatcher::match().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nFaces()

Foam::label nFaces ( ) const
inline

Number of faces.

Definition at line 235 of file cellShapeI.H.

◆ edges()

Foam::edgeList edges ( ) const
inline

Edges of this cellShape.

Definition at line 241 of file cellShapeI.H.

◆ nEdges()

Foam::label nEdges ( ) const
inline

Number of edges.

Definition at line 247 of file cellShapeI.H.

◆ nPoints()

Foam::label nPoints ( ) const
inline

Number of points.

Definition at line 253 of file cellShapeI.H.

◆ centre()

Foam::point centre ( const pointField points) const
inline

Centroid of the cell.

Definition at line 259 of file cellShapeI.H.

References Vector< Cmpt >::centre(), and points.

Here is the call graph for this function:

◆ info()

Foam::InfoProxy<cellShape> info ( ) const
inline

Return info proxy.

Used to print token information to a stream

Definition at line 150 of file cellShape.H.

◆ mag()

Foam::scalar mag ( const pointField points) const
inline

Scalar magnitude.

Definition at line 265 of file cellShapeI.H.

References points.

◆ collapse()

void collapse ( )

Collapse shape to correct one after removing duplicate vertices.

Definition at line 31 of file cellShape.C.

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

Referenced by cellShape::cellShape().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==

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

◆ operator>>

Istream& operator>> ( Istream ,
cellShape  
)
friend

◆ operator<<

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

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