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

#include <GyotoDisk3D.h>

Inheritance diagram for Gyoto::Astrobj::Disk3D:

Public Types
typedef Gyoto::SmartPointer< Gyoto::SmartPointee >	Subcontractor_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...

void	fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
	Output a single Property to XML. More...

	Disk3D ()
	Standard constructor.

	Disk3D (const Disk3D &)
	Copy constructor.

virtual Disk3D *	clone () const
	Cloner. More...

virtual	~Disk3D ()
	Destructor.

void	file (std::string const &f)

std::string	file () const

void	zsym (bool t)

bool	zsym () const

void	tPattern (double t)

double	tPattern () const

void	omegaPattern (double t)

double	omegaPattern () const

void	setEmissquant (double *pattern)
	Set Disk3D::emissquant_. More...

void	opacity (double *pattern)

void	setVelocity (double *pattern)
	Set Disk3D::velocity__. More...

virtual void	copyEmissquant (double const *const pattern=NULL, size_t const naxes[4]=NULL)
	Set Disk3D::emissquant_. More...

virtual double const *	getEmissquant () const
	Get Disk3D::emissquant_.

virtual void	getEmissquantNaxes (size_t naxes[4]) const
	Get { Disk3D::nnu_, Disk3D::nphi_, Disk3D::nz_, Disk3D::nr_ }.

virtual void	copyOpacity (double const *const pattern=NULL, size_t const naxes[4]=NULL)

virtual double const *	opacity () const
	Get Disk3D::opacity_.

virtual void	copyVelocity (double const *const pattern=NULL, size_t const naxes[3]=NULL)
	Set Disk3D::velocity_. More...

virtual double const *	getVelocity () const
	Get Disk3D::velocity_. More...

virtual void	repeatPhi (size_t n)
	Set Disk3D::repeat_phi_.

virtual size_t	repeatPhi () const
	Get Disk3D::repeat_phi_.

virtual void	nu0 (double freq)
	Set Disk3D::nu0_.

virtual double	nu0 () const
	Get Disk3D::nu0_.

virtual void	dnu (double dfreq)
	Set Disk3D::dnu_.

virtual double	dnu () const
	Get Disk3D::dnu_.

void	rin (double rrin)
	Set Disk3D::rin_.

double	rin () const
	Get Disk3D::rin_.

void	rout (double rout)
	Set Disk3D::rout_.

double	rout () const
	Get Disk3D::rout_.

void	zmin (double zmin)
	Set Disk3D::zmin_.

double	zmin () const
	Get Disk3D::zmin_.

void	zmax (double zmax)
	Set Disk3D::zmax_.

double	zmax () const
	Get Disk3D::zmax_.

void	phimin (double phimin)
	Set Disk3D::phimin_.

double	phimin () const
	Get Disk3D::phimin_.

void	phimax (double phimax)
	Set Disk3D::phimax_.

double	phimax () const
	Get Disk3D::phimax_.

int	Impact (Photon ph, size_t index, Astrobj::Properties data)
	Does a photon at these coordinates impact the object? More...

virtual void	getVelocity (double const pos[4], double vel[4])
	Get fluid 4-velocity at point. More...

virtual SmartPointer< Metric::Generic >	metric () const
	Get the Metric gg_. More...

virtual void	metric (SmartPointer< Metric::Generic >)
	Set the Metric gg_. More...

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, state_t const &coord_ph, double const coord_obj[8]=NULL) const
	Specific intensity I_ν More...

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

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, state_t const &c_ph, double const c_obj[8]=NULL) const
	∫_ν₁^ν₂ I_ν dν (or j_ν) More...

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, state_t const &cph, double const co) const
	∫_ν₁^ν₂ 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 =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( α_ν * ds_em ) 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	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...

Static Public Attributes
static GYOTO_OBJECT Property const	properties []

Protected Member Functions
void	getIndices (size_t i[4], double const co[4], double nu=0.) const
	Get emissquant_ cell corresponding to position co[4].

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

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

Private Attributes
std::string	filename_
	Optional FITS file name containing the arrays.

double *	emissquant_
	Physical quantity yielding emission. More...

double *	opacity_
	Opacity, same dimensions as emissquant_.

double *	velocity_
	Velocity(r, z, phi) 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	dz_
	Altitude step.

double	zmin_
	Minimum altitude.

size_t	nz_
	Grid size in the altitude direction.

double	zmax_
	Maximum altitude.

double	dr_
	Radius step.

double	rin_
	Inner radius of the grid.

size_t	nr_
	Number of rows in the patternGrid size in the r direction.

double	rout_
	Outer radius of the grid.

