MPyramid object - inherits from MCell. More...

#include <MPyramid.h>

Inheritance diagram for MPyramid:

Public Member Functions
	MPyramid (const std::vector< std::shared_ptr< MVector >> &vertices, const std::shared_ptr< MMaterial > &material, long int id)
	MPyramid constructor. More...

	MPyramid ()=delete
	deleted default constructor. See MCell default ctor for reference.

	~MPyramid ()=default
	default destructor - wraps MCell destructor (decrements Instance Count)

Public Member Functions inherited from MCell
double	getVolume () const
	get MCellVolume (accessor) More...

double	getWeight () const
	get MCellWeight (accessor) More...

double	getID () const
	get MCellID (accessor) More...

std::vector< std::string >	getType () const
	get MCellType (accessor) More...

std::shared_ptr< MVector >	getCentreOfGrav () const
	get MCellCOG (accessor) More...

std::shared_ptr< MMaterial >	getMaterial () const
	get MCellMaterial (accessor) More...

std::vector< std::shared_ptr< MVector > >	getVertices () const
	get MCellVertices (accessor) More...

const std::vector< unsigned int > &	getVertexIndices ()
	getVertexIndices (accessor) More...

void	setMaterial (std::shared_ptr< MMaterial > material)
	set MCellMaterial accesor More...

void	setVertices (std::vector< std::shared_ptr< MVector >> vertices)
	set MCellMaterial accesor More...

Additional Inherited Members
Static Public Member Functions inherited from MCell
static double	getCount ()
	get MCellInstanceCount (accessor) More...

Protected Types inherited from MCell
enum	MCellType_TypeDef { NONE, TETRAHEDRON, HEXAHEDRON, PYRAMID }

Protected Member Functions inherited from MCell
	MCell (std::vector< std::shared_ptr< MVector >> vertices, std::shared_ptr< MMaterial > material, long int id)
	MCell constructor. More...

	MCell ()=delete
	default constructor - deleted More...

	~MCell ()
	destructor - decrements InstanceCount

Protected Attributes inherited from MCell
double	MCellVolume {}
	MCellVolume - stores the volume of the cell, can not be set by accessors. More...

double	MCellWeight {}
	MCellWeight - stores the weight of the cell, can not be set by accessors.

const long int	MCellID
	MCellDensity - stores the density of the cell, , can not be set by accessors.

std::vector< std::shared_ptr< MVector > >	MCellVertices
	holds a vector of MVectors defining the vertex of the cell More...

std::vector< unsigned int >	vertexIDs
	holds a list of all the vertices IDs, populated on construction More...

std::shared_ptr< MMaterial >	MCellMaterial
	holds a the material of the cell

std::shared_ptr< MVector >	MCellCOG
	holds the Centre Of Gravity of the cell as a shared pointer MVector More...

MCellType_TypeDef	MCellType
	MCellType - holds the type of the current cell.

Detailed Description

MPyramid object - inherits from MCell.

Constructor & Destructor Documentation

MPyramid::MPyramid	(	const std::vector< std::shared_ptr< MVector >> &	vertices,
		const std::shared_ptr< MMaterial > &	material,
		long int	id
	)

MPyramid constructor.

Parameters

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