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

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

#include <GyotoDisk3D.h>

Inheritance diagram for Gyoto::Astrobj::Disk3D:
Gyoto::Astrobj::Generic Gyoto::SmartPointee Gyoto::Astrobj::Disk3D_BB

Public Member Functions

 Disk3D ()
 Standard constructor.
 Disk3D (const Disk3D &)
 Copy constructor.
virtual Disk3Dclone () const
 Cloner.
virtual ~Disk3D ()
 Destructor.
virtual void fitsRead (std::string filename_)
virtual void fitsWrite (std::string filename_)
 Read data from file.
void setEmissquant (double *pattern)
void setVelocity (double *pattern)
virtual void copyEmissquant (double const *const pattern=NULL, size_t const naxes[4]=NULL)
 attach emissquant_ array and set its size
virtual double const *const getEmissquant () const
virtual void getEmissquantNaxes (size_t naxes[4]) const
virtual void copyVelocity (double const *const pattern=NULL, size_t const naxes[3]=NULL)
virtual double const *const getVelocity () const
virtual void repeatPhi (size_t n)
virtual size_t repeatPhi () const
virtual void nu0 (double freq)
virtual double nu0 () const
virtual void dnu (double dfreq)
virtual double dnu () const
void rin (double rrin)
double rin () const
void rout (double rout)
double rout () const
void zmin (double zmin)
double zmin () const
void zmax (double zmax)
double zmax () const
void phimin (double phimin)
double phimin () const
void phimax (double phimax)
double phimax () const
virtual int setParameter (std::string name, std::string content)
 Called from setParameters()
int Impact (Photon *ph, size_t index, Astrobj::Properties *data)
 does a photon at these coordinates impact the object?
virtual void getVelocity (double const pos[4], double vel[4])
virtual void fillElement (FactoryMessenger *fmp) const
 called from Factory
virtual void setParameters (FactoryMessenger *fmp)
 Main loop in Subcontractor_t function.
virtual SmartPointer
< Metric::Generic
getMetric () const
virtual void setMetric (SmartPointer< Metric::Generic >)
virtual double getRmax ()
 Get maximal distance from center of coordinate system.
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.
virtual void unsetRmax ()
 Set rmax_set_ to 0.
void setFlag_radtransf (int flag)
 Set whether the object is optically thin.
int getFlag_radtransf () const
 Query whether object is optically thin.
virtual Quantity_t getDefaultQuantities ()
virtual void processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const
virtual double emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const
 INVARIANT emission j_{}/^{2}.
virtual double integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const
 ^nu2 I_nu dnu (or j_nu)
virtual double transmission (double nuem, double dsem, double coord[8]) const
 Transmission: exp( {} * dsem )
void checkPhiTheta (double coord[8]) const

Protected Types

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

Protected Member Functions