int	zsym_
	1 to symmetrize the grid z -> -z (default case)

double	tPattern_
	If the disk is being rotated (like a pattern disk) this is the origin of time for this rotation.

double	omegaPattern_
	If the disk is being rotated (like a pattern disk) this is the rotation velocity dphi/dt.

int	__defaultfeatures
	Whether some virtual methods are implemented. More...

int	refCount
	Reference counter.

pthread_mutex_t	mutex_
	A mutex. More...

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 of cylindrical geometry. The disk is a slab from rin_ to rout_ and zmin_ (typically = -zmax_) to zmax_.

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

virtual Disk3D * Gyoto::Astrobj::Disk3D::clone ( ) const

virtual

Cloner.

Implements Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::DynamicalDisk3D.

◆ copyEmissquant()

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

virtual

Set Disk3D::emissquant_.

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

If Disk3D::velocity_ or has been set previously with mismatching sizes, it is deallocated too.

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

Parameters

pattern	Array to copy as emission_. May be NULL in which case emission_ is simply deallocated and set to NULL.
naxes	{ nnu_, nphi_, nz_, nr_ }.

◆ copyVelocity()

virtual void Gyoto::Astrobj::Disk3D::copyVelocity	(	double const *const	pattern = `NULL`,
		size_t const	naxes[3] = `NULL`
	)

virtual

Set Disk3D::velocity_.

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

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

Parameters

pattern	Array to copy as velocity_. May be NULL in which case velocity_ is simply deallocated and set to NULL.
naxes	{ nphi_, nz_, nr_ }.

◆ deltaMax()

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

virtualinherited

Get max step constraint for adaptive integration.

Parameters

