cell Class Reference

A cell is defined as a list of faces with extra functionality. More...

Inheritance diagram for cell:

[legend]

Collaboration diagram for cell:

[legend]

List of all members.

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.
Static Public Attributes
static const char *const	typeName = "cell"
Friends
bool	operator== (const cell &, const cell &)
bool	operator!= (const cell &, const cell &)

---

Detailed Description

A cell is defined as a list of faces with extra functionality.

Source files

• cell.H
• cellI.H

Definition at line 52 of file cell.H.

---

Constructor & Destructor Documentation

cell

(

)

[inline]

Construct null.

Definition at line 24 of file cellI.H.

cell

(

label

s

)

[inline, explicit]

Construct given size.

Definition at line 29 of file cellI.H.

cell

(

const UList< label > &

lst

)

[inline, explicit]

Construct from list of labels.

Definition at line 36 of file cellI.H.

cell

(

const Xfer< labelList > &

lst

)

[inline, explicit]

Construct by transferring the parameter contents.

Definition at line 42 of file cellI.H.

cell

(

Istream &

is

)

[inline]

Construct from Istream.

Definition at line 49 of file cellI.H.

---

Member Function Documentation

Foam::label nFaces

(

)

const [inline]

Return number of faces.

Definition at line 58 of file cellI.H.

Foam::labelList labels

(

const unallocFaceList &

f

)

const

Return labels of cell vertices.

Definition at line 27 of file cell.C.

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

Here is the call graph for this function:

Foam::pointField points	(	const unallocFaceList &	f,
		const pointField &	meshPoints
	)			const

Return the cell vertices.

Definition at line 94 of file cell.C.

Foam::edgeList edges

(

const unallocFaceList &

f

)

const

Return cell edges.

Definition at line 112 of file cell.C.

Foam::label opposingFaceLabel	(	const label	masterFaceLabel,
		const unallocFaceList &	meshFaces
	)			const

Return index of opposite face.

Definition at line 33 of file oppositeCellFace.C.

References Foam::endl(), forAll, and Foam::Info.

Here is the call graph for this function:

Foam::oppositeFace opposingFace	(	const label	masterFaceLabel,
		const unallocFaceList &	meshFaces
	)			const

Return opposite face oriented the same way as the master face.

Definition at line 108 of file oppositeCellFace.C.

Foam::point centre	(	const pointField &	p,
		const unallocFaceList &	f
	)			const

Returns cell centre.

Definition at line 165 of file cell.C.

Foam::scalar mag	(	const pointField &	p,
		const unallocFaceList &	f
	)			const

Returns cell volume.

Definition at line 231 of file cell.C.

---

Friends And Related Function Documentation

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

bool operator!=	(	const cell &	,
		const cell &
	)			[friend]

---

Member Data Documentation

const char *const typeName = "cell" [static]

Definition at line 61 of file cell.H.

---

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

• src/OpenFOAM/meshes/meshShapes/cell/cell.H
• src/OpenFOAM/meshes/meshShapes/cell/cell.C
• src/OpenFOAM/meshes/meshShapes/cell/cellI.H
• src/OpenFOAM/meshes/meshShapes/cell/oppositeCellFace.C