OpenFOAM logo
Open Source CFD Toolkit

cellModel Class Reference

Collaboration diagram for cellModel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 cellModel (Istream &)
 Construct from Istream.
autoPtr< cellModelclone () const
 Return clone.
const wordname () const
 Return model name.
label index () const
 Return index of model in the model list.
label nPoints () const
 Return number of points.
label nEdges () const
 Return number of edges.
label nFaces () const
 Return number of faces.
edgeList edges (const labelList &pointLabels) const
 Return list of edges.
const faceListmodelFaces () const
 Return a raw list of model faces.
faceList faces (const labelList &pointLabels) const
 Return list of faces.
vector centre (const labelList &pointLabels, const pointField &points) const
 Vector centroid.
scalar mag (const labelList &pointLabels, const pointField &points) const
 Cell volume.
InfoProxy< cellModelinfo () const
 Return info proxy.
bool writeData (Ostream &os) const
 WriteData member function required by regIOobject.

Static Public Member Functions

autoPtr< cellModelNew (Istream &is)
 Return a new cellModel on free-store created from Istream.

Friends

bool operator== (const cellModel &, const cellModel &)
 Equality operator: true => ptr to models are equal !
bool operator!= (const cellModel &, const cellModel &)
 Inequality operator: true => ptr to models are not equal !
Ostreamoperator<< (Ostream &, const cellModel &)

Constructor & Destructor Documentation

cellModel Istream  ) 
 

Construct from Istream.


Member Function Documentation

vector centre const labelList pointLabels,
const pointField points
const
 

Vector centroid.

Referenced by cellShape::nPoints().

autoPtr<cellModel> clone  )  const [inline]
 

Return clone.

Definition at line 99 of file cellModel.H.

References Foam::edgeList, Foam::faceList, Foam::label, Foam::labelList, Foam::mag(), Foam::pointField, and Foam::vector.

Here is the call graph for this function:

edgeList edges const labelList pointLabels  )  const [inline]
 

Return list of edges.

Definition at line 79 of file cellModelI.H.

Referenced by cellShape::nFaces().

faceList faces const labelList pointLabels  )  const [inline]
 

Return list of faces.

Definition at line 106 of file cellModelI.H.

label index  )  const [inline]
 

Return index of model in the model list.

Definition at line 53 of file cellModelI.H.

InfoProxy<cellModel> info  )  const [inline]
 

Return info proxy.

Used to print token information to a stream

Definition at line 152 of file cellModel.H.

scalar mag const labelList pointLabels,
const pointField points
const
 

Cell volume.

Referenced by cellShape::centre().

const faceList & modelFaces  )  const [inline]
 

Return a raw list of model faces.

Definition at line 99 of file cellModelI.H.

References Foam::faceList, forAll, Foam::labelList, and UList::size().

Here is the call graph for this function:

const word & name  )  const [inline]
 

Return model name.

Definition at line 47 of file cellModelI.H.

label nEdges  )  const [inline]
 

Return number of edges.

Definition at line 65 of file cellModelI.H.

Referenced by cellShape::edges().

autoPtr<cellModel> New Istream is  )  [inline, static]
 

Return a new cellModel on free-store created from Istream.

Definition at line 93 of file cellModel.H.

label nFaces  )  const [inline]
 

Return number of faces.

Definition at line 71 of file cellModelI.H.

References Foam::mathematicalConstant::e(), Foam::edgeList, forAll, Foam::labelList, and UList::size().

Here is the call graph for this function:

label nPoints  )  const [inline]
 

Return number of points.

Definition at line 59 of file cellModelI.H.

bool writeData Ostream os  )  const [inline]
 

WriteData member function required by regIOobject.

Definition at line 158 of file cellModel.H.


Friends And Related Function Documentation

bool operator!= const cellModel m1,
const cellModel m2
[friend]
 

Inequality operator: true => ptr to models are not equal !

Definition at line 138 of file cellModelI.H.

Ostream& operator<< Ostream ,
const cellModel
[friend]
 

bool operator== const cellModel m1,
const cellModel m2
[friend]
 

Equality operator: true => ptr to models are equal !

Definition at line 132 of file cellModelI.H.


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org