LaserAngularDistribution Class Reference

#include <LaserAngularDistribution.hpp>

Inheritance diagram for LaserAngularDistribution:

Public Member Functions
double	generateInclinationCosine () const override
double	probabilityForInclinationCosine (double costheta) const override
Public Member Functions inherited from AxAngularDistribution
int	dimension () const override
Direction	generateDirection () const override
double	probabilityForDirection (Direction bfk) const override
double	symmetryX () const
double	symmetryY () const
double	symmetryZ () 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 AngularDistributionInterface
virtual	~AngularDistributionInterface ()

Protected Member Functions
	LaserAngularDistribution ()
Protected Member Functions inherited from AxAngularDistribution
	AxAngularDistribution ()
void	setupSelfBefore () override
Protected Member Functions inherited from AngularDistribution
	AngularDistribution ()
Random *	random () const
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 LaserAngularDistribution class describes the axisymmetric angular emission distribution for a point source that emits all its radiation in a single direction, namely towards the positive symmetry axis configured in the base class. In other words, the probability distribution is a Dirac delta function, \(4\pi\delta({\bf{k}}-{\bf{e}}_\mathrm{sym})\).

Constructor & Destructor Documentation

LaserAngularDistribution()

LaserAngularDistribution::LaserAngularDistribution ( )

inlineprotected

Default constructor for concrete Item subclass LaserAngularDistribution: "a laser emission profile".

Member Function Documentation

generateInclinationCosine()

double LaserAngularDistribution::generateInclinationCosine ( ) const

overridevirtual

This function generates a random inclination cosine relative to the symmetry axis, drawn from the angular probability distribution. In this case, the function returns \(\cos\theta=1\), which is equivalent to \(\theta=0\).

Implements AxAngularDistribution.

probabilityForInclinationCosine()

double LaserAngularDistribution::probabilityForInclinationCosine ( double costheta ) const

overridevirtual

This function returns the normalized probability for a given inclination cosine \(\cos\theta\) relative to the symmetry axis. In this case, the function returns infinity if \(\theta=0\), or equivalently \(\cos\theta=1\), and zero in all other cases.

Implements AxAngularDistribution.

---

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

• LaserAngularDistribution.hpp