[in] coord position

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 void Gyoto::Astrobj::Generic::emission	(	double	Inu[],
		double const	nu_em[],
		size_t	nbnu,
		double	dsem,
		state_t const &	coord_ph,
		double const	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
nbnu	Size of Inu[] and nu_em[]
dsem	Length over which to integrate inside the object
coord_ph	Photon coordinate
coord_obj	Emitter coordinate at current photon position

Returns: I_ν or dI_ν [W m-2 sr-2]

Reimplemented in Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

◆ emission() [2/2]

virtual double Gyoto::Astrobj::Generic::emission	(	double	nu_em,
		double	dsem,
		state_t const &	coord_ph,
		double const	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 ds_em, in the emitter's frame. It should take self-absorption along ds_em into account.

Reminder :

intensity = I_ν [J m^-2 s^-1 ster^-1 Hz^-1];
invariant intensity = I_ν/ν³, 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_ν/ν², which has the same value in any frame.

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

d(I_ν/ν³)/dλ = (j_ν/ν²) [*]

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 ds_em if optically thin. It allows for a quick implementation of your object for visualization purposes.

Parameters

nu_em	Frequency at emission [Hz]
dsem	length over which to integrate inside the object [geometrical units]
coord_ph	Photon coordinate
coord_obj	Emitter coordinate at current photon position

Reimplemented in Gyoto::Astrobj::DynamicalDiskBolometric, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::NeutronStarAnalyticEmission, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::XillverReflection, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::ThinDiskIronLine, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::Torus, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::UniformSphere.

◆ 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::Astrobj::Complex, Gyoto::Spectrometer::Complex, and Gyoto::Scenery.

◆ fillProperty()

void Gyoto::Astrobj::Disk3D::fillProperty	(	Gyoto::FactoryMessenger *	fmp,
		Property const &	p
	)		const

virtual

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;
 virtual void fillProperty(Gyoto::FactoryMessenger *fmp,
                        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 from Gyoto::Object.

◆ 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::Disk3D::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::Generic.

Reimplemented in Gyoto::Astrobj::DynamicalDisk3D.

◆ getVelocity() [1/2]

virtual double const * Gyoto::Astrobj::Disk3D::getVelocity ( ) const

virtual

Get Disk3D::velocity_.

Reimplemented in Gyoto::Astrobj::DynamicalDisk3D.

◆ getVelocity() [2/2]

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

Parameters

[in]	pos	4-position at which to compute velocity;
[out]	vel	4-velocity at pos.

Reimplemented in Gyoto::Astrobj::DynamicalDisk3D.

◆ help()

void Gyoto::Object::help ( ) const

inherited

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

◆ Impact()

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

ph	Gyoto::Photon aimed at the object;
index	Index of the last photon step;
data	Pointer to a structure to hold the observables at impact.

Returns: 1 if impact, 0 if not.

Implements Gyoto::Astrobj::Generic.

◆ integrateEmission() [1/2]

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

virtualinherited

∫_ν₁^ν₂ 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 in Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

◆ integrateEmission() [2/2]

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

virtualinherited

∫_ν₁^ν₂ I_ν dν (or j_ν)

Compute the integral of emission() from ν₁ to ν₂. 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::Torus, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

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

◆ metric() [1/2]

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

virtualinherited

Get the Metric gg_.

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::Jet, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::ThickDisk, and Gyoto::Astrobj::XillverReflection.

◆ metric() [2/2]

virtual void Gyoto::Astrobj::Generic::metric ( SmartPointer< Metric::Generic > )

virtualinherited

Set the Metric gg_.

Reimplemented in Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Complex, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Complex, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::Jet, Gyoto::Astrobj::Jet, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::XillverReflection, and Gyoto::Astrobj::XillverReflection.

◆ opticallyThin() [1/2]

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

inherited

Query whether object is optically thin.

See opticallyThin(bool flag).

◆ opticallyThin() [2/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

flag	1 if optically thin, 0 if optically thick.

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

◆ radiativeQ()

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

virtualinherited

emission and transmission together

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::Jet, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::FlaredDiskSynchrotron.

◆ 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::Complex, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.

◆ rMax() [2/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

val	new rmax_ in geometrical units.

◆ rMax() [3/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

val	rmax_ expressed in unit "unit";
unit	string...

◆ rMax() [4/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

unit string

Returns: double rmax converted to unit

◆ setEmissquant()

void Gyoto::Astrobj::Disk3D::setEmissquant ( double * pattern )

Set Disk3D::emissquant_.

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.

◆ setParameter() [1/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

p	Property that matches name (p.name == name or p.name_false == name)
name	XML name of the parameter (XML entity)
content	string representation of the value
unit	string representation of the unit

Reimplemented in Gyoto::Astrobj::PolishDoughnut.

◆ setParameter() [2/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

name	XML 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.
content	string representation of the value
unit	string representation of the unit

Returns: 0 if this parameter is known, 1 if it is not.

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

◆ 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::Complex, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::Star, and Gyoto::Astrobj::OscilTorus.

◆ setVelocity()

void Gyoto::Astrobj::Disk3D::setVelocity ( double * pattern )

Set Disk3D::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.

◆ 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( α_ν * ds_em )

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

nuem	frequency in the fluid's frame
coord	Photon coordinate
dsem	geometrical length in geometrical units

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

Member Data Documentation

◆ __defaultfeatures

int Gyoto::Astrobj::Generic::__defaultfeatures

privateinherited

Whether some virtual methods are implemented.

The default implementations of some methods call one-another. This member is used internally to avoid infinite recursion.

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

◆ emissquant_

double* Gyoto::Astrobj::Disk3D::emissquant_

private

Physical quantity yielding emission.

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.

◆ kind_

std::string Gyoto::Object::kind_

protectedinherited

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

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

Gyoto::Astrobj::Generic::kind

const std::string kind() const

Get the kind of the Astrobj (e.g. "Star")

is written.

◆ mutex_

pthread_mutex_t Gyoto::SmartPointee::mutex_

privateinherited

A mutex.

When compiled with libpthread

◆ 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

is written.

◆ repeat_phi_

size_t Gyoto::Astrobj::Disk3D::repeat_phi_

private

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

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

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

◆ velocity_

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:

GyotoDisk3D.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Subcontractor_t

Member Function Documentation

◆ clone()

◆ copyEmissquant()

◆ copyVelocity()

◆ deltaMax()

◆ describeProperty()

◆ emission() [1/2]

◆ emission() [2/2]

◆ fillElement()

◆ fillProperty()

◆ getDefaultQuantities()

◆ getProperties()

◆ getVelocity() [1/2]

◆ getVelocity() [2/2]

◆ help()

◆ Impact()

◆ integrateEmission() [1/2]

◆ integrateEmission() [2/2]

◆ isThreadSafe()

◆ metric() [1/2]

◆ metric() [2/2]

◆ opticallyThin() [1/2]

◆ opticallyThin() [2/2]

◆ processHitQuantities()

◆ property()

◆ radiativeQ()

◆ rMax() [1/4]

◆ rMax() [2/4]

◆ rMax() [3/4]

◆ rMax() [4/4]

◆ setEmissquant()

◆ setParameter() [1/2]

◆ setParameter() [2/2]

◆ setParameters()

◆ setVelocity()

◆ transmission()

Member Data Documentation

◆ __defaultfeatures

◆ deltamaxinsidermax_

◆ emissquant_

◆ kind_

◆ mutex_

◆ plugins_

◆ repeat_phi_

◆ rmax_

◆ velocity_