The SKIRT project
advanced radiative transfer for astrophysics
SpatialCellPropertiesProbe Class Reference

#include <SpatialCellPropertiesProbe.hpp>

Inheritance diagram for SpatialCellPropertiesProbe:

Protected Member Functions

 SpatialCellPropertiesProbe ()
void probe () override
Protected Member Functions inherited from SpecialtyWavelengthProbe
 SpecialtyWavelengthProbe ()
Protected Member Functions inherited from SpecialtyWhenProbe
 SpecialtyWhenProbe ()
When when () const override
Protected Member Functions inherited from SpecialtyProbe
 SpecialtyProbe ()
Protected Member Functions inherited from Probe
 Probe ()
virtual void initialize ()
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 MaterialWavelengthRangeInterface
 MaterialWavelengthRangeInterface ()
Protected Member Functions inherited from WavelengthRangeInterface
 WavelengthRangeInterface ()

Private Types

using BaseType
using ItemType

Friends

class ItemRegistry

Additional Inherited Members

Public Types inherited from SpecialtyWhenProbe
enum class  ProbeAfter : int { Setup , Run }
Public Member Functions inherited from SpecialtyWavelengthProbe
double wavelength () const
Range wavelengthRange () const override
Public Member Functions inherited from SpecialtyWhenProbe
ProbeAfter probeAfter () const
Public Member Functions inherited from Probe
string itemName () const override
int iter () const
string probeName () const
void probePrimary (int iter)
void probeRun ()
void probeSecondary (int iter)
void probeSetup ()
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
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 ItemgetItemProperty (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)
Itemoperator= (const Item &)=delete
Itemparent () 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 MaterialWavelengthRangeInterface
virtual WavelengthGridmaterialWavelengthGrid () const
Public Member Functions inherited from WavelengthRangeInterface
virtual ~WavelengthRangeInterface ()
Protected Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }

Detailed Description

SpatialCellPropertiesProbe outputs a column text file, named prefix_probe_cellprops.dat, which contains a line for each cell in the spatial grid of the simulation. Each line contains columns representing the following cell properties: cell index, x,y,z coordinates of the cell center, volume, total optical depth of the cell diagonal at a user-configured wavelength (for all material types combined), dust mass density, electron number density, and (gas) hydrogen number density.

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

Constructor & Destructor Documentation

◆ SpatialCellPropertiesProbe()

SpatialCellPropertiesProbe::SpatialCellPropertiesProbe ( )
inlineprotected

Default constructor for concrete Item subclass SpatialCellPropertiesProbe: "properties: basic info for each spatial cell".

Member Function Documentation

◆ probe()

void SpatialCellPropertiesProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.


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