#include <DustAbsorptionPerCellProbe.hpp>

Inheritance diagram for DustAbsorptionPerCellProbe:

[legend]

Public Member Functions
bool	writeWavelengthGrid () const

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

Protected Member Functions
	DustAbsorptionPerCellProbe ()

void	probe () override

When	when () const override

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 ()

Private Types
using	BaseType = SpecialtyProbe

using	ItemType = DustAbsorptionPerCellProbe

Private Attributes
bool	_writeWavelengthGrid

Friends
class	ItemRegistry

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

Detailed Description

DustAbsorptionPerCellProbe outputs a column text file (named prefix_probe_Labs.dat) listing the spectral luminosity \(L_\lambda^\text{abs}\) absorbed by dust for each cell in the spatial grid of the simulation. It is calculated from the mean intensity \(J_\lambda\) as follows,

\[ (L_\lambda^\text{abs})_{\ell,m} = (J_\lambda)_{\ell,m} \,4\pi\,V_m \sum_h^\text{dust} \kappa_{\ell,h}^{abs} \rho_{m,h}\]

where \(\ell\) is the index of the wavelength bin, \(m\) is the spatial cell index, \(V_m\) is the volume of the spatial cell, and the sum represents the dust opacity in the cell.

Specifically, the output file contains a line for each cell in the spatial grid of the simulation. The first columns specifies the cell index, and subsequent columns list the spectral luminosity absorbed by dust for each bin in the wavelength grid returned by the Configuration::radiationFieldWLG() function.

The probe offers an option to output a separate text column file with details on the radiation field wavelength grid. For each wavelength bin, the file lists the characteristic wavelength, the wavelength bin width, and the left and right borders of the bin.

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

Constructor & Destructor Documentation

◆ DustAbsorptionPerCellProbe()

DustAbsorptionPerCellProbe::DustAbsorptionPerCellProbe ( )

inlineprotected

Default constructor for concrete Item subclass DustAbsorptionPerCellProbe : "specialty: spectral luminosity absorbed by dust for each spatial cell" .

Member Function Documentation

◆ probe()

void DustAbsorptionPerCellProbe::probe ( )

overrideprotectedvirtual

This function performs probing after all photon packets have been emitted and detected.

Implements Probe.

◆ when()

When DustAbsorptionPerCellProbe::when ( ) const

overrideprotectedvirtual

This function returns the enumeration Run indicating that probing for this probe should be performed at the end of the simulation.

Reimplemented from Probe.

◆ writeWavelengthGrid()

DustAbsorptionPerCellProbe::writeWavelengthGrid ( ) const

inline

This function returns the value of the discoverable Boolean property writeWavelengthGrid : "output a text file with the radiation field wavelength grid" .

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

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

DustAbsorptionPerCellProbe.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends