OpticalDepthMaterialNormalization Class Reference

#include <OpticalDepthMaterialNormalization.hpp>

Inheritance diagram for OpticalDepthMaterialNormalization:

Public Member Functions
std::pair< double, double >	numberAndMass (const Geometry *geom, const MaterialMix *mix) const override
double	opticalDepth () const
double	wavelength () const
Range	wavelengthRange () const override
Public Member Functions inherited from AxisMaterialNormalization
Axis	axis () const
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
Public Member Functions inherited from MaterialWavelengthRangeInterface
virtual WavelengthGrid *	materialWavelengthGrid () const
Public Member Functions inherited from WavelengthRangeInterface
virtual	~WavelengthRangeInterface ()
virtual Range	wavelengthRange () const =0

Protected Member Functions
	OpticalDepthMaterialNormalization ()
Protected Member Functions inherited from AxisMaterialNormalization
	AxisMaterialNormalization ()
double	geometryColumnDensity (const Geometry *geom) const
Protected Member Functions inherited from MaterialNormalization
	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 ()
Protected Member Functions inherited from MaterialWavelengthRangeInterface
	MaterialWavelengthRangeInterface ()
Protected Member Functions inherited from WavelengthRangeInterface
	WavelengthRangeInterface ()

Private Types
using	BaseType = AxisMaterialNormalization
using	ItemType = OpticalDepthMaterialNormalization

Private Attributes
double	_opticalDepth
double	_wavelength

Friends
class	ItemRegistry

Additional Inherited Members
Public Types inherited from AxisMaterialNormalization
enum class	Axis : int { X , Y , Z }

Detailed Description

A OpticalDepthMaterialNormalization object normalizes the amount of material in a geometric medium by specifying the optical depth along one of the coordinate axes at a given wavelength. It implements the MaterialWavelengthRangeInterface to indicate that wavelength-dependent material properties will be required for the configured wavelength.

Constructor & Destructor Documentation

OpticalDepthMaterialNormalization()

OpticalDepthMaterialNormalization::OpticalDepthMaterialNormalization ( )

inlineprotected

Default constructor for concrete Item subclass OpticalDepthMaterialNormalization : "normalization by defining the optical depth along a coordinate axis" .

Member Function Documentation

numberAndMass()

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

overridevirtual

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 the user configuration options offered by this class.

Implements MaterialNormalization.

opticalDepth()

OpticalDepthMaterialNormalization::opticalDepth ( ) const

inline

This function returns the value of the discoverable double property opticalDepth : "the optical depth along this axis at this wavelength" .

The minimum value for this property is "]0" .

wavelength()

OpticalDepthMaterialNormalization::wavelength ( ) const

inline

This function returns the value of the discoverable double property wavelength : "the wavelength at which to specify the optical depth" .

This property represents a physical quantity of type "wavelength" .

The minimum value for this property is "1 pm" .

The maximum value for this property is "1 m" .

wavelengthRange()

Range OpticalDepthMaterialNormalization::wavelengthRange ( ) const

overridevirtual

This function returns a wavelength range corresponding to the user-configured wavelength, indicating that wavelength-dependent material properties will be required for this wavelength.

Implements WavelengthRangeInterface.

---

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

• OpticalDepthMaterialNormalization.hpp