pyramid< Point, PointRef, polygonRef > Class Template 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...

#include <OpenFOAM/pyramid.H>

---

Detailed Description

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

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

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

Definition at line 70 of file pyramid.H.

List of all members.

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
Istream &	operator>> (Istream &, pyramid &)
Ostream &	operator (Ostream &, const pyramid &)

---

Constructor & Destructor Documentation

pyramid	(	polygonRef	base,
		const Point &	apex
	)		[inline]

Construct from base polygon and apex point.

Definition at line 39 of file pyramidI.H.

pyramid

(

Istream &

is  )

[inline]

Construct from Istream.

Definition at line 50 of file pyramidI.H.

References IOstream::check().

---

Member Function Documentation

const Point & apex

(

)

const [inline]

Return apex point.

Definition at line 60 of file pyramidI.H.

polygonRef base

(

)

const [inline]

Return base polygon.

Definition at line 66 of file pyramidI.H.

Point centre

(

const pointField &

points  )

const [inline]

Return centre (centroid)

Definition at line 74 of file pyramidI.H.

vector height

(

const pointField &

points  )

const [inline]

Return height vector.

Definition at line 84 of file pyramidI.H.

scalar mag

(

const pointField &

points  )

const [inline]

Return scalar magnitude - returns volume of pyramid.

Definition at line 95 of file pyramidI.H.

---

Friends And Related Function Documentation

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

Ostream& operator	(	Ostream &	,
		const pyramid< Point, PointRef, polygonRef > &
	)		[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