OpenFOAM logo
Open Source CFD Toolkit

pyramid Class Template Reference

Collaboration diagram for pyramid:

Collaboration graph
[legend]
List of all members.

template<class Point, class PointRef, class polygonRef>
class Foam::pyramid< Point, PointRef, polygonRef >


Public Member Functions

 pyramid (polygonRef base, const Point &apex)
 Construct from base polygon and apex point.
 pyramid (Istream &)
 Construct from Istream.
const Point & apex () const
 Return apex point.
polygonRef base () const
 Return base polygon.
Point centre (const pointField &points) const
 Return centre (centroid).
vector height (const pointField &points) const
 Return height vector.
scalar mag (const pointField &points) const
 Return scalar magnitude - returns volume of pyramid.

Friends

Istreamoperator>> (Istream &, pyramid &)
Ostreamoperator (Ostream &, const pyramid &)

Constructor & Destructor Documentation

pyramid polygonRef  base,
const Point &  apex
[inline]
 

Construct from base polygon and apex point.

Definition at line 48 of file pyramidI.H.

References IOstream::check().

Here is the call graph for this function:

pyramid Istream  )  [inline]
 

Construct from Istream.

Definition at line 59 of file pyramidI.H.


Member Function Documentation

const Point & apex  )  const [inline]
 

Return apex point.

Definition at line 69 of file pyramidI.H.

polygonRef base  )  const [inline]
 

Return base polygon.

Definition at line 75 of file pyramidI.H.

References Foam::pointField.

Point centre const pointField points  )  const [inline]
 

Return centre (centroid).

Definition at line 83 of file pyramidI.H.

References Foam::pointField, and Foam::vector.

vector height const pointField points  )  const [inline]
 

Return height vector.

Definition at line 93 of file pyramidI.H.

References Foam::pointField.

scalar mag const pointField points  )  const [inline]
 

Return scalar magnitude - returns volume of pyramid.

Definition at line 104 of file pyramidI.H.

References p.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const pyramid< Point, PointRef, polygonRef > & 
[friend]
 

Istream& operator>> Istream ,
pyramid< Point, PointRef, polygonRef > & 
[friend]
 


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