Gyoto
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | Private Attributes | Friends | List of all members
Gyoto::Astrobj::Python::ThinDisk Class Reference

Coding a Gyoto::Astrobj::ThinDisk in Python. More...

#include <GyotoPython.h>

Inheritance diagram for Gyoto::Astrobj::Python::ThinDisk:
Gyoto::Astrobj::ThinDisk Gyoto::Python::Base Gyoto::Astrobj::Generic Gyoto::Functor::Double_constDoubleArray Gyoto::SmartPointee Gyoto::Object

Public Types

typedef Gyoto::SmartPointer< Gyoto::SmartPointeeSubcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &)
 A subcontractor builds an object upon order from the Factory. More...
 

Public Member Functions

virtual Property const * getProperties () const
 Get list of properties. More...
 
 ThinDisk (const ThinDisk &)
 
 ~ThinDisk ()
 Destructor.
 
ThinDiskclone () const
 Cloner. More...
 
virtual double emission (double nu_em, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
 Specific intensity Iν More...
 
virtual void emission (double Inu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
 Specific intensity Iν for several values of νem More...
 
virtual double integrateEmission (double nu1, double nu2, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const
 ν1ν2 Iν dν (or jν) More...
 
virtual void integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, state_t const &cph, double const *co) const
 ν1ν2 Iν dν (or jν) More...
 
virtual double transmission (double nuem, double dsem, state_t const &cph, double const *co) const
 
virtual double operator() (double const coord[4])
 
virtual void getVelocity (double const pos[4], double vel[4])
 Get fluid 4-velocity at point. More...
 
virtual std::string module () const
 Return module_.
 
virtual void module (const std::string &)
 Set module_ and import the Python module. More...
 
virtual std::string inlineModule () const
 Return inline_module_.
 
virtual void inlineModule (const std::string &)
 Set inline_module_ and import the Python module. More...
 
virtual std::string klass () const
 Retrieve class_.
 
virtual void klass (const std::string &)
 Set class_ and instantiate the Python class. More...
 
virtual std::vector< double > parameters () const
 Retrieve parameters_.
 
virtual void parameters (const std::vector< double > &)
 Set parameters_ and send them to pInstance_. More...
 
virtual double innerRadius () const
 Get rin_.
 
virtual double innerRadius (std::string const &) const
 Get rin_.
 
virtual void innerRadius (double)
 Set rin_.
 
virtual void innerRadius (double, std::string const &)
 Set rin_.
 
virtual double outerRadius () const
 Get rout_.
 
virtual double outerRadius (std::string const &) const
 Get rout_.
 
virtual void outerRadius (double)
 Set rout_.
 
virtual void outerRadius (double, std::string const &)
 Set rout_.
 
virtual double thickness () const
 Get thickness_.
 
virtual double thickness (std::string const &) const
 Get thickness_.
 
virtual void thickness (double)
 Set thickness_.
 
virtual void thickness (double, std::string const &)
 Set thickness_.
 
virtual int dir () const
 Get dir_.
 
virtual void dir (int)
 Set dir_.
 
virtual bool corotating () const
 
virtual void corotating (bool t)
 Get dir_==1.
 
virtual std::string velocityKind () const
 Set dir_=t?1:-1. More...
 
virtual void velocityKind (std::string const &)
 Set VelocityKind.
 
virtual double operator() (double const coord[])
 theta-pi/2 or z More...
 
virtual double projectedRadius (double const coord[]) const
 Projected radius of position coord on the equatorial plane.
 
virtual double sphericalPhi (double const coord[]) const
 Longitude.
 
virtual int Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL)
 Does a photon at these coordinates impact the object? More...
 
virtual SmartPointer< Metric::Genericmetric () const
 Get the Metric gg_.
 
virtual void metric (SmartPointer< Metric::Generic >)
 Set the Metric gg_.
 
virtual double rMax ()
 Get maximal distance from center of coordinate system. More...
 
virtual double rMax () const
 Get maximal distance from center of coordinate system.
 
virtual double rMax (std::string const &unit)
 Get rmax_ is specified unit. More...
 
virtual double rMax (std::string const &unit) const
 Get rmax_ is specified unit.
 
virtual void rMax (double val)
 Set maximal distance from center of coordinate system. More...
 
virtual void rMax (double val, std::string const &unit)
 Set maximal distance from center of coordinate system. More...
 
virtual double deltaMax (double coord[8])
 Get max step constraint for adaptive integration. More...
 
const std::string kind () const
 Get the kind of the Astrobj (e.g. "Star")
 
 GYOTO_OBJECT_ACCESSORS_UNIT (deltaMaxInsideRMax)
 
void opticallyThin (bool flag)
 Set whether the object is optically thin. More...
 
bool opticallyThin () const
 Query whether object is optically thin. More...
 
void showshadow (bool flag)
 
bool showshadow () const
 
void redshift (bool flag)
 
bool redshift () const
 
virtual Gyoto::Quantity_t getDefaultQuantities ()
 Which quantities to compute if know was requested. More...
 
virtual void setParameters (FactoryMessenger *fmp)
 Main loop in Subcontractor_t function. More...
 
virtual void processHitQuantities (Photon *ph, state_t const &coord_ph_hit, double const *coord_obj_hit, double dt, Astrobj::Properties *data) const
 Fills Astrobj::Properties. More...
 
virtual void processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const =delete
 
virtual double emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
 Obsolete, update your code;.
 
virtual void emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
 Obsolete, update your code.
 
virtual void radiativeQ (double Inu[], double Taunu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
 emission and transmission together
 
virtual void radiativeQ (double Inu[], double Taunu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
 
virtual void radiativeQ (double *Inu, double *Qnu, double *Unu, double *Vnu, double *alphaInu, double *alphaQnu, double *alphaUnu, double *alphaVnu, double *rQnu, double *rUnu, double *rVnu, double const *nuem, size_t nbnu, double dsem, state_t const &cph, double const *co) const
 
virtual double integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const =delete
 Obsolete, update your code.
 
virtual void integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, double *cph, double *co) const =delete
 Obsolete, update your code.
 
virtual double transmission (double nuem, double dsem, state_t const &coord_ph, double const coord_obj[8]) const
 Transmission: exp( αν * dsem ) More...
 
virtual double transmission (double nuem, double dsem, state_t const &coord) const =delete
 Obsolete, update your code.
 
virtual double transmission (double nuem, double dsem, double coord[8]) const =delete
 Obsolete, update your code.
 
void incRefCount ()
 Increment the reference counter. Warning: Don't mess with the counter.
 
int decRefCount ()
 Decrement the reference counter and return current value. Warning: Don't mess with the counter.
 
int getRefCount ()
 Get the current number of references.
 
virtual bool isThreadSafe () const
 Whether this class is thread-safe. More...
 
void set (Property const &p, Value val)
 Set Value of a Property.
 
void set (Property const &p, Value val, std::string const &unit)
 Set Value (expressed in unit) of a Property.
 
void set (std::string const &pname, Value val)
 Set Value of a Property.
 
void set (std::string const &pname, Value val, std::string const &unit)
 Set Value (expressed in unit) of a Property.
 
Value get (Property const &p) const
 Get Value of a Property.
 
Value get (std::string const &pname) const
 Get Value of a Property.
 
Value get (Property const &p, std::string const &unit) const
 Get Value of a Property, converted to unit.
 
Value get (std::string const &pname, std::string const &unit) const
 Get Value of a Property, converted to unit.
 
Property const * property (std::string const pname) const
 Find property by name. More...
 
virtual void fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
 Output a single Property to XML. More...
 
virtual void fillElement (Gyoto::FactoryMessenger *fmp) const
 Fill the XML element for this Object. More...
 
virtual int setParameter (std::string name, std::string content, std::string unit)
 Set parameter by name. More...
 
virtual void setParameter (Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit)
 Set parameter by Property (and name) More...
 
std::string describeProperty (Gyoto::Property const &p) const
 Format desrciption for a property. More...
 
void help () const
 Print (to stdout) some help on this class. More...
 

Public Attributes

 GYOTO_OBJECT_THREAD_SAFETY
 

Static Public Attributes

static GYOTO_OBJECT Property const properties []
 

Protected Attributes

double rin_
 disk inner radius in geometrical units
 
double rout_
 disk outer radius in geometrical units
 
double thickness_
 disk thickness More...
 
int dir_
 1 for corotating (default), -1 for counterrotating.
 
unsigned int velocitykind_
 tag for VelocityKind
 
SmartPointer< Gyoto::Metric::Genericgg_
 The Metric in this end of the Universe.
 
double rmax_
 Maximum distance to the center of the coordinate system [geometrical units]. More...
 
double deltamaxinsidermax_
 Maximum Photon integration step inside rmax_ [geometrical units]. More...
 
bool flag_radtransf_
 1 if radiative transfer inside Astrobj, else 0
 
int shadow_
 1 to highlight the shadow region in the image
 
int noredshift_
 1 to impose redshift factor g = 1
 
std::string kind_
 The "kind" that is output in the XML entity. More...
 
std::vector< std::string > plugins_
 The plug-ins that needs to be loaded to access this instance's class. More...
 
std::string module_
 Name of the Python module that holds the class. More...
 
std::string inline_module_
 Python source code for module that holds the class.
 
std::string class_
 Name of the Python class that we want to expose. More...
 
std::vector< double > parameters_
 Parameters that this class needs. More...
 
PyObject * pModule_
 Reference to the python module once it has been loaded.
 
PyObject * pInstance_
 Reference to the python instance once it has been instantiated.
 

Private Attributes

PyObject * pEmission_
 
PyObject * pIntegrateEmission_
 
PyObject * pTransmission_
 
PyObject * pCall_
 
PyObject * pGetVelocity_
 
PyObject * pGiveDelta_
 
bool pEmission_overloaded_
 
bool pIntegrateEmission_overloaded_
 

Friends

class Gyoto::SmartPointer< Gyoto::Astrobj::Python::ThinDisk >
 

Detailed Description

Coding a Gyoto::Astrobj::ThinDisk in Python.

Sample XML file:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Scenery>
This example shows how to code a spectrum in Python directly in the
XML file.
<Metric kind = "KerrBL">
<Spin> 0. </Spin>
</Metric>
<Screen>
<Position> 1000. 100. 1.22 0. </Position>
<Time unit="geometrical_time"> 1000. </Time>
<FieldOfView> 0.314159265358979323846264338327950288419716 </FieldOfView>
<Resolution> 32 </Resolution>
</Screen>
<Astrobj kind = "Python::ThinDisk">
Python::ThinDisk inherits from ThinDisk, we can set the usual
parameters:
<InnerRadius> 3. </InnerRadius>
<OpticallyThin/>
We could write a python module in a separate file, say
"gyoto_sample_spectra.py", and use the "Module" entity to load it:
<!--Module>gyoto_sample_spectra</Module-->
Alternatively, we can put the Python code inline using the
"InlineModule" entity. Common indentation will be removed so we
don't have to flush everything left .
<InlineModule>
class ThinDisk:
def emission(self, nuem, dsem, cph, co):
return dsem
</InlineModule>
Since there is only one class in the module, we do not need to
specify the class name here:
<!--Class>ThinDisk</Class-->
</Astrobj>
<MinimumTime> 0. </MinimumTime>
</Scenery>

Sample Python module:

'''Sample Astrobj::ThinDisk for using with Gyoto Python plug-in
Those classes demonstrate how to use Python classes as Gyoto
Astrobj::ThibDisk implementations using Gyoto's "python"
plug-in. Note that this plug-in can be renamed to whatever matches
the particular version of Python it has been built against
(e.g. python3.4).
The goal is to be able to instantiate these from XML, from
Yorick... and even from Python using the gyoto extension...
Synopsis:
import gyoto.core
gyoto.core.requirePlugin("python") # or python2.7 or python3.4...
td=gyoto.core.Astrobj("Python::ThinDisk")
td.set("Module", "gyoto_sample_thindisks")
td.set("Class", "ThinDisk")
Classes that aim at implementing the Gyoto::Astrobj::ThinDisk
interface do so by providing the following methods:
getVelocity, giveDelta, emission, integrateEmission, transmission,
__setitem__:
optional.
emission and integrateEmission can be overloaded by using the
varargs argument.
'''
class ThinDisk:
'''A ThinDisk with trivial emission
'''
def emission(self, nuem, dsem, cph, co):
return dsem

Member Typedef Documentation

◆ Subcontractor_t

typedef Gyoto::SmartPointer<Gyoto::SmartPointee> Gyoto::SmartPointee::Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &)
inherited

A subcontractor builds an object upon order from the Factory.

Various classes need to provide a subcontractor to be able to instantiate themselves upon order from the Factory. A subcontractor is a function (often a static member function) which accepts a pointer to a FactoryMessenger as unique parameter, communicates with the Factory using this messenger to read an XML description of the object to build, and returns this objet. SmartPointee::Subcontractor_t* is just generic enough a typedef to cast to and from other subcontractor types: Astrobj::Subcontractor_t, Metric::Subcontractor_t, Spectrum::Subcontractor_t. A subcontractor needs to be registered using the relevant Register() function: Astrobj::Register(), Metric::Register(), Spectrum::Register().

Member Function Documentation

◆ clone()

ThinDisk* Gyoto::Astrobj::Python::ThinDisk::clone ( ) const
virtual

Cloner.

This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:

SmartPointer<Astrobj> deep_copy = original->clone();

Cloning is necessary for multi-threading, recommended for interaction with the Yorick plug-in etc.

Implementing it is very straightforward, as long as the copy constructor Generic(const Generic& ) has been implemented:

MyAstrobj* MyAstrobj::clone() const { return new MyAstrobj(*this); }

Reimplemented from Gyoto::Astrobj::ThinDisk.

◆ deltaMax()

virtual double Gyoto::Astrobj::Generic::deltaMax ( double  coord[8])
virtualinherited

Get max step constraint for adaptive integration.

Parameters
[in]coordposition
Returns
max step to find this object reliably

Reimplemented in Gyoto::Astrobj::Complex.

◆ describeProperty()

std::string Gyoto::Object::describeProperty ( Gyoto::Property const &  p) const
inherited

Format desrciption for a property.

Returns a string containing the name(s) and type of the property, as well as whether it supports unit.

◆ emission() [1/2]

virtual double Gyoto::Astrobj::Python::ThinDisk::emission ( double  nu_em,
double  dsem,
state_t const &  coord_ph,
double const  coord_obj[8] = NULL 
) const
virtual

Specific intensity Iν

Called by the default implementation for processHitQuantities().

emission() computes the intensity Iν emitted by the small volume of length dsem, in the emitter's frame. It should take self-absorption along dsem into account.

Reminder :

  • intensity = Iν [J m^-2 s^-1 ster^-1 Hz^-1];
  • invariant intensity = Iν3, which has the same value in any frame;
  • emission coefficient = jν [J m^-3 s^-1 ster^-1 Hz^-1] , defined by dIν = jν*ds, where ds is the distance travelled by the photon inside the object;
  • invariant emission coef = jν2, which has the same value in any frame.

The equation used for radiative transfer (without absorption) is:

d(Iν3)/dλ = (jν2) [*]

where λ is the integration parameter along the null geodesic.

NB: Let us consider a particular observer, with ν being the frequency measured by this observer, and ds being the proper distance (as measured by the observer) that the photon travels as it moves from λ to λ+dλ along its geodesic. Then it can be shown that:

dλ = ds/ν

This shows that Eq. [*] is homogeneous.

The default implementation returns 1. if optically thick and dsem if optically thin. It allows for a quick implementation of your object for visualization purposes.

Parameters
nu_emFrequency at emission [Hz]
dsemlength over which to integrate inside the object [geometrical units]
coord_phPhoton coordinate
coord_objEmitter coordinate at current photon position

Reimplemented from Gyoto::Astrobj::Generic.

◆ emission() [2/2]

virtual void Gyoto::Astrobj::Python::ThinDisk::emission ( double  Inu[],
double const  nu_em[],
size_t  nbnu,
double  dsem,
state_t const &  coord_ph,
double const  coord_obj[8] = NULL 
) const
virtual

Specific intensity Iν for several values of νem

Called by the default implementation for processHitQuantities().

emission() computes the intensity Iν emitted by the small volume of length dsem. It should take self-absorption along dsem into account.

Same as emission(double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const looping on several values of nu_em.

Parameters
Inu[nbnu]Output (must be set to a previously allocated array of doubles)
nu_em[nbnu]Frequencies at emission
nbnuSize of Inu[] and nu_em[]
dsemLength over which to integrate inside the object
coord_phPhoton coordinate
coord_objEmitter coordinate at current photon position
Returns
Iν or dIν [W m-2 sr-2]

Reimplemented from Gyoto::Astrobj::Generic.

◆ fillElement()

virtual void Gyoto::Object::fillElement ( Gyoto::FactoryMessenger fmp) const
virtualinherited

Fill the XML element for this Object.

The base implementation simply calls fillProperty() for each Property defined for the Object.

Derived classes should avoid overriding fillElement(). It may make sense occasionally, e.g. to make sure that the metric is output first.

To customize how a given Property is rendered, it is better to override fillProperty().

If this method is overridden, the implementation should in general call fillElement() on the direct base.

Reimplemented in Gyoto::Scenery, Gyoto::Spectrometer::Complex, Gyoto::Astrobj::Complex, and Gyoto::Metric::Complex.

◆ fillProperty()

virtual void Gyoto::Object::fillProperty ( Gyoto::FactoryMessenger fmp,
Property const &  p 
) const
virtualinherited

Output a single Property to XML.

The base implementation decides what to do based on the p.type. The format matches how setParameters() an setParameter() would interpret the XML descition.

Overriding this method should be avoided, but makes sense in some cases (for instance Screen::fillProperty() selects a different unit for Distance based on its magnitude, so that stellar sizes are expressed in solar radii while smaller sizes can be expressed in meters and larger sizes in parsecs).

Overriding implementation should fall-back on calling the implementation in the direct parent class:

class A: public Object {};
class B: public A {
using B::setParameter;
Property const &p) const ;
};
void B::fillProperty(Gyoto::FactoryMessenger *fmp,
Property const &p) const {
if (name=="Duff") fmp->doSomething();
else A::fillProperty(fmp, p);
}

Reimplemented in Gyoto::Screen, Gyoto::Scenery, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::XillverReflection, Gyoto::Metric::Shift, and Gyoto::Astrobj::NeutronStarModelAtmosphere.

◆ getDefaultQuantities()

virtual Gyoto::Quantity_t Gyoto::Astrobj::Generic::getDefaultQuantities ( )
virtualinherited

Which quantities to compute if know was requested.

Return a Gyoto::Quantity_t suitable as input to Gyoto::Scenery::setRequestedQuantities() to set de default quantities to compute for this object. The default of these defaults GYOTO_QUANTITY_INTENSITY.

Reimplemented in Gyoto::Astrobj::PageThorneDisk.

◆ getProperties()

virtual Property const* Gyoto::Astrobj::Python::ThinDisk::getProperties ( ) const
virtual

Get list of properties.

This method is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_END macro.

Reimplemented from Gyoto::Astrobj::ThinDisk.

◆ getVelocity()

virtual void Gyoto::Astrobj::Python::ThinDisk::getVelocity ( double const  pos[4],
double  vel[4] 
)
virtual

Get fluid 4-velocity at point.

Fill vel with the 4-vector velocity of the fluid at 4-position pos. getVelocity() should work at some distance from the equatorial plane. The default implementation calls Metric::Generic::circularVelocity().

Parameters
[in]pos4-position at which to compute velocity;
[out]vel4-velocity at pos.

Reimplemented from Gyoto::Astrobj::ThinDisk.

◆ help()

void Gyoto::Object::help ( ) const
inherited

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

◆ Impact()

virtual int Gyoto::Astrobj::ThinDisk::Impact ( Gyoto::Photon ph,
size_t  index,
Astrobj::Properties data = NULL 
)
virtualinherited

Does a photon at these coordinates impact the object?

Impact() checks whether a Photon impacts the object between two integration steps of the photon's trajectory (those two steps are photon->getCoord(index, coord1) and photon->getCoord(index+1, coord2)). Impact returns 1 if the photon impacts the object between these two steps, else 0. In many cases of geometrically thick obects, the implementation Astrobj::Standard::Impact() will be fine.

Impact will call Generic::processHitQuantities() (which is virtual and may be re-implemented) to compute observable properties on demand: if the data pointer is non-NULL, the object will look in it for pointers to properties which apply to its kind. If a pointer to a property known to this object is present, then the property is computed and store at the pointed-to address. For instance, all objects know the "intensity" property. If data->intensity != NULL, the instensity is computed and stored in *data->intensity.

If data is non-NULL and only in this case, processHitQuantities() will also call ph->transmit() to update the transmissions of the Photon (see Photon::transmit(size_t, double)). This must not be done if data is NULL (see Astrobj::Complex::Impact() for an explanation).

Impact() may not extend the ph Worldline. The only two dates that are guaranteed to be defined are at indices index and index+1.

Parameters
phGyoto::Photon aimed at the object;
indexIndex of the last photon step;
dataPointer to a structure to hold the observables at impact.
Returns
1 if impact, 0 if not.

Implements Gyoto::Astrobj::Generic.

◆ inlineModule()

virtual void Gyoto::Astrobj::Python::ThinDisk::inlineModule ( const std::string &  )
virtual

Set inline_module_ and import the Python module.

Side effects:

Reimplemented from Gyoto::Python::Base.

◆ integrateEmission() [1/2]

virtual double Gyoto::Astrobj::Python::ThinDisk::integrateEmission ( double  nu1,
double  nu2,
double  dsem,
state_t const &  c_ph,
double const  c_obj[8] = NULL 
) const
virtual

ν1ν2 Iν dν (or jν)

Compute the integral of emission() from ν1 to ν2. The default implementation is a numerical integrator which works well enough and is reasonably fast if emission() is a smooth function (i.e. no emission or absorption lines). If possible, it is wise to implement an analytical solution. It is used by processHitQuantities to compute the "BinSpectrum" quantity which is the most physical: it is the only quantity that can be actually measured directly by a real-life instrument.

Reimplemented from Gyoto::Astrobj::Generic.

◆ integrateEmission() [2/2]

virtual void Gyoto::Astrobj::Python::ThinDisk::integrateEmission ( double *  I,
double const *  boundaries,
size_t const *  chaninds,
size_t  nbnu,
double  dsem,
state_t const &  cph,
double const *  co 
) const
virtual

ν1ν2 Iν dν (or jν)

Like double integrateEmission(double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]) const for each Spectrometer channel.

Reimplemented from Gyoto::Astrobj::Generic.

◆ isThreadSafe()

virtual bool Gyoto::Object::isThreadSafe ( ) const
virtualinherited

Whether this class is thread-safe.

Return True if this object is thread-safe, i.e. if an instance and its clone can be used in parallel threads (in the context of Scenery::raytrace()). Known objects which are not thread-safe include Lorene metrics and everything from the Python plug-in.

The default implementation considers that the class itself is thread safe and recurses into the declared properties to check whether they are safe too. Classes that abide to the Object/Property paradigm and are themselves thread-safe have nothing special to do.

Objects that clone children in their copy constructor that are not declared as properties must take these children into account.

Classes that are never thread-safe must declare it. It acn be easily done using GYOTO_OBJECT_THREAD_SAFETY in the class declaration and GYOTO_PROPERTY_THREAD_UNSAFE in the class definition.

◆ klass()

virtual void Gyoto::Astrobj::Python::ThinDisk::klass ( const std::string &  c)
virtual

Set class_ and instantiate the Python class.

Sets pInstance_.

This generic implementation takes care of the common ground, but does not set 'this' or call parameters(parameters_). Therefore, all the derived classes should reimplement this method and at least call Python::Base::klass(c) and parameters(parameters_). Between the two is the right moment to check that the Python class implements the required API and to cache PyObject* pointers to class methods.

Reimplemented from Gyoto::Python::Base.

◆ module()

virtual void Gyoto::Astrobj::Python::ThinDisk::module ( const std::string &  )
virtual

Set module_ and import the Python module.

Side effects:

Reimplemented from Gyoto::Python::Base.

◆ operator()()

virtual double Gyoto::Astrobj::ThinDisk::operator() ( double const  coord[])
virtualinherited

theta-pi/2 or z

A function which changes sign on the equatorial plane.

Implements Gyoto::Functor::Double_constDoubleArray.

◆ opticallyThin() [1/2]

void Gyoto::Astrobj::Generic::opticallyThin ( bool  flag)
inherited

Set whether the object is optically thin.

Set flag indicating that radiative transfer should be integrated, i.e. the object is to be considered optically thin.

Parameters
flag1 if optically thin, 0 if optically thick.

◆ opticallyThin() [2/2]

bool Gyoto::Astrobj::Generic::opticallyThin ( ) const
inherited

Query whether object is optically thin.

See opticallyThin(bool flag).

◆ parameters()

virtual void Gyoto::Astrobj::Python::ThinDisk::parameters ( const std::vector< double > &  )
virtual

Set parameters_ and send them to pInstance_.

The parameters are sent to the class instance using the setitem method with numerical keys.

