AngularDistribution Class Reference

#include <AngularDistribution.hpp>

Inheritance diagram for AngularDistribution:

Public Member Functions
virtual int	dimension () const =0
virtual Direction	generateDirection () const =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
Public Member Functions inherited from AngularDistributionInterface
virtual	~AngularDistributionInterface ()
virtual double	probabilityForDirection (Direction bfk) const =0

Protected Member Functions
	AngularDistribution ()
Random *	random () const
void	setupSelfBefore () override
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
Protected Member Functions inherited from Item
	Item ()
Protected Member Functions inherited from AngularDistributionInterface
	AngularDistributionInterface ()

Private Types
using	BaseType
using	ItemType

Private Attributes
Random *	_random

Friends
class	ItemRegistry

Detailed Description

An instance of an AngularDistribution subclass represents an angular probability distribution \(P(\Omega)\,{\mathrm{d}}\Omega\) that serves to describe the anisotropic emission of a point source. By convention, the probability distribution is normalized on the unit sphere as follows:

\[ \int P(\Omega) \,{\mathrm{d}}\Omega = \int_{\phi=0}^{2\pi} \int_{\theta=0}^{\pi} P(\theta,\phi)\sin\theta \,{\mathrm{d}}\theta \,{\mathrm{d}}\phi = 4\pi.\]

Subclasses must provide a means to obtain the emission probability \(P(\Omega)\) for a given direction \((\theta,\phi)\), and to generate a random direction \((\theta,\phi)\) drawn from the probability distribution \(P(\Omega)\,{\mathrm{d}}\Omega\).

This class inherits the AngularDistributionInterface offering the probabilityForDirection() which much be implemented by a subclass.

Constructor & Destructor Documentation

AngularDistribution()

AngularDistribution::AngularDistribution ( )

inlineprotected

Default constructor for abstract Item subclass AngularDistribution: "an angular emission profile".

Member Function Documentation

dimension()

virtual int AngularDistribution::dimension ( ) const

pure virtual

This function returns the dimension of the angular distribution, which depends on its (lack of) symmetry. A value of 1 means spherical symmetry, 2 means axial symmetry and 3 means none of these symmetries. The function's implementation must be provided in a subclass.

Implemented in AxAngularDistribution, and IsotropicAngularDistribution.

generateDirection()

virtual Direction AngularDistribution::generateDirection ( ) const

pure virtual

This function generates a random direction \((\theta,\phi)\) drawn from the probability distribution \(P(\Omega)\,{\mathrm{d}}\Omega\). The function's implementation must be provided in a subclass.

Implemented in AxAngularDistribution, and IsotropicAngularDistribution.

random()

Random * AngularDistribution::random ( ) const

inlineprotected

This function returns the simulation's random generator as a service to subclasses.

setupSelfBefore()

void AngularDistribution::setupSelfBefore ( )

overrideprotectedvirtual

This function caches the simulation's random generator for use by subclasses.

Reimplemented from SimulationItem.

Reimplemented in AxAngularDistribution, ConicalAngularDistribution, and NetzerAngularDistribution.

---

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

• AngularDistribution.hpp