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

#include <MeshSource.hpp>

Inheritance diagram for MeshSource:
Inheritance graph
[legend]

Public Member Functions

double maxX () const
 
double maxY () const
 
double maxZ () const
 
double minX () const
 
double minY () const
 
double minZ () const
 
- Public Member Functions inherited from ImportedSource
int dimension () const override
 
string filename () const
 
bool hasVelocity () const override
 
bool importCurrentMass () const
 
bool importVelocity () const
 
bool importVelocityDispersion () const
 
void launch (PhotonPacket *pp, size_t historyIndex, double L) const override
 
double luminosity () const override
 
double meanSpecificLuminosity (const Band *band, int m) const
 
double meanSpecificLuminosity (Range wavelengthRange, int m) const
 
void prepareForLaunch (double sourceBias, size_t firstIndex, size_t numIndices) override
 
SEDFamilysedFamily () const
 
const Snapshotsnapshot () const
 
double specificLuminosity (double wavelength) const override
 
double specificLuminosity (double wavelength, int m) const
 
string useColumns () const
 
Range wavelengthRange () const override
 
- Public Member Functions inherited from Source
virtual int dimension () const =0
 
virtual bool hasVelocity () const =0
 
virtual void launch (PhotonPacket *pp, size_t historyIndex, double L) const =0
 
virtual double luminosity () const =0
 
virtual void prepareForLaunch (double sourceBias, size_t firstIndex, size_t numIndices)
 
double sourceWeight () const
 
virtual double specificLuminosity (double wavelength) const =0
 
double wavelengthBias () const
 
WavelengthDistributionwavelengthBiasDistribution () const
 
- 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 WavelengthRangeInterface
virtual ~WavelengthRangeInterface ()
 
virtual Range wavelengthRange () const =0
 

Protected Member Functions

 MeshSource ()
 
const Boxdomain () const
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from ImportedSource
 ImportedSource ()
 
 ~ImportedSource ()
 
virtual SnapshotcreateAndOpenSnapshot ()=0
 
void setupSelfAfter () override
 
- Protected Member Functions inherited from Source
 Source ()
 
void informAvailableWavelengthRange (Range available, string itemType)
 
Randomrandom () const
 
void setupSelfBefore () override
 
- 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 SourceWavelengthRangeInterface
 SourceWavelengthRangeInterface ()
 
- Protected Member Functions inherited from WavelengthRangeInterface
 WavelengthRangeInterface ()
 

Private Types

using BaseType = ImportedSource
 
using ItemType = MeshSource
 

Private Attributes

Box _domain
 
double _maxX
 
double _maxY
 
double _maxZ
 
double _minX
 
double _minY
 
double _minZ
 

Friends

class ItemRegistry
 

Detailed Description

MeshSource is an abstract class for representing a primary radiation source with a luminosity distribution that is discretized on some structured or unstructured tessellation of a cuboidal spatial domain. The class derives from the ImportedSource class, and its main (or only) function is to allow the user to configure the extent of the cuboidal domain of the tessellation. Subclasses need to define the actual tessellation being used, and deal with the other requirements set by the ImportedSource class.

Constructor & Destructor Documentation

◆ MeshSource()

MeshSource::MeshSource ( )
inlineprotected

Default constructor for abstract Item subclass MeshSource : "a primary source imported from mesh-based data" .

Member Function Documentation

◆ domain()

const Box & MeshSource::domain ( ) const
inlineprotected

This function returns the tessellation domain configured for this source.

◆ maxX()

MeshSource::maxX ( ) const
inline

This function returns the value of the discoverable double property maxX : "the end point of the domain in the X direction" .

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

◆ maxY()

MeshSource::maxY ( ) const
inline

This function returns the value of the discoverable double property maxY : "the end point of the domain in the Y direction" .

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

◆ maxZ()

MeshSource::maxZ ( ) const
inline

This function returns the value of the discoverable double property maxZ : "the end point of the domain in the Z direction" .

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

◆ minX()

MeshSource::minX ( ) const
inline

This function returns the value of the discoverable double property minX : "the start point of the domain in the X direction" .

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

◆ minY()

MeshSource::minY ( ) const
inline

This function returns the value of the discoverable double property minY : "the start point of the domain in the Y direction" .

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

◆ minZ()

MeshSource::minZ ( ) const
inline

This function returns the value of the discoverable double property minZ : "the start point of the domain in the Z direction" .

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

◆ setupSelfBefore()

void MeshSource::setupSelfBefore ( )
overrideprotectedvirtual

This function verifies that the configured domain has a positive volume.

Reimplemented from SimulationItem.


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