#include <OpticalMaterialPropertiesProbe.hpp>

Inheritance diagram for OpticalMaterialPropertiesProbe:

[legend]

Protected Member Functions
	OpticalMaterialPropertiesProbe ()

void	probe () override

Protected Member Functions inherited from SpecialtyWavelengthGridProbe
	SpecialtyWavelengthGridProbe ()

Protected Member Functions inherited from SpecialtyProbe
	SpecialtyProbe ()

Protected Member Functions inherited from Probe
	Probe ()

virtual void	initialize ()

virtual void	probe ()=0

virtual When	when () const

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 = SpecialtyWavelengthGridProbe

using	ItemType = OpticalMaterialPropertiesProbe

Friends
class	ItemRegistry

Additional Inherited Members
Public Member Functions inherited from SpecialtyWavelengthGridProbe
WavelengthGrid *	materialWavelengthGrid () const override

WavelengthGrid *	wavelengthGrid () const

Range	wavelengthRange () const override

Public Member Functions inherited from Probe
string	itemName () const override

int	iter () const

string	probeName () const

void	probePrimary (int iter)

void	probeRun ()

void	probeSecondary (int iter)

void	probeSetup ()

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

virtual WavelengthGrid *	materialWavelengthGrid () const

Public Member Functions inherited from WavelengthRangeInterface
virtual	~WavelengthRangeInterface ()

virtual Range	wavelengthRange () const =0

Protected Types inherited from Probe
enum class	When { Setup , Run , Primary , Secondary }

Detailed Description

OpticalMaterialPropertiesProbe outputs column text files listing the key optical properties for the media configured in the simulation, discretized on a specified wavelength grid or on the default instrument wavelength grid. For each medium component, the probe retrieves a representative material mix (the mix at the origin of the model coordinate system) and creates a file with the key optical properties for that mix. The files are named prefix_probe_opticalprops_N.dat where N is replaced with the zero-based index of the medium in the configuration (i.e. in the ski file).

The first line in each file indicates the fundamental material type (i.e. dust, electrons, or gas) and lists the mass per material entity (hydrogen atom or electron) $μ$ , which can be used to convert the cross sections to mass coefficients.

The columns list the key aggregate properties for the material mix as a function of wavelength. In order from left to right, the wavelength $λ$ ; the total extinction, absorption, and scattering cross sections per hydrogen atom (or electron) $ς_{λ}^{ext}, ς_{λ}^{abs}, ς_{λ}^{sca}$ ; the total extinction, absorption, and scattering mass coefficients $κ_{λ}^{ext}, κ_{λ}^{abs}, κ_{λ}^{sca}$ ; the corresponding scattering albedo $ϖ_{λ}$ ; and the mean asymmetry parameter $g_{λ}$ (or zero if not available). See the MaterialMix class for more information.

This item type is displayed only if the Boolean expression "Medium" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ OpticalMaterialPropertiesProbe()

OpticalMaterialPropertiesProbe::OpticalMaterialPropertiesProbe ( )

inlineprotected

Default constructor for concrete Item subclass OpticalMaterialPropertiesProbe : "properties: aggregate optical material properties for each medium" .

Member Function Documentation

◆ probe()

void OpticalMaterialPropertiesProbe::probe ( )

overrideprotectedvirtual

This function performs probing.

Implements Probe.

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

OpticalMaterialPropertiesProbe.hpp

Protected Member Functions

Private Types

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpticalMaterialPropertiesProbe()

Member Function Documentation

◆ probe()