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

#include <SpatialGridPlotProbe.hpp>

Inheritance diagram for SpatialGridPlotProbe:
Inheritance graph
[legend]

Protected Member Functions

 SpatialGridPlotProbe ()
 
void probe () 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 = SpecialtyProbe
 
using ItemType = SpatialGridPlotProbe
 

Friends

class ItemRegistry
 

Additional Inherited Members

- 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

SpatialGridPlotProbe outputs text data files that allow plotting the structure of the spatial grid configured for the simulation.

The number of data files written depends on the dimension of the spatial grid: 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. In the latter case, an extra file with three-dimensional information is written as well.

The output files are called prefix_probe_grid_XXX.dat, where XXX is replaced by "xy", "xz", "yz" or "xyz" depending on the file under consideration. Within a file, each line contains two coordinates seperated by whitespace or is empty. Consecutive nonempty lines represent a sequence of "lineto" commands; an empty line marks a "moveto" command.

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

Constructor & Destructor Documentation

◆ SpatialGridPlotProbe()

SpatialGridPlotProbe::SpatialGridPlotProbe ( )
inlineprotected

Default constructor for concrete Item subclass SpatialGridPlotProbe : "properties: data files for plotting the structure of the grid" .

Member Function Documentation

◆ probe()

void SpatialGridPlotProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.


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