A hexahedral cell primitive. More...

#include <hexCell.H>

Inheritance diagram for hexCell:

Collaboration diagram for hexCell:

Public Member Functions
void	front ()=delete
	The front() accessor (from FixedList) has no purpose.
void	back ()=delete
	The back() accessor (from FixedList) has no purpose.
	hexCell ()
	Default construct, with invalid point labels (-1).
	hexCell (std::initializer_list< label > list)
	Construct from an initializer list of eight point labels.
	hexCell (const FixedList< label, 8 > &list)
	Construct from FixedList of eight point labels.
	hexCell (const labelUList &list, const FixedList< label, 8 > &indices)
	Copy construct from a subset of point labels.
template<unsigned AnyNum>
	hexCell (const FixedList< label, AnyNum > &list, const FixedList< label, 8 > &indices)
	Copy construct from a subset of point labels.
	hexCell (Istream &is)
	Construct from Istream.
Foam::face	face (const label facei) const
	Return i-th face.
Foam::edge	edge (const label edgei) const
	Return i-th edge.
Foam::edge	reverseEdge (const label edgei) const
	Return i-th edge reversed.
Foam::faceList	faces () const
	Return list of cell faces [6].
Foam::edgeList	edges () const
	Return list of cell edges [12].
point	centre (const UList< point > &meshPoints) const
	Cell centre - uses simple average of points.
pointField	points (const UList< point > &meshPoints) const
	The points corresponding to this shape.
cellShape	shape (const bool doCollapse=false) const
	Return HEX shape cell.
Public Member Functions inherited from FixedList< label, 8 >
	FixedList ()=default
	Default construct.
autoPtr< FixedList< label, N > >	clone () const
	Clone.
const label *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
label *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
label &	get () noexcept
	Element access using compile-time indexing.
label &	front () noexcept
	Access first element of the list, position [0].
label &	back () noexcept
	Access last element of the list, position [N-1].
label	fcIndex (const label i) const noexcept
	Return the forward circular index, i.e. next index which returns to the first at the end of the list.
const label &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
label	rcIndex (const label i) const noexcept
	Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list.
const label &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is identical to template parameter N.
void	checkIndex (const label i) const
	Check index is within valid range [0,N).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const label &val) const
	True if the value is contained in the list.
label	find (const label &val) const
	Find index of the first occurrence of the value.
