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

#include <PolarizationProfile.hpp>

Inheritance diagram for PolarizationProfile:
Inheritance graph
[legend]

Public Member Functions

virtual int dimension () 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
 
- Public Member Functions inherited from PolarizationProfileInterface
virtual ~PolarizationProfileInterface ()
 
virtual StokesVector polarizationForDirection (Direction bfk) const =0
 

Protected Member Functions

 PolarizationProfile ()
 
- 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 PolarizationProfileInterface
 PolarizationProfileInterface ()
 

Private Types

using BaseType = SimulationItem
 
using ItemType = PolarizationProfile
 

Friends

class ItemRegistry
 

Detailed Description

An instance of a PolarizationProfile subclass describes the polarization profile of the radiation emitted by a point source into a given direction \((\theta,\phi)\). This class inherits the PolarizationProfileInterface interface offering the polarizationForDirection() function which much be implemented by a subclass.

Constructor & Destructor Documentation

◆ PolarizationProfile()

PolarizationProfile::PolarizationProfile ( )
inlineprotected

Default constructor for abstract Item subclass PolarizationProfile : "a polarized emission profile" .

Member Function Documentation

◆ dimension()

virtual int PolarizationProfile::dimension ( ) const
pure virtual

This function returns the dimension of the polarization profile, which depends on its (lack of) symmetry.

Implemented in NoPolarizationProfile, and SineSquarePolarizationProfile.


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