#include <MeshGeometry.hpp>

Inheritance diagram for MeshGeometry:

[legend]

Public Types
enum class	MassType : int { MassDensity , Mass , NumberDensity , Number }

Public Member Functions
MassType	massType () const
double	maxX () const
double	maxY () const
double	maxZ () const
double	minX () const
double	minY () const
double	minZ () const
Public Member Functions inherited from ImportedGeometry
double	density (Position bfr) const override
string	filename () const
Position	generatePosition () const override
bool	importMetallicity () const
bool	importTemperature () const
double	maxTemperature () const
int	numSites () const override
double	SigmaX () const override
double	SigmaY () const override
double	SigmaZ () const override
Position	sitePosition (int index) const override
string	useColumns () const
Public Member Functions inherited from GenGeometry
int	dimension () const override
Public Member Functions inherited from SimulationItem
template<class T>
T *	find (bool setup=true) const
template<class T>
T *	interface (int levels=-999999, bool setup=true) const
virtual string	itemName () const
void	setup ()
string	typeAndName () const
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef property, int index, Item item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef property, Item item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const
Public Member Functions inherited from SiteListInterface
virtual	~SiteListInterface ()

Protected Member Functions
	MeshGeometry ()
const Box &	domain () const
void	setupSelfBefore () override
Protected Member Functions inherited from ImportedGeometry
	ImportedGeometry ()
	~ImportedGeometry ()
virtual Snapshot *	createAndOpenSnapshot ()=0
void	setupSelfAfter () override
Protected Member Functions inherited from GenGeometry
	GenGeometry ()
Protected Member Functions inherited from Geometry
	Geometry ()
Random *	random () const
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
Protected Member Functions inherited from Item
	Item ()
Protected Member Functions inherited from SiteListInterface
	SiteListInterface ()

Private Types
using	BaseType
using	ItemType

Private Attributes
Box	_domain
MassType	_massType
double	_maxX
double	_maxY
double	_maxZ
double	_minX
double	_minY
double	_minZ

Friends
class	ItemRegistry

Detailed Description

MeshGeometry is an abstract class for representing a 3D geometry with a spatial density distribution that is discretized on some structured or unstructured tessellation of a cuboidal spatial domain. The class derives from the ImportedGeometry class, and its main (or only) function is to allow the user to configure the extent of the cuboidal domain of the tessellation, and to indicate the type of mass quantity to be imported for each cell. Subclasses need to define the actual tessellation being used, and deal with the other requirements set by the ImportedGeometry class.

Member Enumeration Documentation

◆ MassType

enum class MeshGeometry::MassType : int

strong

The enumeration type indicating the type of mass quantity to be imported.

MassDensity : "mass density".

Mass : "mass (volume-integrated mass density)".

NumberDensity : "number density".

Number : "number (volume-integrated number density)".

Constructor & Destructor Documentation

◆ MeshGeometry()

MeshGeometry::MeshGeometry ( )

inlineprotected

Default constructor for abstract Item subclass MeshGeometry: "a geometry imported from mesh-based data".

Member Function Documentation

◆ domain()

const Box & MeshGeometry::domain ( ) const

inlineprotected

This function returns the tessellation domain configured for this geometry.

◆ massType()

MassType MeshGeometry::massType ( ) const

inline

This function returns the value of the discoverable MassType enumeration property massType: "the type of mass quantity to be imported".

The default value for this property is given by the conditional value expression "MassDensity".

◆ maxX()

double MeshGeometry::maxX ( ) const

inline

This function returns the value of the discoverable double property maxX: "the end point of the domain in the X direction".