An analytical geometric cellShape. More...

Inheritance diagram for cellShape:

Collaboration diagram for cellShape:

Public Member Functions
constexpr	cellShape () noexcept
	Default construct. Empty shape, no cell model. More...

	cellShape (const cellModel &model, const labelUList &labels, const bool doCollapse=false)
	Copy construct from components. More...

template<unsigned N>
	cellShape (const cellModel &model, const FixedList< label, N > &labels, const bool doCollapse=false)
	Copy construct from components. More...

	cellShape (const cellModel &model, labelList &&labels, const bool doCollapse=false)
	Move construct from components. More...

	cellShape (const word &modelName, const labelUList &labels, const bool doCollapse=false)
	Copy construct from components, lookup cellModel by name. More...

	cellShape (Istream &is)
	Construct from Istream. More...

autoPtr< cellShape >	clone () const
	Clone. More...

const cellModel &	model () const
	Model reference. More...

label	nPoints () const noexcept
	Number of points. More...

label	nEdges () const
	Number of edges. More...

label	nFaces () const
	Number of faces. More...

pointField	points (const UList< point > &meshPoints) const
	The points corresponding to this shape. More...

labelList	meshFaces (const faceList &allFaces, const cell &cFaces) const
	Mesh face labels of this cell (in order of model) More...

labelList	meshEdges (const edgeList &allEdges, const labelList &cEdges) const
	Mesh edge labels of this cell (in order of model) More...

Foam::face	face (const label modelFacei) const
	The face for the specified model face. More...

faceList	faces () const
	Faces of this cell. More...

faceList	collapsedFaces () const
	Collapsed faces of this cell. More...

Foam::edge	edge (const label modelEdgei) const
	The edge for the specified model edge. More...

edgeList	edges () const
	Edges of this shape. More...

point	centre (const UList< point > &points) const
	Centroid of the cell. More...

scalar	mag (const UList< point > &points) const
	Scalar magnitude. More...

void	reset (const cellModel &model, const labelUList &labels, const bool doCollapse=false)
	Reset from components. More...

template<unsigned N>
void	reset (const cellModel &model, const FixedList< label, N > &labels, const bool doCollapse=false)
	Reset from components. More...

void	collapse ()
	Collapse shape to correct one after removing duplicate vertices. More...

Foam::InfoProxy< cellShape >	info () const
	Return info proxy, to print information to a stream. More...

Public Member Functions inherited from List< label >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const label &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const label &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, label &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< label > &a)
	Copy construct from list. More...

	List (const UList< label > &a)
	Copy construct contents from list. More...

	List (List< label > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< label > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< label > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< label, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< label > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< label > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< label, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< label > list)
	Construct from an initializer list. More...

	List (List< label > &&list)
	Move construct from List. More...

	List (DynamicList< label, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SLList< label > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< label > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const label &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const label &val)
	Alias for resize() More...

void	append (const label &val)
	Append an element at the end of the list. More...

void	append (label &&val)
	Move append an element at the end of the list. More...

void	append (const UList< label > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< label, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const label &val)
	Append an element if not already in the list. More...

void	transfer (List< label > &list)

void	transfer (DynamicList< label, SizeMin > &list)

label &	newElmt (const label i)

void	operator= (const UList< label > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< label > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< label > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< label, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< label, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< label > list)
	Assignment to an initializer list. More...

void	operator= (const label &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< label > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< label, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< label > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< label > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Public Member Functions inherited from UList< T >
	UList (const UList< T > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (T *__restrict__ v, const label len) noexcept
	Construct from components. More...

label	fcIndex (const label i) const noexcept

label	rcIndex (const label i) const noexcept

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

T *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

label	find (const T &val, label pos=0) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

bool	found (const T &val, label pos=0) const
	True if the value if found in the list. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (const UList< T > &list)
	Copy the pointer and size held by the given UList. More...

void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match! More...

template<class Addr >
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

T &	operator[] (const label i)
	Return element of UList. More...

const T &	operator[] (const label i) 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 &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...

iterator	end () noexcept
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const noexcept
	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 noexcept
	The number of elements in the UList. More...

bool	empty () const noexcept
	True if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &list)
	Swap content with another UList of the same type in constant time. More...

bool	operator== (const UList< T > &a) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &a) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &a) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &a) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &a) const
	Return true if !(a < b). Takes linear time. More...

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Istream &	readList (Istream &is)

Ostream &	writeList (Ostream &os, const label) const

const bool &	operator[] (const label i) const

Foam::UPstream::commsStruct &	operator[] (const label procID)

const Foam::UPstream::commsStruct &	operator[] (const label procID) const

UPstream::commsStruct &	operator[] (const label procID)

const UPstream::commsStruct &	operator[] (const label procID) const

Ostream &	writeList (Ostream &os, const label) const

Istream &	readList (Istream &is)

Friends
bool	operator== (const cellShape &a, const cellShape &b)

Istream &	operator>> (Istream &is, cellShape &s)

Ostream &	operator<< (Ostream &os, const cellShape &s)

Additional Inherited Members
Public Types inherited from List< label >
typedef SubList< label >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

typedef T *	iterator
	Random access iterator for traversing a UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing a UList. More...

typedef label	size_type
	The type to represent the size of a UList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) 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 UList reference to a nullObject. More...

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

labelRange	validateRange (const labelRange &requestedRange) const

UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy) More...

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

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/6]

constexpr cellShape ( )

inlineconstexprnoexcept

Default construct. Empty shape, no cell model.

Definition at line 36 of file cellShapeI.H.

◆ cellShape() [2/6]

cellShape	(	const cellModel &	model,
		const labelUList &	labels,
		const bool	doCollapse = `false`
	)

inline

Copy construct from components.

Definition at line 43 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [3/6]

cellShape	(	const cellModel &	model,
		const FixedList< label, N > &	labels,
		const bool	doCollapse = `false`
	)

inline

Copy construct from components.

Definition at line 61 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [4/6]

cellShape	(	const cellModel &	model,
		labelList &&	labels,
		const bool	doCollapse = `false`
	)

inline

Move construct from components.

Definition at line 78 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [5/6]

cellShape	(	const word &	modelName,
		const labelUList &	labels,
		const bool	doCollapse = `false`
	)

inline

Copy construct from components, lookup cellModel by name.

Definition at line 95 of file cellShapeI.H.

References cellShape::collapse().

Here is the call graph for this function:

◆ cellShape() [6/6]

cellShape ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 112 of file cellShapeI.H.

Member Function Documentation

◆ clone()

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

inline

Clone.

Definition at line 118 of file cellShapeI.H.

References Time::New().

Here is the call graph for this function:

◆ model()

const Foam::cellModel & model ( ) const

inline

Model reference.

Definition at line 126 of file cellShapeI.H.

Referenced by Foam::operator<<(), vtuSizing::reset(), and vtuSizing::resetShapes().

Here is the caller graph for this function:

◆ nPoints()

Foam::label nPoints ( ) const

inlinenoexcept

Number of points.

Definition at line 132 of file cellShapeI.H.

References interfaceDefinitions::size().

Here is the call graph for this function:

◆ nEdges()

Foam::label nEdges ( ) const

inline

Number of edges.

Definition at line 138 of file cellShapeI.H.

◆ nFaces()

Foam::label nFaces ( ) const

inline

Number of faces.

Definition at line 144 of file cellShapeI.H.

◆ points()

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

inline

The points corresponding to this shape.

Definition at line 150 of file cellShapeI.H.

Referenced by voxelMeshSearch::makeMesh().

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 159 of file cellShapeI.H.

References forAll, and UList< 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 190 of file cellShapeI.H.

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

Here is the call graph for this function:

◆ face()

Foam::face face ( const label modelFacei ) const

inline

The face for the specified model face.

Definition at line 221 of file cellShapeI.H.

References face::face().

Here is the call graph for this function:

◆ faces()

Foam::faceList faces ( ) const

inline

Faces of this cell.

Definition at line 227 of file cellShapeI.H.

◆ collapsedFaces()

Foam::faceList collapsedFaces ( ) const

inline

Collapsed faces of this cell.

Definition at line 233 of file cellShapeI.H.

References f(), List< T >::resize(), and UList< T >::size().

Referenced by degenerateMatcher::match().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edge()

Foam::edge edge ( const label modelEdgei ) const

inline

The edge for the specified model edge.

Definition at line 275 of file cellShapeI.H.

References edge::edge().

Here is the call graph for this function:

◆ edges()

Foam::edgeList edges ( ) const

inline

Edges of this shape.

Definition at line 281 of file cellShapeI.H.

◆ centre()

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

inline

Centroid of the cell.

Definition at line 287 of file cellShapeI.H.

References points.

◆ mag()

Foam::scalar mag ( const UList< point > & points ) const

inline

Scalar magnitude.

Definition at line 293 of file cellShapeI.H.

References mag::mag(), and points.

Here is the call graph for this function:

◆ reset() [1/2]

void reset	(	const cellModel &	model,
		const labelUList &	labels,
		const bool	doCollapse = `false`
	)

inline

Reset from components.

Definition at line 299 of file cellShapeI.H.

Referenced by hexMatcher::matches(), prismMatcher::matches(), pyrMatcher::matches(), tetMatcher::matches(), tetWedgeMatcher::matches(), and wedgeMatcher::matches().

Here is the caller graph for this function:

◆ reset() [2/2]

void reset	(	const cellModel &	model,
		const FixedList< label, N > &	labels,
		const bool	doCollapse = `false`
	)

inline

Reset from components.

Definition at line 317 of file cellShapeI.H.

◆ collapse()

void collapse ( )

Collapse shape to correct one after removing duplicate vertices.

Definition at line 33 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:

◆ info()

Foam::InfoProxy< cellShape > info ( ) const

inline

Return info proxy, to print information to a stream.

Definition at line 199 of file cellShape.H.

Friends And Related Function Documentation

◆ operator==

bool operator==	(	const cellShape &	a,
		const cellShape &	b
	)

friend

◆ operator>>

Istream & operator>>	(	Istream &	is,
		cellShape &	s
	)

friend

◆ operator<<

Ostream & operator<<	(	Ostream &	os,
		const cellShape &	s
	)

friend

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

src/OpenFOAM/meshes/meshShapes/cellShape/cellShape.H
src/OpenFOAM/meshes/meshShapes/cellShape/cellShape.C
src/OpenFOAM/meshes/meshShapes/cellShape/cellShapeI.H

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cellShape() [1/6]

◆ cellShape() [2/6]

◆ cellShape() [3/6]

◆ cellShape() [4/6]

◆ cellShape() [5/6]

◆ cellShape() [6/6]

Member Function Documentation

◆ clone()

◆ model()

◆ nPoints()

◆ nEdges()

◆ nFaces()

◆ points()

◆ meshFaces()

◆ meshEdges()

◆ face()

◆ faces()

◆ collapsedFaces()

◆ edge()

◆ edges()

◆ centre()

◆ mag()

◆ reset() [1/2]

◆ reset() [2/2]

◆ collapse()

◆ info()

Friends And Related Function Documentation

◆ operator==

◆ operator>>

◆ operator<<