The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | List of all members
PolarizationProfileInterface Class Referenceabstract

#include <PolarizationProfileInterface.hpp>

Inheritance diagram for PolarizationProfileInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~PolarizationProfileInterface ()
 
virtual StokesVector polarizationForDirection (Direction bfk) const =0
 

Protected Member Functions

 PolarizationProfileInterface ()
 

Detailed Description

PolarizationProfileInterface is a pure interface to obtain the polarization state of the radiation emitted by a source into a given direction \((\theta,\phi)\).

Constructor & Destructor Documentation

◆ PolarizationProfileInterface()

PolarizationProfileInterface::PolarizationProfileInterface ( )
inlineprotected

The empty constructor for the interface.

◆ ~PolarizationProfileInterface()

virtual PolarizationProfileInterface::~PolarizationProfileInterface ( )
inlinevirtual

The empty destructor for the interface.

Member Function Documentation

◆ polarizationForDirection()

virtual StokesVector PolarizationProfileInterface::polarizationForDirection ( Direction  bfk) const
pure virtual

This function returns the Stokes vector defining the polarization state of the radiation emitted into the given direction \((\theta,\phi)\). For unpolarized emission, this function would return a default-constructed StokesVector instance.

Implemented in NoPolarizationProfile, and SineSquarePolarizationProfile.


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