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

Geometrically thin disk read from FITS file. More...

#include <GyotoPatternDisk.h>

Inheritance diagram for Gyoto::Astrobj::PatternDisk:
Gyoto::Astrobj::ThinDisk Gyoto::Astrobj::Generic Gyoto::Functor::Double_constDoubleArray Gyoto::SmartPointee Gyoto::Astrobj::PatternDiskBB Gyoto::Astrobj::DynamicalDisk

Public Member Functions

 PatternDisk ()
 Standard constructor.
 
 PatternDisk (const PatternDisk &)
 Copy constructor.
 
virtual PatternDiskclone () const
 Cloner.
 
virtual ~PatternDisk ()
 Destructor.
 
virtual void setInnerRadius (double)
 Set rin_.
 
virtual void setOuterRadius (double)
 Set rout_.
 
virtual void setPatternVelocity (double)
 Set PatternDisk::Omega_. More...
 
virtual double getPatternVelocity ()
 Get PatternDisk::Omega_.
 
virtual void fitsRead (std::string filename_)
 Read parameters and arrays from FITS file.
 
virtual void fitsWrite (std::string filename_)
 Write parameters and arrays to FITS file.
 
void setEmission (double *pattern)
 Set PatternDisk::emission_. More...
 
void setVelocity (double *pattern)
 Set PatternDisk::velocity__. More...
 
void setRadius (double *pattern)
 Set PatternDisk::radius_. More...
 
virtual void copyIntensity (double const *const pattern=NULL, size_t const naxes[3]=NULL)
 Set PatternDisk::emission_. More...
 
virtual double const * getIntensity () const
 Get PatternDisk::emission_.
 
virtual void getIntensityNaxes (size_t naxes[3]) const
 Get PatternDisk::nnu_, PatternDisk::nphi_, and PatternDisk::nr_.
 
virtual void copyOpacity (double const *const pattern=NULL, size_t const naxes[3]=NULL)
 Set PatternDisk::opacity_. More...
 
virtual double const * getOpacity () const
 Get PatternDisk::opacity_.
 
virtual void copyVelocity (double const *const pattern=NULL, size_t const naxes[2]=NULL)
 Set PatternDisk::velocity_. More...
 
virtual double const * getVelocity () const
 Get PatternDisk::velocity_.
 
virtual void copyGridRadius (double const *const pattern=NULL, size_t nr=0)
 Set PatternDisk::radius_. More...
 
virtual double const * getGridRadius () const
 Get PatternDisk::radius_.
 
virtual void repeatPhi (size_t n)
 Set PatternDisk::repeat_phi_.
 
virtual size_t repeatPhi () const
 Get PatternDisk::repeat_phi_.
 
virtual void nu0 (double freq)
 Set PatternDisk::nu0_.
 
virtual double nu0 () const
 Get PatternDisk::nu0_.
 
virtual void dnu (double dfreq)
 Set PatternDisk::dnu_.
 
virtual double dnu () const
 Get PatternDisk::dnu_.
 
void phimin (double phimin)
 Set PatternDisk::phimin_.
 
double phimin () const
 Get PatternDisk::phimin_.
 
void phimax (double phimax)
 Set PatternDisk::phimax_.
 
double phimax () const
 Get PatternDisk::phimax_.
 
virtual int setParameter (std::string name, std::string content, std::string unit)
 Set parameter by name. More...
 
virtual double emission (double nu_em, double dsem, double c_ph[8], double c_obj[8]) const
 Specific intensity Iν More...
 
virtual double transmission (double nu_em, double dsem, double coord[8]) const
 Transmission: exp( αν * dsem ) More...
 
virtual void getVelocity (double const pos[4], double vel[4])
 Get fluid 4-velocity at point. More...
 
virtual void fillElement (FactoryMessenger *fmp) const
 Fill the generic XML bits. More...
 
virtual void setParameters (FactoryMessenger *fmp)
 Main loop in Subcontractor_t function. More...
 
virtual double getInnerRadius () const
 Get rin_.
 
virtual double getInnerRadius (std::string unit) const
 Get rin_.
 
virtual void setInnerRadius (double, std::string unit)
 Set rin_.
 
virtual double getOuterRadius () const
 Get rout_.
 
virtual double getOuterRadius (std::string unit) const
 Get rout_.
 
