Gyoto::Spectrum::PowerLawSynchrotron Class Reference

Powerlaw synchrotron spectrum. More...

#include <GyotoPowerLawSynchrotronSpectrum.h>

Inheritance diagram for Gyoto::Spectrum::PowerLawSynchrotron:

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...
	PowerLawSynchrotron (const PowerLawSynchrotron &)
virtual PowerLawSynchrotron *	clone () const
	Cloner. More...
virtual double	operator() (double nu) const
virtual double	operator() (double nu, double, double ds) const
double	numberdensityCGS () const
void	numberdensityCGS (double rho)
double	angle_B_pem () const
void	angle_B_pem (double rho)
double	cyclotron_freq () const
void	cyclotron_freq (double rho)
double	PLindex () const
void	PLindex (double ind)
bool	angle_averaged () const
void	angle_averaged (bool ang)
double	jnuCGS (double nu) const
double	alphanuCGS (double nu) const
void	radiativeQ (double jnu[], double anu[], double const nu_ems[], size_t nbnu)
const std::string	kind () const
	Get spectrum kind.
virtual double	integrate (double nu1, double nu2)
	Integrate optically thick I_nu. More...
virtual double	integrate (double nu1, double nu2, const Spectrum::Generic *opacity, double ds)
	Integrate optically thin I_nu. More...
void	incRefCount ()
	Increment the reference counter. Warning: Don't mess with the counter.
int	decRefCount ()
	Decrement the reference counter and return current value. Warning: Don't mess with the counter.
int	getRefCount ()
	Get the current number of references.
virtual bool	isThreadSafe () const
	Whether this class is thread-safe. More...
void	set (Property const &p, Value val)
	Set Value of a Property.
void	set (Property const &p, Value val, std::string const &unit)
	Set Value (expressed in unit) of a Property.
void	set (std::string const &pname, Value val)
	Set Value of a Property.
void	set (std::string const &pname, Value val, std::string const &unit)
	Set Value (expressed in unit) of a Property.
Value	get (Property const &p) const
	Get Value of a Property.
Value	get (std::string const &pname) const
	Get Value of a Property.
Value	get (Property const &p, std::string const &unit) const
	Get Value of a Property, converted to unit.
Value	get (std::string const &pname, std::string const &unit) const
	Get Value of a Property, converted to unit.
Property const *	property (std::string const pname) const
	Find property by name. More...
virtual void	fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
	Output a single Property to XML. More...
virtual void	fillElement (Gyoto::FactoryMessenger *fmp) const
	Fill the XML element for this Object. More...
virtual void	setParameters (Gyoto::FactoryMessenger *fmp)
	Main loop for parsing Properties from XML description. 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 Attributes
SmartPointer< Spectrum::BlackBody >	spectrumBB_
	blackbody emission
double	numberdensityCGS_
	Number density in CGS UNITS (careful)
double	angle_B_pem_
	Angle between Bfield and emission direction (rad)
double	cyclotron_freq_
	Cyclotron frequency (e*B / 2*pi*me*c)
double	PLindex_
	Power law index: electron spectrum \propto gamma^-PLindex_.
bool	angle_averaged_
	Boolean for angle averaging.
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
int	refCount
	Reference counter.
pthread_mutex_t	mutex_
	A mutex. More...

Friends
class	Gyoto::SmartPointer< Gyoto::Spectrum::PowerLawSynchrotron >

Detailed Description

Powerlaw synchrotron spectrum.

Example XML entity:

<Spectrum kind="PowerLawSynchrotron">
</Spectrum>

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

alphanuCGS()

double Gyoto::Spectrum::PowerLawSynchrotron::alphanuCGS

(

double

nu

)

const

Returns the absorption coefficient alpha_nu in cgs units [cm^-1]

Parameters

nu	frequency in Hz

clone()

virtual PowerLawSynchrotron * Gyoto::Spectrum::PowerLawSynchrotron::clone ( ) const

virtual

Cloner.

