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

#include <ImportedSourceVelocityProbe.hpp>

Inheritance diagram for ImportedSourceVelocityProbe:
Inheritance graph
[legend]

Protected Member Functions

 ImportedSourceVelocityProbe ()
 
void probeImportedSourceWeighted (string sweight, const vector< const Snapshot * > &snapshots, std::function< double(const Snapshot *snapshot, int m)> weight) override
 
- Protected Member Functions inherited from ImportedSourceWeightedProbe
 ImportedSourceWeightedProbe ()
 
void probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots) override
 
virtual void probeImportedSourceWeighted (string sweight, const vector< const Snapshot * > &snapshots, std::function< double(const Snapshot *snapshot, int m)> weight)=0
 
- Protected Member Functions inherited from InputModelFormProbe
 InputModelFormProbe ()
 
virtual void probeImportedMedium (string sh, const ImportedMedium *medium, const Snapshot *snapshot)
 
virtual void probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots)
 
- 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 ()
 
- Protected Member Functions inherited from MaterialWavelengthRangeInterface
 MaterialWavelengthRangeInterface ()
 
- Protected Member Functions inherited from WavelengthRangeInterface
 WavelengthRangeInterface ()
 

Private Types

using BaseType = ImportedSourceWeightedProbe
 
using ItemType = ImportedSourceVelocityProbe
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Public Types inherited from ImportedSourceWeightedProbe
enum class  Weight : int { Luminosity , InitialMass , CurrentMass }
 
- Public Member Functions inherited from ImportedSourceWeightedProbe
double wavelength () const
 
Range wavelengthRange () const override
 
Weight weight () const
 
- Public Member Functions inherited from InputModelFormProbe
GenericFormform () const
 
void probe () override
 
- 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
 
- Public Member Functions inherited from MaterialWavelengthRangeInterface
virtual WavelengthGridmaterialWavelengthGrid () const
 
- Public Member Functions inherited from WavelengthRangeInterface
virtual ~WavelengthRangeInterface ()
 
virtual Range wavelengthRange () const =0
 
- Protected Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }
 

Detailed Description

ImportedSourceVelocityProbe probes the average bulk velocity of the aggregated imported source components in the simulation, assuming that this information is available for all sources as one of the parameters for the associated SED family. The probe uses the data as represented by the imported snapshot, without involving the spatial grid of the simulation. The velocity is luminosity- or mass-weighted where necessary, i.e. when the probe is associated with a form that projects the quantity along a path, or when two or more smoothed particles in the imported data overlap. The weighting scheme can be user-configured as described for the ImportedSourceWeightedProbe class, from which this class derives.

The probe produces output only if the simulation has at least one source component, if all sources are imported, and if all of these sources offer the velocity property and the properties necessary to perform the requested type of weighting.

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

Constructor & Destructor Documentation

◆ ImportedSourceVelocityProbe()

ImportedSourceVelocityProbe::ImportedSourceVelocityProbe ( )
inlineprotected

Default constructor for concrete Item subclass ImportedSourceVelocityProbe : "imported source: bulk velocity" .

Member Function Documentation

◆ probeImportedSourceWeighted()

void ImportedSourceVelocityProbe::probeImportedSourceWeighted ( string  sweight,
const vector< const Snapshot * > &  snapshots,
std::function< double(const Snapshot *snapshot, int m)>  weight 
)
overrideprotectedvirtual

This function probes the imported source components with the specified snapshots and weight function.

Implements ImportedSourceWeightedProbe.


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