Reimplemented from Gyoto::Python::Base.

◆ processHitQuantities()

virtual void Gyoto::Astrobj::Generic::processHitQuantities ( Photon ph,
state_t const &  coord_ph_hit,
double const *  coord_obj_hit,
double  dt,
Astrobj::Properties data 
) const
virtualinherited

Fills Astrobj::Properties.

processHitQuantities fills the requested data in Impact. To use it, you need to call it in the Impact() method for your object in case of hit. It will fill Redshift, Intensity, Spectrum, BinSpectrum and update the Photon's transmission by calling Photon::transmit(), only if data==NULL.

You can overload it for your Astrobj. The generic implementation calls emission(), integrateEmission() and transmission() below.

Reimplemented in Gyoto::Astrobj::PageThorneDisk, and Gyoto::Astrobj::DynamicalDiskBolometric.

◆ property()

Property const* Gyoto::Object::property ( std::string const  pname) const
inherited

Find property by name.

Look into the Property list for a Property whose name (or name_false, for a boolean Property) is pname. Return a const pointer to the first such property found, or NULL if none is found.

◆ rMax() [1/4]

virtual double Gyoto::Astrobj::Generic::rMax ( )
virtualinherited

Get maximal distance from center of coordinate system.

Get maximal distance from center of coordinate system at which a Photon may hit the object.