Reimplemented from Gyoto::Spectrum::Generic.

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.

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

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

virtualinherited

Output a single Property to XML.

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

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

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

class A: public Object {};
class B: public A { 
 using B::setParameter;
 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 in Gyoto::Scenery, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Screen, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, and Gyoto::Astrobj::XillverReflection.

getProperties()

virtual Property const * Gyoto::Spectrum::PowerLawSynchrotron::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::Spectrum::Generic.

help()

void Gyoto::Object::help ( ) const

inherited

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

integrate() [1/2]

virtual double Gyoto::Spectrum::Generic::integrate ( double  nu1, double  nu2  )

virtualinherited

Integrate optically thick I_nu.

See operator()(double nu) const

Parameters

nu1,nu2

boundaries for the integration

Returns

I, the integral of I_nu between nu1 and nu2

Reimplemented in Gyoto::Spectrum::Python.

integrate() [2/2]

virtual double Gyoto::Spectrum::Generic::integrate ( double  nu1, double  nu2, const Spectrum::Generic *  opacity, double  ds  )

virtualinherited

Integrate optically thin I_nu.

See operator()(double nu, double opacity, double ds) const

Parameters

nu1,nu2	boundaries for the integration
opacity	the frequency-dependent opacity law given as a pointer to a Gyoto::Spectrum::Generic sub-class instance
ds	the element length for spatial integration

Returns

I, the integral of I_nu between nu1 and nu2

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.

jnuCGS()

double Gyoto::Spectrum::PowerLawSynchrotron::jnuCGS

(

double

nu

)

const

Returns the emission coefficient j_nu in cgs units i.e. erg cm^-3 s^-1 ster^-1 Hz^-1

Parameters

nu	frequency in Hz

operator()() [1/2]

virtual double Gyoto::Spectrum::PowerLawSynchrotron::operator() ( double  nu ) const

virtual

This function returns the optically thick Inu which is not defined here, returns an error

Parameters

nu	frequency in Hz

Implements Gyoto::Spectrum::Generic.

operator()() [2/2]

virtual double Gyoto::Spectrum::PowerLawSynchrotron::operator() ( double  nu, double  , double  ds  ) const

virtual

This function returns the optically thin increment to intensity dI_nu = j_nu*ds*exp(-alpha_nu*ds) in SI units

Parameters

nu	frequency in Hz
ds	length element in SI (careful to this)

Reimplemented from Gyoto::Spectrum::Generic.

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

void Gyoto::Spectrum::PowerLawSynchrotron::radiativeQ	(	double	jnu[],
		double	anu[],
		double const	nu_ems[],
		size_t	nbnu
	)

Returns the emission and absorption coef in SI

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::Object::setParameters ( Gyoto::FactoryMessenger *  fmp )

virtualinherited

Main loop for parsing Properties from XML description.

 This function queries the FactoryMessenger for elements to parse,
 and tries to matche each element to a Property to set it
 accordingly.

 Any class that tries to be buildable from XML must supply a
 subcontractor (for base classes such as Metric, Astrobj, Spectrum
 and Spectrometer, it is done as a template that must be
 specialized for each class).

 This subcontractor typically looks somewhat like this:

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

 Although this is discouraged, it is possible to override the
 following functions to customize how XML entities are parsed:
   - setParameters() if low-level access to the
     FactoryMessenger is required;
   - setParameter(std::string name,
                  std::string content,
                  std::string unit)
     to interpret an entity that does not match a Property
     (e.g. alternative name);
   - setParameter(Gyoto::Property const &p,
                  std::string const &name,
                  std::string const &content,
                  std::string const &unit)
     to change how a Property is interpreted.

Reimplemented in Gyoto::Astrobj::Generic, Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Photon, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, and Gyoto::Astrobj::OscilTorus.

Member Data Documentation

kind_

std::string Gyoto::Object::kind_

protectedinherited

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

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

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

is written.

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

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

is written.

---

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

• GyotoPowerLawSynchrotronSpectrum.h