virtual void setOuterRadius (double, std::string unit)
 Set rout_.
 
virtual double getThickness () const
 Get thickness_.
 
virtual double getThickness (std::string unit) const
 Get thickness_.
 
virtual void setThickness (double)
 Set thickness_.
 
virtual void setThickness (double, std::string unit)
 Set thickness_.
 
virtual int getDir () const
 Get dir_.
 
virtual void setDir (int)
 Set dir_.
 
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::Generic
getMetric () const
 Get the Metric Generic::gg_.
 
virtual void setMetric (SmartPointer< Metric::Generic >)
 Set 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 void processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const
 Fills Astrobj::Properties. 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...
 

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 getIndices (size_t i[3], double const co[4], double nu=0.) const
 Get emission_ cell corresponding to position co[4].
 
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

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

Private Attributes

std::string filename_
 Optional FITS file name containing the arrays.
 
double * emission_
 Iν(ν, r, φ) More...
 
double * opacity_
 Same dimenstions as emission, or NULL.
 
double * velocity_
 velocity(r, φ) More...
 
double * radius_
 Radius vector. More...
 
double Omega_
 Pattern angular velocity. More...
 
double t0_
 Date for which i=0 corresponds to phi=0. More...
 
double dnu_
 Frequency scale of PatternDisk::emission_ in Hz.
 
double nu0_
 Lowest frequency provided in PatternDisk::emission_ in Hz.
 
size_t nnu_
 Number of frequencies provided in PatternDisk::emission_.
 
double dphi_
 δφ between two grid columns
 
double phimin_
 Minimum φ in grid.
 
size_t nphi_
 Grid size in the φ direction.
 
double phimax_
 Maximum φ in grid.
 
size_t repeat_phi_
 Number of times the pattern should be repeated to cover [0, 2Π]. More...
 
double dr_
 Radius step.
 
size_t nr_
 Number of rows in the patternGrid size in the r direction.
 

Friends

class Gyoto::SmartPointer< Gyoto::Astrobj::PatternDisk >
 

Detailed Description

Geometrically thin disk read from FITS file.

This class describes a disk contained in the z=0 (equatorial) plane, extending from r=r_ISCO to r=infinity. The flux emitted at radius r and longitude phi at frequency nu is given in a FITS file.

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().

Member Function Documentation

virtual void Gyoto::Astrobj::PatternDisk::copyGridRadius ( double const *const  pattern = NULL,
size_t  nr = 0 
)
virtual

Set PatternDisk::radius_.

PatternDisk::radius_ is first freed if not NULL and set to NULL.

If pattern is not NULL, PatternDisk::emission_ must have been set previously with matching dimensions. PatternDisk::radius_ is then reallocated, and pattern is copied into radius_.

Parameters
patternArray to copy as radius_. May be NULL in which case radius_ is simply deallocated and set to NULL.
nrsize of radius array.
virtual void Gyoto::Astrobj::PatternDisk::copyIntensity ( double const *const  pattern = NULL,
size_t const  naxes[3] = NULL 
)
virtual

Set PatternDisk::emission_.

PatternDisk::emission_ is freed if not NULL, reallocated, and pattern is copied into emission_.

If PatternDisk::opacity_, PatternDisk::velocity_ or PatternDisk::radius_ have been set previously with mismatching sizes, they are deallocated too.

Finally, PatternDisk::nnu_, PatternDisk::nphi_, and PatternDisk::nr_ are set according to naxes.

Parameters
patternArray to copy as emission_. May be NULL in which case emission_ is simply deallocated and set to NULL.
naxes{ nnu_, nphi_, nr_ }.
virtual void Gyoto::Astrobj::PatternDisk::copyOpacity ( double const *const  pattern = NULL,
size_t const  naxes[3] = NULL 
)
virtual

Set PatternDisk::opacity_.

PatternDisk::opacity_ is first freed if not NULL and set to NULL.

If pattern is not NULL, PatternDisk::emission_ must have been set previously with matching dimensions. PatternDisk::opacity_ is then reallocated, and pattern is copied into opacity_.

Parameters
patternArray to copy as opacity_. May be NULL in which case opacity_ is simply deallocated and set to NULL.
naxes{ nnu_, nphi_, nr_ }.
virtual void Gyoto::Astrobj::PatternDisk::copyVelocity ( double const *const  pattern = NULL,
size_t const  naxes[2] = NULL 
)
virtual

Set PatternDisk::velocity_.

PatternDisk::velocity_ is first freed if not NULL and set to NULL.

If pattern is not NULL, PatternDisk::emission_ must have been set previously with matching dimensions. PatternDisk::velocity_ is then reallocated, and pattern is copied into velocity_.

Parameters
patternArray to copy as velocity_. May be NULL in which case velocity_ is simply deallocated and set to NULL.
naxes{ nphi_, nr_ }.
virtual double Gyoto::Astrobj::PatternDisk::emission ( double  nu_em,
double  dsem,
double  coord_ph[8],
double  coord_obj[8] 
) 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.

Reimplemented in Gyoto::Astrobj::DynamicalDisk, and Gyoto::Astrobj::PatternDiskBB.

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::PatternDisk::fillElement ( FactoryMessenger fmp) const
virtual

Fill the generic XML bits.

The sub-classes implementations of the Astrobj::Generic::fillElement() method should call Astrobj::ThinDisk::fillElement() to fill the common bits.

Reimplemented from Gyoto::Astrobj::ThinDisk.

Reimplemented in Gyoto::Astrobj::DynamicalDisk, and Gyoto::Astrobj::PatternDiskBB.

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 void Gyoto::Astrobj::PatternDisk::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.

Reimplemented in Gyoto::Astrobj::DynamicalDisk, and Gyoto::Astrobj::PatternDiskBB.

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 adress. 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).

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.

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.

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.

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::PatternDisk::setEmission ( double *  pattern)

Set PatternDisk::emission_.

The pointer is copied directly, not the array content.

This is a low-level function. Beware that:

  • previously allocated array will not be freed automatically;
  • array attached when the destructor is called will be freed.
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::PatternDisk::setParameter ( std::string  name,
std::string  content,
std::string  unit 
)
virtual

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 from Gyoto::Astrobj::ThinDisk.

Reimplemented in Gyoto::Astrobj::DynamicalDisk, and Gyoto::Astrobj::PatternDiskBB.

virtual void Gyoto::Astrobj::PatternDisk::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::PatternDisk::setPatternVelocity ( double  )
virtual

Set PatternDisk::Omega_.

Unit: radians per geometrical unit time.

void Gyoto::Astrobj::PatternDisk::setRadius ( double *  pattern)

Set PatternDisk::radius_.

The pointer is copied directly, not the array content.

This is a low-level function. Beware that:

  • previously allocated array will not be freed automatically;
  • array attached when the destructor is called will be freed.
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...
void Gyoto::Astrobj::PatternDisk::setVelocity ( double *  pattern)

Set PatternDisk::velocity__.

The pointer is copied directly, not the array content.

This is a low-level function. Beware that:

  • previously allocated array will not be freed automatically;
  • array attached when the destructor is called will be freed.
virtual double Gyoto::Astrobj::PatternDisk::transmission ( double  nuem,
double  dsem,
double  coord[8] 
) const
virtual

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

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

double* Gyoto::Astrobj::PatternDisk::emission_
private

Iν(ν, r, φ)

An array of dimensionality double[nr_][nphi_][nnu_]. In FITS format, the first dimension is nu, the second phi, and the third r.

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::PatternDisk::Omega_
private

Pattern angular velocity.

XML element: <Omega>. FITS keyword: HIERARCH GYOTO PatternDisk Omega

double* Gyoto::Astrobj::PatternDisk::radius_
private

Radius vector.

In case of adaptive grid.

size_t Gyoto::Astrobj::PatternDisk::repeat_phi_
private

Number of times the pattern should be repeated to cover [0, 2Π].

XML elment: <RepeatPhi>. FITS keyword: HIERARCH GYOTO PatternDisk RepeatPhi

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::PatternDisk::t0_
private

Date for which i=0 corresponds to phi=0.

XML element: <T0>. FITS keyword: HIERARCH GYOTO PatternDisk t0

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.

double* Gyoto::Astrobj::PatternDisk::velocity_
private

velocity(r, φ)

An array of dimensionality double[nr_][nphi_][2]. In FITS format, the second dimension is phi, and the third r. The first plane in the first FITS dimention is dφ/dt, the second dr/dt.


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