Child classes may use the rmax_ member to cache this value, if its current value is DBL_MAX.

It can also be set using rMax().

Returns
rmax_ in geometrical units

Reimplemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::Torus, Gyoto::Astrobj::Complex, and Gyoto::Astrobj::FixedStar.

◆ rMax() [2/4]

virtual double Gyoto::Astrobj::Generic::rMax ( std::string const &  unit)
virtualinherited

Get rmax_ is specified unit.

Call rMax() and convert result to unit.

Parameters
unitstring
Returns
double rmax converted to unit

◆ rMax() [3/4]

virtual void Gyoto::Astrobj::Generic::rMax ( double  val)
virtualinherited

Set maximal distance from center of coordinate system.

Set maximal distance from center of coordinate system at which a Photon may hit the object.

Parameters
valnew rmax_ in geometrical units.

◆ rMax() [4/4]

virtual void Gyoto::Astrobj::Generic::rMax ( double  val,
std::string const &  unit 
)
virtualinherited

Set maximal distance from center of coordinate system.

Call Generic::rMax(double val) after converting val from unit to geometrical units.

Parameters
valrmax_ expressed in unit "unit";
unitstring...

◆ setParameter() [1/2]

virtual int Gyoto::Object::setParameter ( std::string  name,
std::string  content,
std::string  unit 
)
virtualinherited

