#include <CombineGeometryDecorator.hpp>

Inheritance diagram for CombineGeometryDecorator:

[legend]

Public Member Functions
double	density (Position bfr) const override

int	dimension () const override

Geometry *	firstGeometry () const

double	firstWeight () const

Position	generatePosition () const override

Geometry *	secondGeometry () const

double	secondWeight () 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
	CombineGeometryDecorator ()

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

virtual void	setupSelfAfter ()

virtual void	setupSelfBefore ()

Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = Geometry

using	ItemType = CombineGeometryDecorator

Private Attributes
Geometry *	_firstGeometry

double	_firstWeight

Geometry *	_secondGeometry

double	_secondWeight

double	_w1

double	_w2

Friends
class	ItemRegistry

Detailed Description

The CombineGeometryDecorator class implements a decorator that combines two arbitrary geometries (with a relative weight factor) into an object that behaves as a single geometry.

Constructor & Destructor Documentation

◆ CombineGeometryDecorator()

CombineGeometryDecorator::CombineGeometryDecorator ( )

inlineprotected

Default constructor for concrete Item subclass CombineGeometryDecorator : "a decorator that combines two different geometries" .

Member Function Documentation

◆ density()

double CombineGeometryDecorator::density ( Position bfr ) const

overridevirtual

This function returns the density \(\rho({\bf{r}})\) at the position \({\bf{r}}\). It adds the contribution of the two components, weighted by their weights.

Implements Geometry.

◆ dimension()

int CombineGeometryDecorator::dimension ( ) const

overridevirtual

This function returns the dimension of the combined geometry, which depends on the (lack of) symmetry in the geometries of its stellar components. A value of 1 means spherical symmetry, 2 means axial symmetry and 3 means none of these symmetries. The geometry with the least symmetry (i.e. the highest dimension) determines the result for the whole system.

Implements Geometry.

◆ firstGeometry()

Geometry * CombineGeometryDecorator::firstGeometry ( ) const

inline

This function returns the value of the discoverable item property firstGeometry : "the first geometry" .

◆ firstWeight()

CombineGeometryDecorator::firstWeight ( ) const

inline

This function returns the value of the discoverable double property firstWeight : "the weight of the first geometry" .

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

The default value for this property is given by the conditional value expression "1" .

◆ generatePosition()

Position CombineGeometryDecorator::generatePosition ( ) const

overridevirtual

This function generates a random position from the geometry, by drawing a random point from the three-dimensional probability density \(p({\bf{r}})\, {\text{d}}{\bf{r}} = \rho({\bf{r}})\, {\text{d}}{\bf{r}}\). It first generates a random component, and subsequently generates a random position from this component by calling the corresponding generatePosition() function.

Implements Geometry.

◆ secondGeometry()

Geometry * CombineGeometryDecorator::secondGeometry ( ) const

inline

This function returns the value of the discoverable item property secondGeometry : "the second geometry" .

◆ secondWeight()

CombineGeometryDecorator::secondWeight ( ) const

inline

This function returns the value of the discoverable double property secondWeight : "the weight of the second geometry" .

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

The default value for this property is given by the conditional value expression "1" .

◆ setupSelfBefore()

void CombineGeometryDecorator::setupSelfBefore ( )

overrideprotectedvirtual

This function normalizes the relative weights of the two geometries.

Reimplemented from SimulationItem.

◆ SigmaX()

double CombineGeometryDecorator::SigmaX ( ) const

overridevirtual

This function returns the X-axis surface density, i.e. the integration of the density along the entire X-axis,

\[ \Sigma_X = \int_{-\infty}^\infty \rho(x,0,0)\,{\text{d}}x. \]

It adds the contribution of the two components, weighted by their weights.

Implements Geometry.

◆ SigmaY()

double CombineGeometryDecorator::SigmaY ( ) const

overridevirtual

This function returns the Y-axis surface density, i.e. the integration of the density along the entire Y-axis,

\[ \Sigma_Y = \int_{-\infty}^\infty \rho(0,y,0)\,{\text{d}}y. \]

It adds the contribution of the two components, weighted by their weights.

Implements Geometry.

◆ SigmaZ()

double CombineGeometryDecorator::SigmaZ ( ) const

overridevirtual

This function returns the Z-axis surface density, i.e. the integration of the density along the entire Z-axis,

\[ \Sigma_Z = \int_{-\infty}^\infty \rho(0,0,z)\,{\text{d}}z. \]

It adds the contribution of the two components, weighted by their weights.

Implements Geometry.

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

CombineGeometryDecorator.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CombineGeometryDecorator()

Member Function Documentation

◆ density()

◆ dimension()

◆ firstGeometry()

◆ firstWeight()

◆ generatePosition()

◆ secondGeometry()

◆ secondWeight()

◆ setupSelfBefore()

◆ SigmaX()

◆ SigmaY()

◆ SigmaZ()