#include <PointSource.hpp>

Inheritance diagram for PointSource:

[legend]

Public Member Functions
AngularDistribution *	angularDistribution () const
int	geometryDimension () const override
void	launchSpecialty (PhotonPacket pp, size_t historyIndex, double lambda, double Lw, VelocityInterface bvi) const override
PolarizationProfile *	polarizationProfile () const
double	positionX () const
double	positionY () const
double	positionZ () const
Public Member Functions inherited from SpecialtySource
int	dimension () const override
bool	hasVelocity () const override
void	launchNormalized (PhotonPacket *pp, size_t historyIndex, double lambda, double Lw) const override
Vec	velocity () const override
double	velocityX () const
double	velocityY () const
double	velocityZ () const
Public Member Functions inherited from NormalizedSource
void	launch (PhotonPacket *pp, size_t historyIndex, double L) const override
double	luminosity () const override
LuminosityNormalization *	normalization () const
SED *	sed () const
double	specificLuminosity (double wavelength) const override
Range	wavelengthRange () const override
Public Member Functions inherited from Source
virtual void	prepareForLaunch (double sourceBias, size_t firstIndex, size_t numIndices)
double	sourceWeight () const
double	wavelengthBias () const
WavelengthDistribution *	wavelengthBiasDistribution () const
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 WavelengthRangeInterface
virtual	~WavelengthRangeInterface ()
Public Member Functions inherited from VelocityInterface
virtual	~VelocityInterface ()

Protected Member Functions
	PointSource ()
Protected Member Functions inherited from SpecialtySource
	SpecialtySource ()
void	setupSelfBefore () override
Protected Member Functions inherited from NormalizedSource
	NormalizedSource ()
void	setupSelfAfter () override
Protected Member Functions inherited from Source
	Source ()
void	informAvailableWavelengthRange (Range available, string itemType)
Random *	random () const
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
Protected Member Functions inherited from Item
	Item ()
Protected Member Functions inherited from SourceWavelengthRangeInterface
	SourceWavelengthRangeInterface ()
Protected Member Functions inherited from WavelengthRangeInterface
	WavelengthRangeInterface ()
Protected Member Functions inherited from VelocityInterface
	VelocityInterface ()

Private Types
using	BaseType
using	ItemType

Private Attributes
AngularDistribution *	_angularDistribution
PolarizationProfile *	_polarizationProfile
double	_positionX
double	_positionY
double	_positionZ

Friends
class	ItemRegistry

Detailed Description

PointSource represents a primary radiation source that is limited to a single point in space. The spectral distribution is characterized by an SED object, and the bolometric output is characterized by a LuminosityNormalization object. The emitted radiation can be anisotropic (configured through an AngularDistribution object) and/or be polarized (configured through a PolarizationState object). The point source can also have a velocity.

Constructor & Destructor Documentation

◆ PointSource()

PointSource::PointSource ( )

inlineprotected

Default constructor for concrete Item subclass PointSource: "a primary point source".

Member Function Documentation

◆ angularDistribution()

AngularDistribution * PointSource::angularDistribution ( ) const

inline

This function returns the value of the discoverable item property angularDistribution: "the angular luminosity distribution of the emission".

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

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

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

◆ geometryDimension()

int PointSource::geometryDimension ( ) const

overridevirtual

This function returns the dimension of the point source, taking into account anisotropic emission or polarization, if present, but ignoring the velocity (because this is handled in the base class).

Implements SpecialtySource.

◆ launchSpecialty()

void PointSource::launchSpecialty	(	PhotonPacket *	pp,
		size_t	historyIndex,
		double	lambda,
		double	Lw,
		VelocityInterface *	bvi ) const

overridevirtual

This function causes the photon packet pp to be launched from the source using the given history index, wavelength, weighted luminosity contribution, and redshift interface. The position of the emission is determined randomly from the geometry configured for the source. The emission is unpolarized and isotropic; the emission direction is simply sampled from a uniform distribution on the unit sphere.

Implements SpecialtySource.

◆ polarizationProfile()

PolarizationProfile * PointSource::polarizationProfile ( ) const

inline

This function returns the value of the discoverable item property polarizationProfile: "the polarization profile of the emission".

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

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

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

◆ positionX()

double PointSource::positionX ( ) const

inline

This function returns the value of the discoverable double property positionX: "the position of the point source, x component".

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

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

When a value is entered for this property, the names provided by the conditional value expression "positionX:Dimension3" are inserted into the name sets used for evaluating Boolean expressions.

◆ positionY()

double PointSource::positionY ( ) const

inline

This function returns the value of the discoverable double property positionY: "the position of the point source, y component".

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

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

When a value is entered for this property, the names provided by the conditional value expression "positionY:Dimension3" are inserted into the name sets used for evaluating Boolean expressions.

◆ positionZ()

double PointSource::positionZ ( ) const

inline

This function returns the value of the discoverable double property positionZ: "the position of the point source, z component".

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

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

When a value is entered for this property, the names provided by the conditional value expression "positionZ:Dimension2" are inserted into the name sets used for evaluating Boolean expressions.

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

PointSource.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PointSource()

Member Function Documentation

◆ angularDistribution()

◆ geometryDimension()

◆ launchSpecialty()

◆ polarizationProfile()

◆ positionX()

◆ positionY()

◆ positionZ()