Set parameter by name.

This function is used when parsing an XML description, if no Property of this name is found. Overriding implementation should fall-back on calling the direct's parent implementation:

class A: public Object {};
class B: public A {
using B::setParameter;
virtual int setParameter(std::string name,
std::string content,
std::string unit);
};
int B::setParameter(std::string name,
std::string content,
std::string unit) {
if (name=="Duff") doSomething(content, unit);
else return A::setParameter(name, content, unit);
return 0; // name was known
}
Parameters
nameXML name of the parameter (XML entity). This may have a path component, e.g. "Astrobj::Radius", in which case a property named "Astrobj" will be sought in the current object, and setParameter will be called recusrively on this Astrobj with Radius as name.
contentstring representation of the value
unitstring representation of the unit
Returns
0 if this parameter is known, 1 if it is not.

Reimplemented in Gyoto::Astrobj::Star, Gyoto::Metric::RotStar3_1, Gyoto::Metric::KerrKS, and Gyoto::Astrobj::EquatorialHotSpot.

◆ setParameter() [2/2]

virtual void Gyoto::Object::setParameter ( Gyoto::Property const &  p,
std::string const &  name,
std::string const &  content,
std::string const &  unit 
)
virtualinherited

Set parameter by Property (and name)

This function is used when parsing an XML description, if Property (p) of this name is found (i.e. either p.name or p.name_false is equal to name). Implementation should fall-back on calling the direct's parent implementation:

