FreeFOAM The Cross-Platform CFD Toolkit
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...

#include <OpenFOAM/cellModel.H>


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 65 of file cellModel.H.

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

static 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 is)

Construct from Istream.

Definition at line 40 of file cellModelIO.C.

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

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


Member Function Documentation

static autoPtr<cellModel> New ( Istream is)
inlinestatic

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

Definition at line 93 of file cellModel.H.

References cellModel::cellModel().

autoPtr<cellModel> clone ( ) const
inline

Return clone.

Definition at line 99 of file cellModel.H.

References cellModel::cellModel().

const word & name ( ) const
inline

Return model name.

Definition at line 38 of file cellModelI.H.

Referenced by Foam::operator<<().

label index ( ) const
inline

Return index of model in the model list.

Definition at line 44 of file cellModelI.H.

Referenced by Foam::operator<<().

label nPoints ( ) const
inline

Return number of points.

Definition at line 50 of file cellModelI.H.

Referenced by Foam::operator<<().

label nEdges ( ) const
inline

Return number of edges.

Definition at line 56 of file cellModelI.H.

References List< T >::size().

Referenced by Foam::operator<<().

label nFaces ( ) const
inline

Return number of faces.

Definition at line 62 of file cellModelI.H.

References List< T >::size().

Referenced by Foam::operator<<().

edgeList edges ( const labelList pointLabels) const
inline

Return list of edges.

Definition at line 70 of file cellModelI.H.

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

const faceList & modelFaces ( ) const
inline

Return a raw list of model faces.

Definition at line 90 of file cellModelI.H.

faceList faces ( const labelList pointLabels) const
inline

Return list of faces.

Definition at line 97 of file cellModelI.H.

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

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

Vector centroid.

Definition at line 32 of file cellModel.C.

References Foam::endl(), forAll, Foam::mag(), List< T >::size(), and WarningIn.

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

Cell volume.

Definition at line 89 of file cellModel.C.

References Foam::endl(), forAll, Foam::mag(), List< T >::size(), and WarningIn.

InfoProxy<cellModel> info ( ) const
inline

Return info proxy.

Used to print token information to a stream

Definition at line 150 of file cellModel.H.

Referenced by Foam::operator<<().

bool writeData ( Ostream os) const
inline

WriteData member function required by regIOobject.

Definition at line 156 of file cellModel.H.

References IOstream::good().


Friends And Related Function Documentation

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

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

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

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

Ostream& operator<< ( Ostream os,
const cellModel c 
)
friend

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