Gyoto
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Gyoto::Astrobj::Complex Class Reference

Complex astronomical object. More...

#include <GyotoComplexAstrobj.h>

Inheritance diagram for Gyoto::Astrobj::Complex:
Gyoto::Astrobj::Generic Gyoto::SmartPointee

Public Member Functions

 Complex ()
 Default constructor.
 
 Complex (const Complex &)
 Copy constructor.
 
virtual Complexclone () const
 "Virtual" copy constructor
 
virtual ~Complex ()
 Destructor. More...
 
void append (Gyoto::SmartPointer< Gyoto::Astrobj::Generic > element)
 Add element at the end of the array. More...
 
void remove (size_t i)
 Remove i-th element from the array.
 
size_t getCardinal () const
 Get the number of elements in the array.
 
void setMetric (SmartPointer< Metric::Generic > gg)
 Set metric in each element.
 
virtual void fillElement (FactoryMessenger *fmp) const
 Fill XML section. More...
 
virtual void setParameters (FactoryMessenger *fmp)
 Main loop in Subcontractor_t function. More...
 
virtual int Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL)
 Call Impact() for each of the elements. More...
 
Gyoto::SmartPointer
< Gyoto::Astrobj::Generic
operator[] (size_t i)
 Retrieve i-th element. More...
 
Gyoto::SmartPointer
< Gyoto::Astrobj::Generic >
const 
operator[] (size_t i) const
 Retrieve a const version of the i-th element.
 
virtual SmartPointer
< Metric::Generic
getMetric () const
 Get the Metric Generic::gg_.
 
virtual double getRmax ()
 Get maximal distance from center of coordinate system. More...
 
virtual double getRmax (std::string unit)
 Get rmax_ is specified unit. More...
 
const std::string getKind () const
 Get the kind of the Astrobj (e.g. "Star")
 
virtual void setRmax (double val)
 Set maximal distance from center of coordinate system. More...
 
virtual void setRmax (double val, std::string unit)
 Set maximal distance from center of coordinate system. More...
 
virtual void unsetRmax ()
 Set rmax_set_ to 0. More...
 
void setFlag_radtransf (int flag)
 Set whether the object is optically thin. More...
 
int getFlag_radtransf () const
 Query whether object is optically thin. More...
 
virtual Quantity_t getDefaultQuantities ()
 Which quantities to compute if know was requested. More...
 
virtual int setParameter (std::string name, std::string content, std::string unit)
 Set parameter by name. More...
 
virtual void processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const
 Fills Astrobj::Properties. More...
 
virtual double emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const
 Specific intensity Iν More...
 
virtual void emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const
 Specific intensity Iν for several values of νem More...
 
virtual double integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double 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, double *cph, double *co) const
 ν1ν2 Iν dν (or jν) More...
 
virtual double transmission (double nuem, double dsem, double coord[8]) const
 Transmission: exp( αν * dsem ) More...
 

Protected Types

typedef Gyoto::SmartPointer
< Gyoto::SmartPointee
Subcontractor_t (Gyoto::FactoryMessenger *)
 A subcontractor builds an object upon order from the Factory. More...
 

Protected Member Functions

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.
 

Protected Attributes

size_t cardinal_
 Number of objects.
 
Gyoto::SmartPointer
< Gyoto::Astrobj::Generic > * 
elements_
 Array of Astrobj::Generic.
 
double step_max_
 Maximum δ step inside the Astrobj. More...
 
SmartPointer
< Gyoto::Metric::Generic
gg_
 The Metric in this end of the Universe.
 
double rmax_
 Maximum distance to the center of the coordinate system [geometrical units]. More...
 
int rmax_set_
 Never recompute rmax: it was externally set. More...
 
const std::string kind_
 Kind of object (e.g. "Star"...) More...
 
int flag_radtransf_
 1 if radiative transfer inside Astrobj, else 0
 

Friends

class Gyoto::SmartPointer< Gyoto::Astrobj::Complex >
 

Detailed Description

Complex astronomical object.

A Gyoto::Astrobj::Generic whic contain several Gyoto::Astrobj::Generic instances. It is essentially a SmartPointer<Astrobj::Generic> array, which some methods around. Indeed, the operator[](size_t i) method is implemented to retrieve the i-th element.

