FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

cellShape Class Reference

An analytical geometric cellShape. More...

#include <OpenFOAM/cellShape.H>


Detailed Description

An analytical geometric cellShape.

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

Source files

Definition at line 70 of file cellShape.H.

Inheritance diagram for cellShape:
Collaboration diagram for cellShape:

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 &)

Constructor & Destructor Documentation

cellShape (  ) [inline]

Construct null.

Definition at line 31 of file cellShapeI.H.

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

Construct from components.

Definition at line 38 of file cellShapeI.H.

cellShape ( Istream &   is  ) [inline]

Construct from Istream.

Definition at line 54 of file cellShapeI.H.


Member Function Documentation

Foam::autoPtr< Foam::cellShape > clone (  ) const [inline]

Clone.

Reimplemented from List< label >.

Definition at line 60 of file cellShapeI.H.

Foam::pointField points ( const pointField &   meshPoints  ) const [inline]

Return the points corresponding to this cellShape.

Definition at line 69 of file cellShapeI.H.

References forAll, and p.

const Foam::cellModel & model (  ) const [inline]

Model reference.

Definition at line 88 of file cellShapeI.H.

Referenced by Foam::operator<<().

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

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

Definition at line 95 of file cellShapeI.H.

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

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

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

Definition at line 129 of file cellShapeI.H.

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

Foam::faceList faces (  ) const [inline]

Faces of this cell.

Definition at line 162 of file cellShapeI.H.

Foam::faceList collapsedFaces (  ) const [inline]

Collapsed faces of this cell.

Definition at line 168 of file cellShapeI.H.

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

Referenced by degenerateMatcher::match().

Foam::label nFaces (  ) const [inline]

Number of faces.

Definition at line 217 of file cellShapeI.H.

Foam::edgeList edges (  ) const [inline]

Edges of this cellShape.

Definition at line 223 of file cellShapeI.H.

Foam::label nEdges (  ) const [inline]

Number of edges.

Definition at line 229 of file cellShapeI.H.

Foam::label nPoints (  ) const [inline]

Number of points.

Definition at line 235 of file cellShapeI.H.

Foam::point centre ( const pointField &   points  ) const [inline]

Centroid of the cell.

Definition at line 241 of file cellShapeI.H.

References Vector< Cmpt >::centre().

Foam::InfoProxy<cellShape> info (  ) const [inline]

Return info proxy.

Used to print token information to a stream

Definition at line 143 of file cellShape.H.

Foam::scalar mag ( const pointField &   points  ) const [inline]

Scalar magnitude.

Definition at line 247 of file cellShapeI.H.

void collapse (  )

Collapse shape to correct one after removing duplicate vertices.

Definition at line 34 of file cellShape.C.

References List< label >::operator=().


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: