MaterialNormalization Class Reference

#include <MaterialNormalization.hpp>

Inheritance diagram for MaterialNormalization:

Public Member Functions
virtual std::pair< double, double >	numberAndMass (const Geometry *geom, const MaterialMix *mix) const =0
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

Protected Member Functions
	MaterialNormalization ()
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
virtual void	setupSelfBefore ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = SimulationItem
using	ItemType = MaterialNormalization

Friends
class	ItemRegistry

Detailed Description

MaterialNormalization is an abstract base class for classes that allow specifying the amount of material in a GeometricMedium instance in various ways.

Constructor & Destructor Documentation

MaterialNormalization()

MaterialNormalization::MaterialNormalization ( )

inlineprotected

Default constructor for abstract Item subclass MaterialNormalization : "a normalization for the amount of material" .

Member Function Documentation

numberAndMass()

virtual std::pair< double, double > MaterialNormalization::numberAndMass ( const Geometry *  geom, const MaterialMix *  mix  ) const

pure virtual

This function returns the total number of entities and total mass in the medium, in that order, given a geometry and material mix in addition to user configuration options offered by the subclass implementing the function.

Implemented in MassColumnMaterialNormalization, MassMaterialNormalization, NumberColumnMaterialNormalization, NumberMaterialNormalization, and OpticalDepthMaterialNormalization.

---

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

• MaterialNormalization.hpp