#include <SphePowerLawRedistributeGeometryDecorator.hpp>

Inheritance diagram for SphePowerLawRedistributeGeometryDecorator:

[legend]

Public Member Functions
int	dimension () const override

double	exponent () const

double	minRadius () const

Public Member Functions inherited from RedistributeGeometryDecorator
double	density (Position bfr) const override

Position	generatePosition () const override

Geometry *	geometry () const

double	SigmaX () const override

double	SigmaY () const override

double	SigmaZ () const override

virtual double	density (Position bfr) const =0

virtual int	dimension () const =0

virtual Position	generatePosition () const =0

virtual double	SigmaX () const =0

virtual double	SigmaY () const =0

virtual double	SigmaZ () 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

Protected Member Functions
	SphePowerLawRedistributeGeometryDecorator ()

double	maxWeight () const override

double	weight (Position bfr) const override

Protected Member Functions inherited from RedistributeGeometryDecorator
	RedistributeGeometryDecorator ()

virtual double	maxWeight () const =0

void	setupSelfAfter () override

virtual double	weight (Position bfr) const =0

Protected Member Functions inherited from Geometry
	Geometry ()

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 ()

virtual void	setupSelfBefore ()

Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = RedistributeGeometryDecorator

using	ItemType = SphePowerLawRedistributeGeometryDecorator

Private Attributes
double	_exponent

double	_minRadius

Friends
class	ItemRegistry

Detailed Description

The SphePowerLawRedistributeGeometryDecorator class implements a decorator that adjusts another geometry by multiplying the density with a spherical power law weight function

\[ \rho'(r, \theta, \phi) = n \rho(r, \theta, \phi) r^{-p}. \]

There is also a spherical clipping region around the origin determined by a radius \(r_0\) where the density is made zero to cut out the singularity.

Constructor & Destructor Documentation

◆ SphePowerLawRedistributeGeometryDecorator()

SphePowerLawRedistributeGeometryDecorator::SphePowerLawRedistributeGeometryDecorator ( )

inlineprotected

Default constructor for concrete Item subclass SphePowerLawRedistributeGeometryDecorator : "a decorator that redistributes another geometry with a spherical power law" .

Member Function Documentation

◆ dimension()

int SphePowerLawRedistributeGeometryDecorator::dimension ( ) const

overridevirtual

The dimension of the geometry after applying the decorator cannot change and is thus the dimension of the original geometry.

Implements Geometry.

◆ exponent()

SphePowerLawRedistributeGeometryDecorator::exponent ( ) const

inline

This function returns the value of the discoverable double property exponent : "the negative power of the weight function" .

The minimum value for this property is "]0" .

◆ maxWeight()

double SphePowerLawRedistributeGeometryDecorator::maxWeight ( ) const

overrideprotectedvirtual

The max weight, used in the rejection method, is equal to \(r_0^{-p}\) with \(r_0>0\) the radius of the clipping sphere.

Implements RedistributeGeometryDecorator.

◆ minRadius()

SphePowerLawRedistributeGeometryDecorator::minRadius ( ) const

inline

This function returns the value of the discoverable double property minRadius : "the radius of the clipping sphere" .

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

The minimum value for this property is "]0 pc" .

◆ weight()

double SphePowerLawRedistributeGeometryDecorator::weight ( Position bfr ) const

overrideprotectedvirtual

The weight function is the power law: \(r^{-p}\).

Implements RedistributeGeometryDecorator.

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

SphePowerLawRedistributeGeometryDecorator.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends