#include <CellGeometry.hpp>

Inheritance diagram for CellGeometry:

[legend]

Public Types
enum class	MassType : int { MassDensity , Mass , NumberDensity , Number }

Public Member Functions
MassType	massType () const

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

string	filename () const

Position	generatePosition () const override

bool	importMetallicity () const

bool	importTemperature () const

double	maxTemperature () const

int	numSites () const override

double	SigmaX () const override

double	SigmaY () const override

double	SigmaZ () const override

Position	sitePosition (int index) const override

string	useColumns () const

Public Member Functions inherited from GenGeometry
int	dimension () 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

Public Member Functions inherited from SiteListInterface
virtual	~SiteListInterface ()

virtual int	numSites () const =0

virtual Position	sitePosition (int index) const =0

Protected Member Functions
	CellGeometry ()

Snapshot *	createAndOpenSnapshot () override

Protected Member Functions inherited from ImportedGeometry
	ImportedGeometry ()

	~ImportedGeometry ()

virtual Snapshot *	createAndOpenSnapshot ()=0

void	setupSelfAfter () override

Protected Member Functions inherited from GenGeometry
	GenGeometry ()

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

Protected Member Functions inherited from SiteListInterface
	SiteListInterface ()

Private Types
using	BaseType = ImportedGeometry

using	ItemType = CellGeometry

Private Attributes
MassType	_massType

Friends
class	ItemRegistry

Detailed Description

A CellGeometry instance represents a 3D geometry with a spatial density distribution described by a list of cuboidal cells lined up with the coordinate axes; refer to the CellSnapshot class for more information. The cell data is usually extracted from a cosmological simulation snapshot, and it must be provided in a column text file formatted as described below. The total mass in the geometry is normalized to unity after importing the data.

Refer to the description of the TextInFile class for information on overall formatting and on how to include header lines specifying the units for each column in the input file. In case the input file has no unit specifications, the default units mentioned below are used instead. The number of columns in the input file depends on the options configured by the user for this CellGeometry instance:

\[ x_\mathrm{min}\,(\mathrm{pc}) \quad y_\mathrm{min}\,(\mathrm{pc}) \quad z_\mathrm{min}\,(\mathrm{pc}) \quad x_\mathrm{max}\,(\mathrm{pc}) \quad y_\mathrm{max}\,(\mathrm{pc}) \quad z_\mathrm{max}\,(\mathrm{pc}) \quad \{\, \rho\,(\text{M}_\odot\,\text{pc}^{-3}) \;\;|\;\; M\,(\text{M}_\odot) \;\;|\;\; n\,(\text{cm}^{-3}) \;\;|\;\; N\,(1) \,\} \quad [Z\,(1)] \quad [T\,(\mathrm{K})] \]

The first six columns specify the coordinates of the lower-left and upper-right corners of the cell. Depending on the value of the massType option, the seventh column lists the average mass density \(\rho\), the integrated mass \(M\), the average number density \(n\), or the integrated number density \(N\) for the cell. The precise units for this field are irrelevant because the total mass in the geometry will be normalized to unity after importing the data. However, the import procedure still insists on knowing the units.

If the importMetallicity option is enabled, the next column specifies a "metallicity" fraction, which in this context is simply multiplied with the mass/density column to obtain the actual mass/density of the cell. If the importTemperature option is enabled, the next column specifies a temperature. If this temperature is higher than the maximum configured temperature, the mass and density of the cell are set to zero, regardless of the mass or density specified in the seventh column. If the importTemperature option is disabled, or the maximum temperature value is set to zero, such a cutoff is not applied.

Member Enumeration Documentation

◆ MassType

enum class CellGeometry::MassType : int

strong

The enumeration type indicating the type of mass quantity to be imported.

MassDensity : "mass density" .

Mass : "mass (volume-integrated mass density)" .

NumberDensity : "number density" .

Number : "number (volume-integrated number density)" .

Constructor & Destructor Documentation

◆ CellGeometry()

CellGeometry::CellGeometry ( )

inlineprotected

Default constructor for concrete Item subclass CellGeometry : "a geometry imported from cuboidal cell data" .

Member Function Documentation

◆ createAndOpenSnapshot()

Snapshot * CellGeometry::createAndOpenSnapshot ( )

overrideprotectedvirtual

This function constructs a new CellSnapshot object, calls its open() function, configures it to import a mass or density column, and finally returns a pointer to the object. Ownership of the Snapshot object is transferred to the caller.

Implements ImportedGeometry.

◆ massType()

CellGeometry::massType ( ) const

inline

This function returns the value of the discoverable MassType enumeration property massType : "the type of mass quantity to be imported" .

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

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

CellGeometry.hpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends