AxPowerLawRedistributeGeometryDecorator Class Reference

#include <AxPowerLawRedistributeGeometryDecorator.hpp>

Inheritance diagram for AxPowerLawRedistributeGeometryDecorator:

Public Member Functions
int	dimension () const override
double	minR () const
double	minZ () const
double	RExponent () const
double	zExponent () 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
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
	AxPowerLawRedistributeGeometryDecorator ()
double	maxWeight () const override
void	setupSelfAfter () override
double	weight (Position bfr) const override
Protected Member Functions inherited from RedistributeGeometryDecorator
	RedistributeGeometryDecorator ()
void	setupSelfAfter () override
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
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
double	_minR
double	_minZ
const double &	_pR
const double &	_pz
const double &	_R0
double	_RExponent
const double &	_z0
double	_zExponent

Friends
class	ItemRegistry

Detailed Description

The AxPowerLawRedistributeGeometryDecorator class implements a decorator that adjusts another geometry by multiplying the density with an axial power law weight function

\[ \rho'(R, \phi, z) = n \rho(R, \phi, z) R^{-p_R}z^{-p_z}. \]

There are also two clipping regions, one around the z-axis determined by a radius \(R_0\) and one above and below the xy-plane determined by \(z=\pm z_0\), where the density is made zero to cut out the singularity. If an exponent is chosen to be zero, then the clipping region for that exponent will not be prompted during the Q&A.

When an item of this type is used, the names provided by the conditional value expression "Dimension2" are inserted into the name sets used for evaluating Boolean expressions.

Constructor & Destructor Documentation

AxPowerLawRedistributeGeometryDecorator()

AxPowerLawRedistributeGeometryDecorator::AxPowerLawRedistributeGeometryDecorator ( )

inlineprotected

Default constructor for concrete Item subclass AxPowerLawRedistributeGeometryDecorator: "a decorator that redistributes another geometry with an axial power law".

Member Function Documentation

dimension()

int AxPowerLawRedistributeGeometryDecorator::dimension ( ) const

overridevirtual

The dimension of the geometry after applying the decorator can only change spherical geometries into axially symmetric, otherwise it doesn't change the dimension.

Implements Geometry.

maxWeight()

double AxPowerLawRedistributeGeometryDecorator::maxWeight ( ) const

overrideprotectedvirtual

The max weight is used in the rejection method and is equal to \(R_0^{-p_R}z_0^{-p_z}\).

Implements RedistributeGeometryDecorator.

minR()

double AxPowerLawRedistributeGeometryDecorator::minR ( ) const

inline

This function returns the value of the discoverable double property minR: "the radius of the clipping cylinder around the z-axis".

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

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

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

minZ()

double AxPowerLawRedistributeGeometryDecorator::minZ ( ) const

inline

This function returns the value of the discoverable double property minZ: "half the height of the clipping region around the xy-plane".

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

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

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

RExponent()

double AxPowerLawRedistributeGeometryDecorator::RExponent ( ) const

inline

This function returns the value of the discoverable double property RExponent: "the negative power of the radial part of the weight function".

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

setupSelfAfter()

void AxPowerLawRedistributeGeometryDecorator::setupSelfAfter ( )

overrideprotectedvirtual

This function checks if not both the \(R\) and \(z\) exponents are 0.

Reimplemented from SimulationItem.

weight()

double AxPowerLawRedistributeGeometryDecorator::weight ( Position bfr ) const

overrideprotectedvirtual

The weight function is the power law: \(R^{-p_R}z^{-p_z}\).

Implements RedistributeGeometryDecorator.

zExponent()

double AxPowerLawRedistributeGeometryDecorator::zExponent ( ) const

inline

This function returns the value of the discoverable double property zExponent: "the negative power of the vertical part of the weight function".

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

---

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

• AxPowerLawRedistributeGeometryDecorator.hpp