IsotropicAngularDistribution Class Reference

#include <IsotropicAngularDistribution.hpp>

Inheritance diagram for IsotropicAngularDistribution:

Public Member Functions
int	dimension () const override
Direction	generateDirection () const override
double	probabilityForDirection (Direction bfk) const override
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 ()

Protected Member Functions
	IsotropicAngularDistribution ()
Protected Member Functions inherited from AngularDistribution
	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

Friends
class	ItemRegistry

Detailed Description

The IsotropicAngularDistribution describes a uniform (isotropic) angular probability distribution that serves to describe the emission of a point source.

Constructor & Destructor Documentation

IsotropicAngularDistribution()

IsotropicAngularDistribution::IsotropicAngularDistribution ( )

inlineprotected

Default constructor for concrete Item subclass IsotropicAngularDistribution: "an isotropic emission profile".

Member Function Documentation

dimension()

int IsotropicAngularDistribution::dimension ( ) const

overridevirtual

This function returns the dimension of the angular distribution, which depends on its (lack of) symmetry. The isotropic distribution is spherically symmetric, so the function returns

Implements AngularDistribution.

generateDirection()

Direction IsotropicAngularDistribution::generateDirection ( ) const

overridevirtual

This function generates a random direction drawn from the probability distribution. For the isotropic distribution this is uniform on the unit sphere.

Implements AngularDistribution.

probabilityForDirection()

double IsotropicAngularDistribution::probabilityForDirection ( Direction bfk ) const

overridevirtual

This function returns the probability for the given direction, which for this isotropic distribution is always 1.

Implements AngularDistributionInterface.

---

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

• IsotropicAngularDistribution.hpp