Public Member Functions | Static Public Member Functions | Friends | List of all members
cellModel Class Reference

Maps a geometry to a set of cell primitives, which enables geometric cell data to be calculated without access to the primitive geometric level. This means mapping a 3D geometry to a set of pyramids which are each described by a cell face and the cell centre point. More...

Public Member Functions

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

Static Public Member Functions

static autoPtr< cellModel > New (Istream &is)
 Return a new cellModel on free-store created from Istream. More...
 

Friends

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

Detailed Description

Maps a geometry to a set of cell primitives, which enables geometric cell data to be calculated without access to the primitive geometric level. This means mapping a 3D geometry to a set of pyramids which are each described by a cell face and the cell centre point.

Source files

Definition at line 64 of file cellModel.H.

Constructor & Destructor Documentation

◆ cellModel()

cellModel ( Istream &  is)

Construct from Istream.

Definition at line 31 of file cellModelIO.C.

References entry::keyword(), and dictionary::null.

Referenced by cellModel::clone(), and cellModel::New().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ New()

static autoPtr<cellModel> New ( Istream &  is)
inlinestatic

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

Definition at line 92 of file cellModel.H.

References cellModel::cellModel().

Here is the call graph for this function:

◆ clone()

autoPtr<cellModel> clone ( ) const
inline

Return clone.

Definition at line 98 of file cellModel.H.

References cellModel::cellModel().

Here is the call graph for this function:

◆ name()

const word & name ( ) const
inline

Return model name.

Definition at line 38 of file cellModelI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ index()

label index ( ) const
inline

Return index of model in the model list.

Definition at line 44 of file cellModelI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ nPoints()

label nPoints ( ) const
inline

Return number of points.

Definition at line 50 of file cellModelI.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ nEdges()

label nEdges ( ) const
inline

Return number of edges.

Definition at line 56 of file cellModelI.H.

References List< T >::size().

Referenced by Foam::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nFaces()

label nFaces ( ) const
inline

Return number of faces.

Definition at line 62 of file cellModelI.H.

References List< T >::size().

Referenced by Foam::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ edges()

edgeList edges ( const labelList &  pointLabels) const
inline

Return list of edges.

Definition at line 70 of file cellModelI.H.

References Foam::e, forAll, pointLabels(), and List< T >::size().

Here is the call graph for this function:

◆ modelFaces()

const faceList & modelFaces ( ) const
inline

Return a raw list of model faces.

Definition at line 90 of file cellModelI.H.

◆ faces()

faceList faces ( const labelList &  pointLabels) const
inline

Return list of faces.

Definition at line 97 of file cellModelI.H.

References f(), forAll, Foam::labelI, pointLabels(), List< T >::setSize(), and List< T >::size().

Referenced by cellModel::centre().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ centre()

Foam::vector centre ( const labelList &  pointLabels,
const pointField &  points 
) const

Vector centroid.

Definition at line 31 of file cellModel.C.

References pyramid< Point, PointRef, polygonRef >::centre(), Foam::endl(), cellModel::faces(), forAll, pyramid< Point, PointRef, polygonRef >::mag(), pointLabels(), points, WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

◆ mag()

Foam::scalar mag ( const labelList &  pointLabels,
const pointField &  points 
) const

Cell volume.

Definition at line 88 of file cellModel.C.

References Foam::endl(), forAll, pyramid< Point, PointRef, polygonRef >::mag(), pointLabels(), points, List< T >::size(), WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

◆ info()

InfoProxy<cellModel> info ( ) const
inline

Return info proxy.

Used to print token information to a stream

Definition at line 149 of file cellModel.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream &  os) const
inline

WriteData member function required by regIOobject.

Definition at line 155 of file cellModel.H.

References IOstream::good().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator==

bool operator== ( const cellModel &  m1,
const cellModel &  m2 
)
friend

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

Definition at line 123 of file cellModelI.H.

◆ operator!=

bool operator!= ( const cellModel &  m1,
const cellModel &  m2 
)
friend

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

Definition at line 129 of file cellModelI.H.

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const cellModel &   
)
friend
The documentation for this class was generated from the following files: