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

#include <MeridionalCutForm.hpp>

Inheritance diagram for MeridionalCutForm:
Inheritance graph
[legend]

Public Member Functions

double azimuth () const
 
int numSamples () const
 
double radius () const
 
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

 MeridionalCutForm ()
 
- Protected Member Functions inherited from GenericForm
 GenericForm ()
 
- 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 = GenericForm
 
using ItemType = MeridionalCutForm
 

Private Attributes

double _azimuth
 
int _numSamples
 
double _radius
 

Friends

class ItemRegistry
 

Detailed Description

MeridionalCutForm represents a generic probe form. Refer to the ProbeFormBridge class for more information about probes and forms.

This particular form outputs a text column file listing the quantity being probed at a number of positions along a meridian (i.e., one half of a great circle) through the spatial domain of the simulation. The half-circle is centered on the origin of the model coordinate system, lies in a meridional plane, and spans all inclinations ( \(0\leq\theta\leq\pi\)). The radius \(r\) and the azimuth \(\varphi\) of the meridian can be configured, and the number of equidistant samples to be taken along the meridian can be specified as well.

The output file contains a line for each sample along the meridian. The first column specifies the inclination \(\theta\), and subsequent column(s) list the quantity being probed.

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

Constructor & Destructor Documentation

◆ MeridionalCutForm()

MeridionalCutForm::MeridionalCutForm ( )
inlineprotected

Default constructor for concrete Item subclass MeridionalCutForm : "a text column file with values along a meridian" .

Member Function Documentation

◆ azimuth()

MeridionalCutForm::azimuth ( ) const
inline

This function returns the value of the discoverable double property azimuth : "the azimuth angle φ of the meridian" .

This property represents a physical quantity of type "posangle" .

The minimum value for this property is "-360 deg" .

The maximum value for this property is "360 deg" .

The default value for this property is given by the conditional value expression "0 deg" .

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

◆ numSamples()

MeridionalCutForm::numSamples ( ) const
inline

This function returns the value of the discoverable integer property numSamples : "the number of samples along the meridian" .

The minimum value for this property is "3" .

The maximum value for this property is "100000" .

The default value for this property is given by the conditional value expression "250" .

◆ radius()

MeridionalCutForm::radius ( ) const
inline

This function returns the value of the discoverable double property radius : "the radius of the circle containing the meridian" .

This property represents a physical quantity of type "length" .

The minimum value for this property is "]0" .

◆ writeQuantity()

void MeridionalCutForm::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: