HyperboloidShellGeometry Class Reference

#include <HyperboloidShellGeometry.hpp>

Inheritance diagram for HyperboloidShellGeometry:

Public Member Functions
double	density (double R, double z) const override
Position	generatePosition () const override
double	innerOpeningAngle () const
double	innerRealAxis () const
double	outerOpeningAngle () const
double	outerRadialExtent () const
double	outerRealAxis () const
double	SigmaR () const override
double	SigmaZ () const override
Public Member Functions inherited from AxGeometry
virtual double	density (double R, double z) const =0
double	density (Position bfr) const override
int	dimension () const override
virtual double	SigmaR () const =0
double	SigmaX () const override
double	SigmaY () 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
	HyperboloidShellGeometry ()
void	setupSelfBefore () override
Protected Member Functions inherited from AxGeometry
	AxGeometry ()
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 = AxGeometry
using	ItemType = HyperboloidShellGeometry

Private Attributes
double	_A
const double &	_ain
const double &	_aout
double	_bin
double	_bout
double	_cin
double	_cout
const double &	_DeltaIn
const double &	_DeltaOut
double	_Din
const double &	_Dout
double	_innerOpeningAngle
double	_innerRealAxis
double	_outerOpeningAngle
double	_outerRadialExtent
double	_outerRealAxis
double	_zmax

Friends
class	ItemRegistry

Detailed Description

The HyperboloidShellGeometry class is a subclass of the AxGeometry class and describes the geometry defined by two hyperboloid surfaces. It may be used to represent dusty outflows, extending vertically and then flaring towards the outside, asymptotically approaching cone surface.

The current implementation allows only a constant density distribution bounded by two hyperboloid surfaces of the form

$$z=\frac{c}{a}\sqrt{{\rho }^2-a^2}$$

and two horizontal planes paralel to the xy plane, $\pm z_{\text{max}}$. There are five free parameters describing this dust geometry: the radial extent of the outer wall $D_{\text{in}}$, the half opening angles of the outer and inner walls ( ${\mathrm{\Delta }}_{\text{out}},{\mathrm{\Delta }}_{\text{in}}$), the real axes of the outer and inner wall ( $a_{\text{out}},a_{\text{in}}$). The radial extent and half opening angles correspond to the lenght of the side and half opening angle of the cone to which the hyperboloids asymptotically approach to. The real axes are the radii of the hyperboloids bases, i.e. the radii of the cross sections of the hyperboloids with the xy plane. This geometry contains two more parameters, the imaginary radius $c$ and the radius of the hyperboloid top surface, but these values are determined by the other input parameters.

This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

HyperboloidShellGeometry()

HyperboloidShellGeometry::HyperboloidShellGeometry ( )

inlineprotected

Default constructor for concrete Item subclass HyperboloidShellGeometry : "a hyperboloid shell geometry" .

Member Function Documentation

density()

double HyperboloidShellGeometry::density ( double  R, double  z  ) const

overridevirtual

This function returns the density $\rho$ at the cylindrical radius $R$ and height $z$. For the present geometry, it returns a constant density for positions inside the hyperboloid shell, and zero for positions outside the hyperboloid shell.

Implements AxGeometry.

generatePosition()

Position HyperboloidShellGeometry::generatePosition ( ) const

overridevirtual

This function generates a random position from the probability density $p(\mathbf{r})\text{d}\mathbf{r}=\rho (\mathbf{r})\text{d}\mathbf{r}$. Since the current implementation allows only a constant density distribution, a random position can easily be constructed. The function repeatedly generates a uniform random position in the cylinder enveloping the geometry, and accepts the first position that happens to fall inside the nonzero-density region of the actual geometry.

Implements Geometry.

innerOpeningAngle()

HyperboloidShellGeometry::innerOpeningAngle ( ) const

inline

This function returns the value of the discoverable double property innerOpeningAngle : "the half opening angle of the hyperboloid inner wall" .

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

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

The maximum value for this property is "90 deg[" .

innerRealAxis()

HyperboloidShellGeometry::innerRealAxis ( ) const

inline

This function returns the value of the discoverable double property innerRealAxis : "the real axis of the hyperboloid inner wall" .

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

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

outerOpeningAngle()

HyperboloidShellGeometry::outerOpeningAngle ( ) const

inline

This function returns the value of the discoverable double property outerOpeningAngle : "the half opening angle of the hyperboloid outer wall" .

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

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

The maximum value for this property is "90 deg[" .

outerRadialExtent()

HyperboloidShellGeometry::outerRadialExtent ( ) const

inline

This function returns the value of the discoverable double property outerRadialExtent : "the radial extent of the hyperboloid outer wall" .

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

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

outerRealAxis()

HyperboloidShellGeometry::outerRealAxis ( ) const

inline

This function returns the value of the discoverable double property outerRealAxis : "the real axis of the hyperboloid outer wall" .

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

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

setupSelfBefore()

void HyperboloidShellGeometry::setupSelfBefore ( )

overrideprotectedvirtual

This function calculates some frequently used values, including the normalization factor $A$, which is set by the normalization condition that total mass equals one, resulting in

$$A=\frac{3}{2\pi }\frac{1}{z_{\text{max}}(2a_{\text{out}}^2+b_{\text{out}}^2-2a_{\text{in}}^2-b_{\text{in}}^2)},$$

where $b$ is the radius of the hyperboloid top surface (i.e. cross section with $z_{\text{max}}$ plane), determined by the radial extent and the half opening angle.

Reimplemented from Geometry.

SigmaR()

double HyperboloidShellGeometry::SigmaR ( ) const

overridevirtual

This function returns the radial surface density, i.e. the integration of the density along a line in the equatorial plane starting at the centre of the coordinate system,

$${\mathrm{\Sigma }}_R={\int }_0^{\mathrm{\infty }}\rho (R,0,0)\text{d}r.$$

In the case of hyperboloid shell geometry with constant density this is simply

$${\mathrm{\Sigma }}_R=A(a_{\text{max}}-a_{\text{min}}).$$

Implements AxGeometry.

SigmaZ()

double HyperboloidShellGeometry::SigmaZ ( ) const

overridevirtual

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

$${\mathrm{\Sigma }}_Z={\int }_{-\mathrm{\infty }}^{\mathrm{\infty }}\rho (0,0,z)\text{d}z.$$

For the hyperboloid shell geometry this integral is simply zero.

Implements Geometry.

---

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

• HyperboloidShellGeometry.hpp