The SKIRT project
advanced radiative transfer for astrophysics
Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
ConvergenceCutsProbe Class Reference

#include <ConvergenceCutsProbe.hpp>

Inheritance diagram for ConvergenceCutsProbe:
Inheritance graph
[legend]

Protected Member Functions

 ConvergenceCutsProbe ()
 
void probe () override
 
void setupSelfBefore () override
 
- 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 ()
 
virtual void probe ()=0
 
virtual When when () const
 
- 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 = SpecialtyWhenProbe
 
using ItemType = ConvergenceCutsProbe
 

Private Attributes

Form_form
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Public Types inherited from SpecialtyWhenProbe
enum class  ProbeAfter : int { Setup , Run }
 
- 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
 
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 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
 
- Protected Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }
 

Detailed Description

ConvergenceCutsProbe outputs FITS files with cuts through the true input media density and the grid-discretized media density along the coordinate planes. The field of view of each cut covers the extent of the spatial grid in the simulation in the relevant directions. Each cut has 1024 x 1024 pixels. This information is useful as a first check of the simulation configuration and specifically for evaluating the discretization quality of the configured spatial grid.

The number of data files written depends on the geometry and material contents of the medium system. For spherical symmetry only the intersection with the xy plane is written, for axial symmetry the intersections with the xy and xz planes are written, and for general geometries all three intersections are written. Also, a separate set of files is produced for each material type (dust, electrons, or gas). The files for dust provide the dust mass density, and those for electrons and gas provide the electron or hydrogen number density. Multiple media components containing the same material type are combined, regardless of ordering.

The difference between the true input density maps (named prefix_probe_MM_t_XX.fits) and the grid-discretized density maps (named prefix_probe_MM_g_XX.fits) is the following: the true input density is the density represented by the input model configured in the media system, i.e. the true density that would correspond to an infinitely fine spatial grid. The grid-discretized density maps on the other hand give the value of the density as read from the finite-resolution spatial grid in the simulation. A comparison of both sets of maps can reveal whether the configured spatial grid is suitable (in the ideal case, there would be no difference between both sets of maps).

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

◆ ConvergenceCutsProbe()

ConvergenceCutsProbe::ConvergenceCutsProbe ( )
inlineprotected

Default constructor for concrete Item subclass ConvergenceCutsProbe : "convergence: cuts of the medium density along the coordinate planes" .

Member Function Documentation

◆ probe()

void ConvergenceCutsProbe::probe ( )
overrideprotectedvirtual

This function performs the probing.

Implements Probe.

◆ setupSelfBefore()

void ConvergenceCutsProbe::setupSelfBefore ( )
overrideprotectedvirtual

This function constructs the default cuts form used by this class.

Reimplemented from SimulationItem.


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