void getIndices (size_t i[4], 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

SmartPointer
< Gyoto::Metric::Generic
gg_
double rmax_
 Maximum distance to the center of the coordinate system.
int rmax_set_
 Never recompute rmax: it was externally set.
const std::string kind_
 Kind of object (e.g. "Star"...)
int flag_radtransf_
 1 if radiative transfer inside Astrobj, else 0

Private Attributes

std::string filename_
double * emissquant_
 Inu(nu, r, z, phi)
double * velocity_
 velocity(r, z, phi)
double dnu_
double nu0_
size_t nnu_
double dphi_
double phimin_
size_t nphi_
double phimax_
size_t repeat_phi_
double dz_
double zmin_
size_t nz_
double zmax_
double dr_
double rin_
size_t nr_
double rout_

Friends

class Gyoto::SmartPointer< Gyoto::Astrobj::Disk3D >

Detailed Description

Geometrically thick disk read from FITS file.

This class is the base class for thick disks. The emitter's velocity is given in a FITS file, together with emission related quantity (typically temperature). This class mainly implements the Impact() function. Emission() function is here left to its default, and should be implemented according to specific needs in heir classes. Here the disk is supposed not to evolve in time. The dynamical treatment is provided in heir classes.

The 3D disk is assumed to be described by a regular (non adaptive) grid.

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

void Gyoto::Astrobj::Generic::checkPhiTheta ( double  coord[8]) const
inherited

checkPhiTheta() Modifies coord if the corrdinates are spherical-like so that coord[2]=theta is in [0,pi] and coord[3]=phi is in [0,2pi]. Important to use in all astrobj in spherical coordinates to prevent "z-axis problems".

virtual void Gyoto::Astrobj::Disk3D::copyEmissquant ( double const *const  pattern = NULL,
size_t const  naxes[4] = NULL 
)
virtual

attach emissquant_ array and set its size

Parameters
pattern,:new emission_ array.
dims[4]= { nnu_, nphi_, nz_, nr_ };
virtual double Gyoto::Astrobj::Generic::emission ( double  nu_em,
double  dsem,
double  coord_ph[8],
double  coord_obj[8] = NULL 
) const
virtualinherited

INVARIANT emission j_{}/^{2}.

Called by the default implementation for processHitQuantities().

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

Reminder :

  • intensity = I_nu [erg cm^-2 s^-1 ster^-1 Hz^-1];
  • invariant intensity = I_nu/nu^3, which has the same value in any frame;
  • emission coefficient = j_nu [erg cm^-3 s^-1 ster^-1 Hz^-1] , defined by dI_nu = j_nu*ds, where ds is the distance travelled by the photon inside the object;
  • invariant emission coef = j_nu/nu^2, which has the same value in any frame.

The equation used for radiative transfer (without absorption) is: d(I_nu/nu^3)/dlambda = (j_nu/nu^2) [*] where lambda is the integration parameter along the null geodesic.

NB: Let us consider a particular observer, 
    with nu 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 lambda to lambda+dlambda along its geodesic.
    Then it can be shown that :
                    dlambda = ds/nu
    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
dsemlength over which to integrate inside the object
coord_phPhoton coordinate
coord_objEmitter coordinate at current photon position

Reimplemented in Gyoto::Astrobj::PatternDisk, 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::Disk3D::fillElement ( FactoryMessenger fmp) const
virtual

called from Factory

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.

Reimplemented in Gyoto::Astrobj::Disk3D_BB.

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

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.

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

Query whether object is optically thin.

See setFlag_radtransf(int flag).

virtual SmartPointer<Metric::Generic> Gyoto::Astrobj::Generic::getMetric ( ) const
virtualinherited

Get the Metric

Reimplemented in Gyoto::Astrobj::Star.

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.

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

int Gyoto::Astrobj::Disk3D::Impact ( Photon ph,
size_t  index,
Astrobj::Properties data 
)
virtual

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

^nu2 I_nu dnu (or j_nu)

Compute the integral of emission() from nu1 to nu2. 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::processHitQuantities ( Photon ph,
double *  coord_ph_hit,
double *  coord_obj_hit,
double  dt,
Astrobj::Properties data 
) const
virtualinherited

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::transmi(), only if data==NULL.

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

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 void Gyoto::Astrobj::Generic::setMetric ( SmartPointer< Metric::Generic )
virtualinherited
virtual int Gyoto::Astrobj::Disk3D::setParameter ( std::string  name,
std::string  content 
)
virtual

Called from setParameters()

 Assume MyKind is a sublcass of Astrobj::Generic which has towo
 members (a string StringMember and a double DoubleMember):
int MyKind::setParameter(std::string name, std::string content) {
if (name=="StringMember") setStringMember(content);
else if (name=="DoubleMember") setDoubleMemeber(atof(content.c_str()));
else return Generic::setParameter(name, content);
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
Returns
0 if this parameter is known, 1 if it is not.

Reimplemented from Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::Disk3D_BB.

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

Main loop in Subcontractor_t function.

 The Subcontractor_t function for each Astrobj kind should look
 somewhat like this:
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) 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.

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

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::Disk3D::emissquant_
private

Inu(nu, r, z, phi)

An array of dimensionality double[nr_][nz_][nphi_][nnu_]. In FITS format, the first dimension is nu, the second phi, the third z and last r. It typically contains temperature and is used only by subclasses.

SmartPointer<Gyoto::Metric::Generic> Gyoto::Astrobj::Generic::gg_
protectedinherited

The Metric in this end of the Universe

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.

size_t Gyoto::Astrobj::Disk3D::repeat_phi_
private

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

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

Maximum distance to the center of the coordinate system.

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.

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::Disk3D::velocity_
private

velocity(r, z, phi)

An array of dimensionality double[nr_][nz_][nphi_][3]. In FITS format, the second dimension is phi, the third z and last r. The first plane in the first FITS dimention is dphi/dt, the second dz/dt the last dr/dt.


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