pyramid Class Reference

A geometric pyramid primitive with a base of 'n' sides: i.e. a parametric pyramid. A pyramid is constructed from a base polygon and an apex point. More...

Public Types
typedef Point	point_type

Public Member Functions
	pyramid (polygonRef base, const Point &apex)
	pyramid (Istream &is)
const Point &	apex () const
polygonRef	base () const
Point	centre (const UList< point > &points) const
vector	height (const UList< point > &points) const
scalar	mag (const UList< point > &points) const

Friends
Istream &	operator>> (Istream &is, pyramid &p)
Ostream &	operator (Ostream &os, const pyramid &p)

Detailed Description

A geometric pyramid primitive with a base of 'n' sides: i.e. a parametric pyramid. A pyramid is constructed from a base polygon and an apex point.

Source files

• pyramid.H
• pyramidI.H

Definition at line 46 of file pyramid.H.

Member Typedef Documentation

point_type

typedef Point point_type

Definition at line 82 of file pyramid.H.

Constructor & Destructor Documentation

pyramid() [1/2]

pyramid ( polygonRef  base, const Point &  apex  )

inline

Definition at line 27 of file pyramidI.H.

pyramid() [2/2]

pyramid ( Istream &  is )

inlineexplicit

Definition at line 38 of file pyramidI.H.

References IOstream::check(), and FUNCTION_NAME.

Here is the call graph for this function:

Member Function Documentation

apex()

const Point & apex ( ) const

inline

Definition at line 48 of file pyramidI.H.

base()

polygonRef base ( ) const

inline

Definition at line 54 of file pyramidI.H.

centre()

Point centre ( const UList< point > &  points ) const

inline

Definition at line 62 of file pyramidI.H.

References points.

height()

Foam::vector height ( const UList< point > &  points ) const

inline

Definition at line 72 of file pyramidI.H.

References points.

mag()

Foam::scalar mag ( const UList< point > &  points ) const

inline

Definition at line 83 of file pyramidI.H.

References points.

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  is, pyramid &  p  )

friend

operator

Ostream& operator ( Ostream &  os, const pyramid &  p  )

friend

---

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

• src/OpenFOAM/meshes/primitiveShapes/pyramid/pyramid.H
• src/OpenFOAM/meshes/primitiveShapes/pyramid/pyramidI.H