In an XML description, the <Astrobj> section must be unique, its kind is "Complex". Each sub-astrobj then appears as a <SubAstrobj> subsection:

* <Astrobj kind = "Complex">
* <SubAstrobj kind = "ThinInfiniteDiskBL"/>
* <SubAstrobj kind = "Star">
* <Radius> 2. </Radius>
* <Velocity> 0. 0. 0.037037 </Velocity>
* <Position> 600. 9. 1.5707999999999999741 0 </Position>
* <Spectrum kind="PowerLaw">
* <Exponent> 0 </Exponent>
* <Constant> 0.001 </Constant>
* </Spectrum>
* <Opacity kind="PowerLaw">
* <Exponent> 0 </Exponent>
* <Constant> 0.01 </Constant>
* </Opacity>
* <OpticallyThin/>
* </SubAstrobj>
* </Astrobj>
*

Member Typedef Documentation

typedef Gyoto::SmartPointer<Gyoto::SmartPointee> Gyoto::SmartPointee::Subcontractor_t(Gyoto::FactoryMessenger *)
inherited

A subcontractor builds an object upon order from the Factory.

Various classes need to provide a subcontractor to be able to instanciate 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().

Constructor & Destructor Documentation

virtual Gyoto::Astrobj::Complex::~Complex ( )
virtual

Destructor.

Frees every SmartPointer<Astrobj::Generic> before freed the array itself.

Member Function Documentation

void Gyoto::Astrobj::Complex::append ( Gyoto::SmartPointer< Gyoto::Astrobj::Generic element)

Add element at the end of the array.

If the Astrobj::Complex itself does not have a metric already assigned, it takes it from the new element. Else, it sets the metric in the new element to its own. This ensures that all elements use the same metric (this heuristic is not entirely fool-proof, it's safer to set the metric directly in the Astrobj::Complex).

virtual double Gyoto::Astrobj::Generic::emission ( double  nu_em,
double  dsem,
double  coord_ph[8],
double  coord_obj[8] = NULL 
) const
virtualinherited

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 in Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::Torus, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::Disk3D_BB, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDiskBB, and Gyoto::Astrobj::ThinDiskPL.

virtual void Gyoto::Astrobj::Generic::emission ( double  Inu[],
double  nu_em[],
size_t  nbnu,
double  dsem,
double  coord_ph[8],
double  coord_obj[8] = NULL 
) const
virtualinherited

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 in Gyoto::Astrobj::PolishDoughnut.

virtual void Gyoto::Astrobj::Complex::fillElement ( FactoryMessenger fmp) const
virtual

Fill XML section.

Astrobj implementations should impement fillElement to save their parameters to XML and call the generic implementation to save generic parts such as Flag_radtrans: Generic::fillElement(fmp).

Reimplemented from Gyoto::Astrobj::Generic.

virtual 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.

int Gyoto::Astrobj::Generic::getFlag_radtransf ( ) const
inherited

Query whether object is optically thin.

See setFlag_radtransf(int flag).

virtual double Gyoto::Astrobj::Generic::getRmax ( )
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.

It can also be set using setRmax(). If setRmax has been used to set rmax_, getRmax() must not recompute it.

Returns
rmax_ in geometrical units

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

virtual double Gyoto::Astrobj::Generic::getRmax ( std::string  unit)
virtualinherited

Get rmax_ is specified unit.

Call getRmax() and convert result to unit.

Parameters
unitstring
Returns
double rmax converted to unit
virtual int Gyoto::Astrobj::Complex::Impact ( Gyoto::Photon ph,
size_t  index,
Astrobj::Properties data = NULL 
)
virtual

Call Impact() for each of the elements.

Astrobj::Complex::Impact(Gyoto::Photon* ph, size_t index, Astrobj::Properties *data) calls the specific implementation of Astrobj::Generic::Impact() for each of its elements twice: the first time, data is set to NULL so that Astrobj::Complex::Impact() only knows whether each object is hit by the Photon. If no object is hit, return. If a single object is hit, call Impact() again only for this object, passing data this time. If several objects are hit, the Photon's trajectory is refined so that the step is at most step_max_ and the Impact() methods for each of the hit objects are called again for each step, passing data. It is therefore important that the transmission of the Photon is not touched by Impact() when data==NULL.

Implements Gyoto::Astrobj::Generic.

virtual double Gyoto::Astrobj::Generic::integrateEmission ( double  nu1,
double  nu2,
double  dsem,
double  c_ph[8],
double  c_obj[8] = NULL 
) const
virtualinherited

ν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 in Gyoto::Astrobj::UniformSphere, and Gyoto::Astrobj::Torus.

virtual void Gyoto::Astrobj::Generic::integrateEmission ( double *  I,
double const *  boundaries,
size_t const *  chaninds,
size_t  nbnu,
double  dsem,
double *  cph,
double *  co 
) const
virtualinherited

ν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.

Gyoto::SmartPointer<Gyoto::Astrobj::Generic> Gyoto::Astrobj::Complex::operator[] ( size_t  i)

Retrieve i-th element.

This should work as expected:

* SmartPointer<Astrobj::Complex> cplx;
* SmartPointer<Astrobj::TypeA> objA;
* SmartPointer<Astrobj::TypeB> objB;
* cplx -> append(objA);
* cplx[0] = objB;
*
virtual void Gyoto::Astrobj::Generic::processHitQuantities ( Photon ph,
double *  coord_ph_hit,
double *  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.

void Gyoto::Astrobj::Generic::setFlag_radtransf ( int  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
flag,:1 if optically thin, 0 if optically thick.
virtual int Gyoto::Astrobj::Generic::setParameter ( std::string  name,
std::string  content,
std::string  unit 
)
virtualinherited

Set parameter by name.

Assume MyKind is a subclass of Astrobj::Generic which has two members (a string StringMember and a double DoubleMember):

* int MyKind::setParameter(std::string name,
* std::string content,
* std::string unit) {
* if (name=="StringMember") setStringMember(content);
* else if (name=="DoubleMember") setDoubleMember(atof(content.c_str()),
* unit);
* else return Generic::setParameter(name, content, unit);
* return 0;
* }
*

If MyKind is not a direct subclass of Generic but is a subclass of e.g. Standard, UniformSphere of ThinDisk, it should call the corresponding setParameter() implementation instead of Generic::setParameter().

Parameters
nameXML name of the parameter
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::PatternDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::Standard, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Star, Gyoto::Astrobj::Torus, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::Disk3D_BB, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::ThinDiskPL, and Gyoto::Astrobj::FixedStar.

virtual void Gyoto::Astrobj::Complex::setParameters ( FactoryMessenger fmp)
virtual

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::Astrobj::Generic.

virtual void Gyoto::Astrobj::Generic::setRmax ( 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.

Side effect: set rmax_set_ to 1.

Parameters
valnew rmax_ in geometrical units.
virtual void Gyoto::Astrobj::Generic::setRmax ( double  val,
std::string  unit 
)
virtualinherited

Set maximal distance from center of coordinate system.

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

Parameters
valrmax_ expressed in unit "unit";
unitstring...
virtual double Gyoto::Astrobj::Generic::transmission ( double  nuem,
double  dsem,
double  coord[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, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::Disk3D_BB.

virtual void Gyoto::Astrobj::Generic::unsetRmax ( )
virtualinherited

Set rmax_set_ to 0.

getRmax() will then be free to recompute rmax_. Astrobjs which cache rmax_ may need to update it when unsetRmax() is called.

Reimplemented in Gyoto::Astrobj::Star.

Member Data Documentation

const std::string Gyoto::Astrobj::Generic::kind_
protectedinherited

Kind of object (e.g. "Star"...)

The kind should match the name of the class, e.g. "Star" for a Gyoto::Star.

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 choose to update rmax at all time or to use it to cache the value, for instance when getRmax() is called. External classes (Photons in particular) must use getRmax() to access this information.

rmax_set_==1 means that rmax_ was set using setRmax() or the constructor. In this case, getRmax() must always return this value, not recompute it.

rmax_ is in geometrical units.

int Gyoto::Astrobj::Generic::rmax_set_
protectedinherited

Never recompute rmax: it was externally set.

rmax_set_==1 means that rmax_ was set using setRmax() or the constructor. In this case, getRmax() must always return this value, not recompute it.

Use unsetRmax() to reset rmax_set_ to 0.

double Gyoto::Astrobj::Complex::step_max_
protected

Maximum δ step inside the Astrobj.

Currently not settable, always equal to GYOTO_DEFAULT_DELTA


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