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

#include <DefaultCutsForm.hpp>

Inheritance diagram for DefaultCutsForm:
Inheritance graph
[legend]

Public Member Functions

 DefaultCutsForm (SimulationItem *parent)
 
void writeQuantity (const ProbeFormBridge *bridge) const override
 
virtual void writeQuantity (const ProbeFormBridge *bridge) 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 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 Member Functions

 DefaultCutsForm ()
 
- Protected Member Functions inherited from SpatialGridForm
 SpatialGridForm ()
 
- Protected Member Functions inherited from Form
 Form ()
 
- 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 = SpatialGridForm
 
using ItemType = DefaultCutsForm
 

Friends

class ItemRegistry
 

Detailed Description

DefaultCutsForm represents a spatial grid-specific probe form. Refer to the ProbeFormBridge class for more information about probes and forms.

This particular form outputs FITS files representing cuts through the spatial domain of the simulated model 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. The number of data files written depends on the geometry 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.

Each of the FITS files contains a number of image frames corresponding to the number of components in a value of the quantity being probed (i.e. 1 for scalar quantities, 3 for vector quantities, and N for compound quantities). In case of a vector quantity, the three image frames representing the velocity vector components in the frame of the cut, i.e. the two components projected on the x and y axes of the cut and the component perpendicular to the cut, where positive values indicate vectors pointing away from the viewer.

This class samples the model at each pixel center in the output cut. Consequently, it ignores small features in the model that intersect the pixel but do not overlap the pixel center. To improve accuracy, decrease the pixel size by increasing the number of pixels along each axis.

Constructor & Destructor Documentation

◆ DefaultCutsForm() [1/2]

DefaultCutsForm::DefaultCutsForm ( )
inlineprotected

Default constructor for concrete Item subclass DefaultCutsForm : "default planar cuts along the coordinate planes" .

◆ DefaultCutsForm() [2/2]

DefaultCutsForm::DefaultCutsForm ( SimulationItem parent)
explicit

This constructor can be invoked programmatically by classes that use a hard-coded form of this type (as opposed to selected through the ski file). Before the constructor returns, the newly created object is hooked up as a child to the specified parent in the simulation hierarchy (so it will automatically be deleted), and its setup() function has been called.

Member Function Documentation

◆ writeQuantity()

void DefaultCutsForm::writeQuantity ( const ProbeFormBridge bridge) const
overridevirtual

This function causes the form to output file(s) as described in the class header for the quantity being probed according to the information provided by the specified ProbeFormBridge instance.

Implements Form.


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