I_nu=constant_*nu^exponent_. More...

#include <GyotoPowerLawSpectrum.h>

Inheritance diagram for Gyoto::Spectrum::PowerLaw:

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

	PowerLaw (double exponent, double constant=1.)
	Constructor setting exponent_ and optionally constant_.

virtual PowerLaw *	clone () const
	Cloner.

double	constant () const
	Get constant_.

void	constant (double)
	Set constant_.

double	exponent () const
	Get exponent_.

void	exponent (double)
	Set exponent_.

std::vector< double >	cutoff (std::string const &unit) const
	Get cutoffs, specifying unit.

void	cutoff (std::vector< double > const &v, std::string const &unit)
	Set cutoffs, specifying unit.

std::vector< double >	cutoff () const
	Get cutoffs, in Hz.

void	cutoff (std::vector< double > const &v)
	Set cutoffs, in Hz.

virtual double	operator() (double nu) const
	I_nu = mySpectrum(nu), nu in Hz. Assumes optically thick regime.

const std::string	kind () const
	Get spectrum kind.

virtual double	operator() (double nu, double opacity, double ds) const
	I_nu in optically thin regime. More...

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
double	constant_
	I_nu=constant_*nu^exponent_.

double	exponent_
	I_nu=constant_*nu^exponent_.

double	minfreq_
	Lower-frequency cutoff (emits at nu>=minfreq_)

double	maxfreq_
	Upper-frequency cutoff (emits at nu<=maxfreq_)

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

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

Detailed Description

I_nu=constant_*nu^exponent_.

Light emitted by e.g. a Star.

XML stanza:

<Spectrum kind="PowerLaw">
  <Exponent> 0. </Exponent>
  <Constant> 1. </Constant>
</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

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

◆ 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::Screen, Gyoto::Scenery, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::XillverReflection, Gyoto::Metric::Shift, and Gyoto::Astrobj::NeutronStarModelAtmosphere.

◆ getProperties()

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

◆ operator()()

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

virtualinherited

I_nu in optically thin regime.

Generic implementation assumes emissivity = opacity.

Parameters

nu	frequency in Hz
opacity	such that opacity*ds=optical thickness.
ds	in geometrical units

Reimplemented in Gyoto::Spectrum::Python, Gyoto::Spectrum::PowerLawSynchrotron, Gyoto::Spectrum::KappaDistributionSynchrotron, Gyoto::Spectrum::ThermalSynchrotron, and Gyoto::Spectrum::ThermalBremsstrahlung.

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

◆ setParameter() [1/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::Star, Gyoto::Metric::RotStar3_1, Gyoto::Metric::KerrKS, and Gyoto::Astrobj::EquatorialHotSpot.

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

◆ 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::Photon, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Complex, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::Complex, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Metric::Complex, and Gyoto::Metric::Shift.

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

is written.

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

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

GyotoPowerLawSpectrum.h

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Subcontractor_t

Member Function Documentation

◆ describeProperty()

◆ fillElement()

◆ fillProperty()

◆ getProperties()

◆ help()

◆ integrate() [1/2]

◆ integrate() [2/2]

◆ isThreadSafe()

◆ operator()()

◆ property()

◆ setParameter() [1/2]

◆ setParameter() [2/2]

◆ setParameters()

Member Data Documentation

◆ kind_

◆ plugins_