SecondarySource Class Reference

#include <SecondarySource.hpp>

Inheritance diagram for SecondarySource:

Public Member Functions
	SecondarySource (SimulationItem *parent)
virtual void	launch (PhotonPacket *pp, size_t historyIndex, double L) const =0
virtual double	prepareLuminosities ()=0
virtual void	preparePacketMap (size_t firstIndex, size_t numIndices)=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

Additional Inherited Members
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 ()

Detailed Description

SecondarySource is the abstract base class for helper classes that handle launching photon packets from a secondary source of a given type, i.e. dust or gas. The class inherits SimulationItem so that, for example, it can easily use the find() template function, but it is not part of the configurable simulation item hierarchy. Instead, the SecondarySourceSystem class creates and holds SecondarySource subclass instances as required depending on the simulation's configuration.

For more information on the operation of this class and its subclasses, see the SecondarySourceSystem class.

Constructor & Destructor Documentation

SecondarySource()

SecondarySource::SecondarySource ( SimulationItem * parent )

explicit

This constructor creates a SecondarySource subclass instance. Before the constructor returns, the newly created object is hooked up as a child to the specified parent in the simulation hierarchy (so it will automatically be deleted).

Member Function Documentation

launch()

virtual void SecondarySource::launch ( PhotonPacket * pp, size_t historyIndex, double L ) const

pure virtual

This function causes the photon packet pp to be launched for this source from one of the cells in the spatial grid using the given history index and luminosity.

Implemented in ContGasSecondarySource, DustSecondarySource, and LineGasSecondarySource.

prepareLuminosities()

virtual double SecondarySource::prepareLuminosities ( )

pure virtual

This function calculates and stores the bolometric luminosities for this source in each spatial cell of the simulation, and returns the grand-total bolometric luminosity for this source.

Implemented in ContGasSecondarySource, DustSecondarySource, and LineGasSecondarySource.

preparePacketMap()

virtual void SecondarySource::preparePacketMap ( size_t firstIndex, size_t numIndices )

pure virtual

This function prepares the mapping of history indices to sources, given the range of history indices allocated to this source .

Implemented in ContGasSecondarySource, DustSecondarySource, and LineGasSecondarySource.

---

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

• SecondarySource.hpp