#include <ParticleMedium.hpp>

Inheritance diagram for ParticleMedium:

[legend]

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

Public Member Functions
MassType	massType () const

SmoothingKernel *	smoothingKernel () const

Public Member Functions inherited from ImportedMedium
Vec	bulkVelocity (Position bfr) const override

int	dimension () const override

string	filename () const

Position	generatePosition () const override

bool	hasMagneticField () const override

bool	hasMetallicity () const override

bool	hasParameters () const override

bool	hasTemperature () const override

bool	hasVariableMix () const override

bool	hasVelocity () const override

bool	importMagneticField () const

bool	importMetallicity () const

bool	importTemperature () const

bool	importVariableMixParams () const

bool	importVelocity () const

Vec	magneticField (Position bfr) const override

double	mass () const override

double	massDensity (Position bfr) const override

double	massFraction () const

MaterialMix *	materialMix () const

MaterialMixFamily *	materialMixFamily () const

double	maxTemperature () const

double	metallicity (Position bfr) const override

const MaterialMix *	mix () const override

const MaterialMix *	mix (Position bfr) const override

double	number () const override

double	numberDensity (Position bfr) const override

int	numSites () const override

double	opticalDepthX (double lambda) const override

double	opticalDepthY (double lambda) const override

double	opticalDepthZ (double lambda) const override

void	parameters (Position bfr, Array &params) const override

Position	sitePosition (int index) const override

const Snapshot *	snapshot () const

double	temperature (Position bfr) const override

string	useColumns () const

virtual Vec	bulkVelocity (Position bfr) const =0

virtual int	dimension () const =0

virtual Position	generatePosition () const =0

virtual bool	hasMagneticField () const =0

virtual bool	hasMetallicity () const =0

virtual bool	hasParameters () const =0

virtual bool	hasTemperature () const =0

virtual bool	hasVariableMix () const =0

virtual bool	hasVelocity () const =0

virtual Vec	magneticField (Position bfr) const =0

virtual double	mass () const =0

virtual double	massDensity (Position bfr) const =0

virtual double	metallicity (Position bfr) const =0

virtual const MaterialMix *	mix () const =0

virtual const MaterialMix *	mix (Position bfr) const =0

virtual double	number () const =0

virtual double	numberDensity (Position bfr) const =0

virtual double	opticalDepthX (double lambda) const =0

virtual double	opticalDepthY (double lambda) const =0

virtual double	opticalDepthZ (double lambda) const =0

virtual void	parameters (Position bfr, Array &params) const =0

virtual double	temperature (Position bfr) 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
	ParticleMedium ()

Snapshot *	createAndOpenSnapshot () override

Protected Member Functions inherited from ImportedMedium
	ImportedMedium ()

	~ImportedMedium ()

virtual Snapshot *	createAndOpenSnapshot ()=0

void	setupSelfAfter () override

Protected Member Functions inherited from Medium
	Medium ()

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 = ImportedMedium

using	ItemType = ParticleMedium

Private Attributes
MassType	_massType

SmoothingKernel *	_smoothingKernel

Friends
class	ItemRegistry

Detailed Description

A ParticleMedium instance represents a transfer medium with a spatial density distribution (and, optionally, other properties) described by a list of smoothed particles. The particle data is usually extracted from a cosmological simulation snapshot, and it must be provided in a column text file formatted as described below.

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 expected in the input file depends on the options configured by the user for this ParticleMedium instance:

$x (p c) y (p c) z (p c) h (p c) {M (M_{⊙}) | N (1)} [Z (1)] [T (K)] [v_{x} (k m / s) v_{y} (k m / s) v_{z} (k m / s)] [B_{x} (μ G) B_{y} (μ G) B_{z} (μ G)] [\dots mix family params \dots]$

The first three columns are the $x$ , $y$ and $z$ coordinates of the particle, the fourth column is the particle smoothing length $h$ .

The fifth column is the volume-integrated mass $M$ or number $N$ of the particle, depending on the value of the massType option. This mass or number is multiplied by the value of the massFraction option. If the importMetallicity option is enabled, the next column specifies a "metallicity" fraction, which is multiplied with the mass or number column to obtain the actual mass of the particle. If the importTemperature option is enabled, the next column specifies a temperature. If this temperature is higher than the value of the maxTemperature option, the particle is ignored. If the importTemperature option is disabled, or the maximum temperature value is set to zero, the particle is never ignored.

If both the importMetallicity and importTemperature options are enabled, this leads to the following expression for the mass of an imported particle:

$M_{i m p o r t e d} = {\begin{cases} f_{m a s s} Z M & i f T < T_{m a x} o r T_{m a x} = 0 \\ 0 & o t h e r w i s e \end{cases}$

If the importVelocity option is enabled, the subsequent three columns specify the $v_{x}$ , $v_{y}$ , $v_{z}$ velocity components of the particle (considered as the bulk velocity for the mass represented by the particle).

If the importMagneticField option is enabled, the subsequent three columns specify the $B_{x}$ , $B_{y}$ , $B_{z}$ magnetic field vector components for the cell.

Finally, if the importVariableMixParams option is enabled, the remaining columns specify the parameters used by the configured material mix family to select a particular material mix for the particle.

Member Enumeration Documentation

◆ MassType

enum class ParticleMedium::MassType : int

strong

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

Mass : "mass (volume-integrated)" .

Number : "number (volume-integrated)" .

Constructor & Destructor Documentation

◆ ParticleMedium()

ParticleMedium::ParticleMedium ( )

inlineprotected

Default constructor for concrete Item subclass ParticleMedium : "a transfer medium imported from smoothed particle data" .

Member Function Documentation

◆ createAndOpenSnapshot()

Snapshot * ParticleMedium::createAndOpenSnapshot ( )

overrideprotectedvirtual

This function constructs a new ParticleSnapshot object, calls its open() function, configures it to import a mass column, passes the smoothing kernel selected by the user to it, and finally returns a pointer to the object. Ownership of the Snapshot object is transferred to the caller.

Implements ImportedMedium.

◆ massType()

ParticleMedium::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 "Mass" .

◆ smoothingKernel()

ParticleMedium::smoothingKernel ( ) const

inline

This function returns the value of the discoverable item property smoothingKernel : "the kernel for interpolating the smoothed particles" .

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

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

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

ParticleMedium.hpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends