cellShape Class Reference

An analytical geometric cellShape. More...

Inheritance diagram for cellShape:

[legend]

Collaboration diagram for cellShape:

[legend]

List of all members.

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

---

Detailed Description

An analytical geometric cellShape.

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

Source files

• cellShape.H
• cellShapeI.H
• cellShape.C
• cellShapeIO.C
• cellShapeEqual.C

Definition at line 65 of file cellShape.H.

---

Constructor & Destructor Documentation

cellShape

(

)

[inline]

Construct null.

Definition at line 23 of file cellShapeI.H.

Referenced by cellShape::points().

Here is the caller graph for this function:

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

Construct from components.

Definition at line 30 of file cellShapeI.H.

cellShape

(

Istream &

is

)

[inline]

Construct from Istream.

Definition at line 46 of file cellShapeI.H.

---

Member Function Documentation

Foam::autoPtr< Foam::cellShape > clone

(

)

const [inline]

Clone.

Definition at line 52 of file cellShapeI.H.

Foam::pointField points

(

const pointField &

meshPoints

)

const [inline]

Return the points corresponding to this cellShape.

Definition at line 61 of file cellShapeI.H.

References cellShape::cellShape().

Here is the call graph for this function:

const Foam::cellModel & model

(

)

const [inline]

Model reference.

Definition at line 80 of file cellShapeI.H.

References p.

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

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

Definition at line 87 of file cellShapeI.H.

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

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

Definition at line 121 of file cellShapeI.H.

Foam::faceList faces

(

)

const [inline]

Faces of this cell.

Definition at line 154 of file cellShapeI.H.

Foam::faceList collapsedFaces

(

)

const [inline]

Collapsed faces of this cell.

Definition at line 160 of file cellShapeI.H.

Referenced by degenerateMatcher::match().

Here is the caller graph for this function:

Foam::label nFaces

(

)

const [inline]

Number of faces.

Definition at line 209 of file cellShapeI.H.

Foam::edgeList edges

(

)

const [inline]

Edges of this cellShape.

Definition at line 215 of file cellShapeI.H.

Foam::label nEdges

(

)

const [inline]

Number of edges.

Definition at line 221 of file cellShapeI.H.

Foam::label nPoints

(

)

const [inline]

Number of points.

Definition at line 227 of file cellShapeI.H.

Foam::point centre

(

const pointField &

points

)

const [inline]

Centroid of the cell.

Definition at line 233 of file cellShapeI.H.

Foam::InfoProxy<cellShape> info

(

)

const [inline]

Return info proxy.

Used to print token information to a stream

Definition at line 140 of file cellShape.H.

Foam::scalar mag

(

const pointField &

points

)

const [inline]

Scalar magnitude.

Definition at line 239 of file cellShapeI.H.

void collapse

(

)

Collapse shape to correct one after removing duplicate vertices.

Definition at line 27 of file cellShape.C.

---

Friends And Related Function Documentation

bool operator==	(	const cellShape &	,
		const cellShape &
	)			[friend]

Istream& operator>>	(	Istream &	is,
		cellShape &	s
	)			[friend]

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