#include <ImportedSourceWeightedProbe.hpp>

Inheritance diagram for ImportedSourceWeightedProbe:

[legend]

Public Types
enum class	Weight : int { Luminosity , InitialMass , CurrentMass }

Public Member Functions
double	wavelength () const
Range	wavelengthRange () const override
Weight	weight () const
Public Member Functions inherited from InputModelFormProbe
GenericForm *	form () const
void	probe () 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
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 ()

Protected Member Functions
	ImportedSourceWeightedProbe ()
void	probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots) override
virtual void	probeImportedSourceWeighted (string sweight, const vector< const Snapshot * > &snapshots, std::function< double(const Snapshot *snapshot, int m)> weight)=0
Protected Member Functions inherited from InputModelFormProbe
	InputModelFormProbe ()
virtual void	probeImportedMedium (string sh, const ImportedMedium medium, const Snapshot snapshot)
Protected Member Functions inherited from Probe
	Probe ()
virtual void	initialize ()
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
using	ItemType

Private Attributes
double	_wavelength
Weight	_weight

Friends
class	ItemRegistry

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

Detailed Description

ImportedSourceWeightedProbe is an abstract base class for imported source probes that average the probed quantity along a path rather than accumulating it. This class offers the options that allow the user to configure the weighting mechanism. There are three choices: using the specific luminosity at a given wavelength, using initial mass, or using current mass.

The probes based on this class produce output only if the simulation has at least one source component, if all sources are imported, and if all of these sources offer the properties necessary to perform the requested type of weighting.

Luminosity weighting can be accomplished regardless of the configured SED family as long as the source's spectral range includes the specified wavelength.

For stellar mass weighting, the situation is more complicated. The current stellar mass distribution of the source component is usually not automatically available to the SKIRT input model. SED families that model single stellar populations (e.g. BruzualCharlotSEDFamily, FSPSSEDFamily) often require the initial stellar mass of the population as an input parameter, as opposed to the current stellar mass. Many other SED families (e.g. MappingsSEDFamily, CastelliKuruczSEDFamily, BlackBodySEDFamily) do not rely (directly) on stellar mass information at all.

Therefore this probe offers two mass weighting options. When set to InitialMass, the probe will use the initial mass imported as one of the SED family parameters as a suboptimal solution. However, assuming that the current mass can be obtained when preparing SKIRT's input data, a better solution is to provide it as a separate, additional column to the import process, enable the importCurrentMass option for the ImportedSource component, and set the weight option for the probe to CurrentMass. Now the probe will use the separately imported current mass.

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

Member Enumeration Documentation

◆ Weight

enum class ImportedSourceWeightedProbe::Weight : int

strong

The enumeration type specifying whether to average the probed quantity using luminosity, initial mass or current mass.

Luminosity : "luminosity".

InitialMass : "initial mass".

CurrentMass : "current mass".

Constructor & Destructor Documentation

◆ ImportedSourceWeightedProbe()

ImportedSourceWeightedProbe::ImportedSourceWeightedProbe ( )

inlineprotected

Default constructor for abstract Item subclass ImportedSourceWeightedProbe: "an imported source weighted probe".

Member Function Documentation

◆ probeImportedSources()

void ImportedSourceWeightedProbe::probeImportedSources	(	const vector< const ImportedSource * > &	sources,
		const vector< const Snapshot * > &	snapshots )

overrideprotectedvirtual

This function is implemented here. It defines an appropriate weight function and calls the probeImportedSourceWeighted() function implemented in the subclass to implement the actual probing.

Reimplemented from InputModelFormProbe.

◆ probeImportedSourceWeighted()

virtual void ImportedSourceWeightedProbe::probeImportedSourceWeighted	(	string	sweight,
		const vector< const Snapshot * > &	snapshots,
		std::function< double(const Snapshot *snapshot, int m)>	weight )

protectedpure virtual

This function should be implemented by each subclass. The first argument is a string representation of the weighting scheme. The last argument is a call-back function that returns the weight for the entity with the given index in the snapshot, again according to the user configuration.

Implemented in ImportedSourceAgeProbe, ImportedSourceMetallicityProbe, and ImportedSourceVelocityProbe.

◆ wavelength()

double ImportedSourceWeightedProbe::wavelength ( ) const

inline

This function returns the value of the discoverable double property wavelength: "the wavelength at which to determine the luminosity".

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".

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

This property is relevant only if the Boolean expression "weightLuminosity" evaluates to true after replacing the names by true or false depending on their presence.

◆ wavelengthRange()

Range ImportedSourceWeightedProbe::wavelengthRange ( ) const

overridevirtual

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

Implements WavelengthRangeInterface.

◆ weight()

Weight ImportedSourceWeightedProbe::weight ( ) const

inline

This function returns the value of the discoverable Weight enumeration property weight: "weight for averaging the probed quantity".

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

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

ImportedSourceWeightedProbe.hpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Additional Inherited Members