class A: public Object {};
class B: public A {
using B::setParameter;
virtual void setParameter(Gyoto::Property const &p,
std::string name,
std::string content,
std::string unit);
};
void B::setParameter(Gyoto::Property const &p,
std::string name,
std::string content,
std::string unit) {
if (name=="Duff") doSomething(content, unit);
else A::setParameter(p, name, content, unit);
}
Parameters
pProperty that matches name (p.name == name or p.name_false == name)
nameXML name of the parameter (XML entity)
contentstring representation of the value
unitstring representation of the unit

Reimplemented in Gyoto::Astrobj::PolishDoughnut.

◆ setParameters()

virtual void Gyoto::Astrobj::Generic::setParameters ( FactoryMessenger fmp)
virtualinherited

Main loop in Subcontractor_t function.

The Subcontractor_t function for each Astrobj kind should look somewhat like this (templated as Gyoto::Astrobj::Subcontractor<MyKind>):

SmartPointer<Astrobj::Generic>
Gyoto::Astrobj::MyKind::Subcontractor(FactoryMessenger* fmp) {
SmartPointer<MyKind> ao = new MyKind();
ao -> setParameters(fmp);
return ao;
}

Each object kind should implement setParameter(string name, string content, string unit) to interpret the individual XML elements. setParameters() can be overloaded in case the specific Astrobj class needs low level access to the FactoryMessenger. See UniformSphere::setParameters().

Reimplemented from Gyoto::Object.

Reimplemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::Complex, Gyoto::Astrobj::OscilTorus, and Gyoto::Astrobj::EquatorialHotSpot.

◆ transmission()

virtual double Gyoto::Astrobj::Generic::transmission ( double  nuem,
double  dsem,
state_t const &  coord_ph,
double const  coord_obj[8] 
) const
virtualinherited

Transmission: exp( αν * dsem )

transmission() computes the transmission of this fluid element or 0 if optically thick. The default implementation returns 1. (no attenuation) if optically thin, 0. if optically thick.

Parameters
nuemfrequency in the fluid's frame
coordPhoton coordinate
dsemgeometrical length in geometrical units

Reimplemented in Gyoto::Astrobj::PatternDisk, and Gyoto::Astrobj::DynamicalDisk3D.

◆ velocityKind()

virtual std::string Gyoto::Astrobj::ThinDisk::velocityKind ( ) const
virtualinherited

Set dir_=t?1:-1.

Get VelocityKind

Member Data Documentation

◆ class_

std::string Gyoto::Python::Base::class_
protectedinherited

Name of the Python class that we want to expose.

Property name: Class.

◆ deltamaxinsidermax_

double Gyoto::Astrobj::Generic::deltamaxinsidermax_
protectedinherited

Maximum Photon integration step inside rmax_ [geometrical units].

Maximum step for Photon integation when inside the sphere of radius rmax_.

deltamaxinsidermax_ is in geometrical units.

◆ kind_

std::string Gyoto::Object::kind_
protectedinherited

The "kind" that is output in the XML entity.

E.g. for an Astrobj, fillElement() will ensure

<Astrobj kind="kind_" ...>...</Astrobj>

is written.

◆ module_

std::string Gyoto::Python::Base::module_
protectedinherited

Name of the Python module that holds the class.

For instance, if the class is implemented in toto.py, the module name is "toto". Property name: Module.

◆ parameters_

std::vector<double> Gyoto::Python::Base::parameters_
protectedinherited

Parameters that this class needs.

A list of parameters (doubles) can be passed in the Property Parameters. They will be sent to the Python instance using setitem.

◆ plugins_

std::vector<std::string> Gyoto::Object::plugins_
protectedinherited

The plug-ins that needs to be loaded to access this instance's class.

E.g. for an Astrobj, fillElement() will ensure

<Astrobj ... plugin="plugins_">...</Astrobj>

is written.

◆ rmax_

double Gyoto::Astrobj::Generic::rmax_
protectedinherited

Maximum distance to the center of the coordinate system [geometrical units].

Maximum distance from the center of the coordinate system at which a photon may hit the object. Child classes may compute a decent value for rmax_ at any time if rmax_ is DBL_MAX. External classes (Photons in particular) must use rMax() to access this information.

rmax_ is in geometrical units.

◆ thickness_

double Gyoto::Astrobj::ThinDisk::thickness_
protectedinherited

disk thickness

Geometrical thickness in geometrical units. Used only in the optically thin regime (flag_radtransf_==1). Should be << rin_. Default: 1e-3.


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