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

#include <TreeSpatialGridTopologyProbe.hpp>

Inheritance diagram for TreeSpatialGridTopologyProbe:
Inheritance graph
[legend]

Protected Member Functions

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

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

TreeSpatialGridTopologyProbe outputs a text data file representing the topology (i.e. the subdivision structure) of the tree grid used to discretize the spatial domain in the simulation. The resulting data file can be loaded by a FileTreeSpatialGrid instance to recreate a grid in another simulation that is identical to the one in the current simulation. This can be useful in situations where multiple simulations are being performed on input models with the same (or a very similar) spatial distribution of the transfer medium. Constructing a tree grid based on the medium density distribution takes time (because of the large number of density samples required), and the tree is likely to differ slightly between various runs (because the density is sampled at random positions, and the random number sequence varies because of parallelization). Loading the tree from the topology data file is much faster and guarantees that all simulations use identical tree grids. Note that the topology data stored in the file is scale-free; the simulation loading the topology must define the extent of the spatial domain.

The output file is called prefix_probe_treetop.dat. After a brief descriptive header, the file contains lines with just a single integer number. The first line specifies the number of children for each nonleaf node (2 for a binary tree, 8 for an octtree, or 0 if the root node is not subdivided). The second line contains 1 if the root node is subdivided, or 0 if not. The following lines similarly contain 1 or 0 indicating subdivision for any children of the preceding node, recursively, in a depth-first traversal of the tree.

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

Constructor & Destructor Documentation

◆ TreeSpatialGridTopologyProbe()

TreeSpatialGridTopologyProbe::TreeSpatialGridTopologyProbe ( )
inlineprotected

Default constructor for concrete Item subclass TreeSpatialGridTopologyProbe : "specialty: data file representing the topology of the tree spatial grid" .

Member Function Documentation

◆ probe()

void TreeSpatialGridTopologyProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.


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