label	rfind (const label &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	resize (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_fill (const label n, const label &val)
	Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_nocopy (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	setSize (const label n)
	Dummy function, to make FixedList consistent with List.
void	fill (const label &val)
	Assign all entries to the given value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element.
void	swapLast (const label i)
	Swap element with the last element.
void	transfer (FixedList< label, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements.
label &	operator[] (const label i)
	Return element of FixedList.
void	operator= (const UList< label > &list)
	Assignment to UList operator. Takes linear time.
iterator	begin () noexcept
	Return an iterator to begin traversing the FixedList.
iterator	end () noexcept
	Return an iterator to end traversing the FixedList.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant FixedList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the FixedList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
void	swap (FixedList< label, N > &other)
	Swap lists by swapping the content of the individual list elements.
bool	operator== (const FixedList< label, N > &list) const
	Equality operation on FixedLists of the same type.
bool	operator!= (const FixedList< label, N > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator> (const FixedList< label, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator<= (const FixedList< label, N > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const FixedList< label, N > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read from Istream, discarding contents of existing List.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
label &	first () noexcept
	Access first element of the list, position [0] - front().
label &	last () noexcept
	Access last element of the list, position [N-1] - back().
bool	found (const label &val, label pos=0) const
	Same as contains().

Static Public Member Functions
static constexpr label	nPoints () noexcept
	Number of points for HEX.
static constexpr label	nEdges () noexcept
	Number of edges for HEX.
static constexpr label	nFaces () noexcept
	Number of faces for HEX.
static const Foam::faceList &	modelFaces ()
	Return the model faces.
static const Foam::edgeList &	modelEdges ()
	Return the model edges.
Static Public Member Functions inherited from FixedList< label, 8 >
static const FixedList< label, N > &	null () noexcept
	Return a null FixedList (reference to a nullObject). Read/write access is questionable.
static std::streamsize	size_bytes () noexcept
	Number of contiguous bytes for the list data,.
static std::streamsize	byteSize ()
	Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous.
static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled.
static constexpr label	size () noexcept
	Return the number of elements in the FixedList.
static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList.

Additional Inherited Members
Public Types inherited from FixedList< label, 8 >
typedef label	value_type
	The value type the FixedList contains.
typedef label *	pointer
	The pointer type for non-const access to value_type items.
typedef const label *	const_pointer
	The pointer type for const access to value_type items.
typedef label &	reference
	The type used for storing into value_type objects.
typedef const label &	const_reference
	The type used for reading from constant value_type objects.
typedef label *	iterator
	Random access iterator for traversing FixedList.
typedef const label *	const_iterator
	Random access iterator for traversing FixedList.
typedef label	size_type
	The type to represent the size of a FixedList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
Protected Member Functions inherited from FixedList< label, 8 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type.

Detailed Description

A hexahedral cell primitive.

It is important that the face/edge ordering is identical for a hexahedral cell shape model and a hexCell

Source files

Definition at line 56 of file hexCell.H.

Constructor & Destructor Documentation

◆ hexCell() [1/6]

hexCell ( )

inline

Default construct, with invalid point labels (-1).

Definition at line 34 of file hexCellI.H.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

◆ hexCell() [2/6]

hexCell ( std::initializer_list< label > list )

inlineexplicit

Construct from an initializer list of eight point labels.

Definition at line 40 of file hexCellI.H.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

◆ hexCell() [3/6]

hexCell ( const FixedList< label, 8 > & list )

inline

Construct from FixedList of eight point labels.

Definition at line 46 of file hexCellI.H.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

◆ hexCell() [4/6]

hexCell	(	const labelUList &	list,
		const FixedList< label, 8 > &	indices )

inline

Copy construct from a subset of point labels.

Definition at line 52 of file hexCellI.H.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

◆ hexCell() [5/6]

template<unsigned AnyNum>

hexCell	(	const FixedList< label, AnyNum > &	list,
		const FixedList< label, 8 > &	indices )

inline

Copy construct from a subset of point labels.

Definition at line 63 of file hexCellI.H.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

◆ hexCell() [6/6]

hexCell ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 73 of file hexCellI.H.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

Member Function Documentation

◆ front()

void front ( )

delete

The front() accessor (from FixedList) has no purpose.

◆ back()

void back ( )

delete

The back() accessor (from FixedList) has no purpose.

References FixedList< label, 8 >::FixedList().

Here is the call graph for this function:

◆ nPoints()

constexpr label nPoints ( )

inlinestaticconstexprnoexcept

Number of points for HEX.

Definition at line 143 of file hexCell.H.

References Foam::noexcept.

◆ nEdges()

constexpr label nEdges ( )

inlinestaticconstexprnoexcept

Number of edges for HEX.

Definition at line 151 of file hexCell.H.

References Foam::noexcept.

Referenced by edge(), edges(), and modelEdges().

Here is the caller graph for this function:

◆ nFaces()

constexpr label nFaces ( )

inlinestaticconstexprnoexcept

Number of faces for HEX.

Definition at line 159 of file hexCell.H.

References Foam::noexcept.

Referenced by face(), faces(), and modelFaces().

Here is the caller graph for this function:

◆ modelFaces()

const Foam::faceList & modelFaces ( )

static

Return the model faces.

Definition at line 64 of file hexCell.C.

References f(), and nFaces().

Here is the call graph for this function:

◆ modelEdges()

const Foam::edgeList & modelEdges ( )

static

Return the model edges.

Definition at line 87 of file hexCell.C.

References e, and nEdges().

Referenced by blockDescriptor::edgePointsWeights(), blockDescriptor::edgePointsWeights(), and blockDescriptor::edgesPointsWeights().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ face()

Foam::face face ( const label facei ) const

inline

Return i-th face.

Definition at line 81 of file hexCellI.H.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, and nFaces().

Here is the call graph for this function:

◆ edge()

Foam::edge edge ( const label edgei ) const

inline

Return i-th edge.

Definition at line 99 of file hexCellI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and nEdges().

Referenced by reverseEdge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reverseEdge()

Foam::edge reverseEdge ( const label edgei ) const

inline

Return i-th edge reversed.

Definition at line 118 of file hexCellI.H.

References edge().

Here is the call graph for this function:

◆ faces()

Foam::faceList faces ( ) const

Return list of cell faces [6].

Definition at line 110 of file hexCell.C.

References f(), and nFaces().

Here is the call graph for this function:

◆ edges()

Foam::edgeList edges ( ) const

Return list of cell edges [12].

Definition at line 125 of file hexCell.C.

References e, and nEdges().

Here is the call graph for this function:

◆ centre()

Foam::point centre ( const UList< point > & meshPoints ) const

inline

Cell centre - uses simple average of points.

Definition at line 125 of file hexCellI.H.

References Foam::Zero.

◆ points()

Foam::pointField points ( const UList< point > & meshPoints ) const

inline

The points corresponding to this shape.

Definition at line 146 of file hexCellI.H.

◆ shape()

Foam::cellShape shape ( const bool doCollapse = false ) const

Return HEX shape cell.

Definition at line 141 of file hexCell.C.

References cellModel::HEX, and cellModel::ptr().

Here is the call graph for this function:

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

src/OpenFOAM/meshes/meshShapes/hexCell/hexCell.H
src/OpenFOAM/meshes/meshShapes/hexCell/hexCell.C
src/OpenFOAM/meshes/meshShapes/hexCell/hexCellI.H

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ hexCell() [1/6]

◆ hexCell() [2/6]

◆ hexCell() [3/6]

◆ hexCell() [4/6]

◆ hexCell() [5/6]

◆ hexCell() [6/6]

Member Function Documentation

◆ front()

◆ back()

◆ nPoints()

◆ nEdges()

◆ nFaces()

◆ modelFaces()

◆ modelEdges()

◆ face()

◆ edge()

◆ reverseEdge()

◆ faces()

◆ edges()

◆ centre()

◆ points()

◆ shape()