/*************************************************************************** * GModelSpectralPlawEnergyFlux.cpp - Spectral power law model class * * ----------------------------------------------------------------------- * * copyright (C) 2016 by Michael Mayer * * ----------------------------------------------------------------------- * * * * This program is free software: you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation, either version 3 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program. If not, see . * * * ***************************************************************************/ /** * @file GModelSpectralPlawEnergyFlux.cpp * @brief Energy flux normalized power law spectral model class implementation * @author Michael Mayer */ /* __ Includes ___________________________________________________________ */ #ifdef HAVE_CONFIG_H #include #endif #include #include "GException.hpp" #include "GTools.hpp" #include "GMath.hpp" #include "GRan.hpp" #include "GModelSpectralPlawEnergyFlux.hpp" #include "GModelSpectralRegistry.hpp" /* __ Constants __________________________________________________________ */ /* __ Globals ____________________________________________________________ */ const GModelSpectralPlawEnergyFlux g_spectral_plaw_eflux_seed("PowerLaw", "EnergyFlux", "Index", "LowerLimit", "UpperLimit"); const GModelSpectralRegistry g_spectral_plaw_eflux_registry(&g_spectral_plaw_eflux_seed); /* __ Method name definitions ____________________________________________ */ #define G_FLUX "GModelSpectralPlawEnergyFlux::flux(GEnergy&, GEnergy&)" #define G_EFLUX "GModelSpectralPlawEnergyFlux::eflux(GEnergy&, GEnergy&)" #define G_MC "GModelSpectralPlawEnergyFlux::mc(GEnergy&, GEnergy&, GTime&, "\ "GRan&)" #define G_READ "GModelSpectralPlawEnergyFlux::read(GXmlElement&)" #define G_WRITE "GModelSpectralPlawEnergyFlux::write(GXmlElement&)" /* __ Macros _____________________________________________________________ */ /* __ Coding definitions _________________________________________________ */ /* __ Debug definitions __________________________________________________ */ /*========================================================================== = = = Constructors/destructors = = = ==========================================================================*/ /***********************************************************************//** * @brief Void constructor ***************************************************************************/ GModelSpectralPlawEnergyFlux::GModelSpectralPlawEnergyFlux(void) : GModelSpectral() { // Initialise members init_members(); // Return return; } /***********************************************************************//** * @brief Model type and parameter name constructor * * @param[in] type Model type. * @param[in] eflux Name of energy flux parameter. * @param[in] index Name of index parameter. * @param[in] emin Name of emin parameter. * @param[in] emax Name of emax parameter. ***************************************************************************/ GModelSpectralPlawEnergyFlux::GModelSpectralPlawEnergyFlux(const std::string& type, const std::string& eflux, const std::string& index, const std::string& emin, const std::string& emax) : GModelSpectral() { // Initialise members init_members(); // Set model type m_type = type; // Set parameter names m_eflux.name(eflux); m_index.name(index); m_emin.name(emin); m_emax.name(emax); // Return return; } /***********************************************************************//** * @brief Constructor * * @param[in] eflux Energy flux (erg/cm2/s). * @param[in] index Power law index. * @param[in] emin Minimum energy. * @param[in] emax Maximum energy. * * Construct a spectral power law from the * - energy flux (in erg/cm2/s), * - spectral index, * - minimum energy and * - maximum energy. ***************************************************************************/ GModelSpectralPlawEnergyFlux::GModelSpectralPlawEnergyFlux(const double& eflux, const double& index, const GEnergy& emin, const GEnergy& emax) : GModelSpectral() { // Initialise members init_members(); // Set parameters m_eflux.value(eflux); m_index.value(index); m_emin.value(emin.MeV()); m_emax.value(emax.MeV()); // Return return; } /***********************************************************************//** * @brief XML constructor * * @param[in] xml XML element. * * Constructs energy flux normalized power law spectral model by extracting * information from an XML element. ***************************************************************************/ GModelSpectralPlawEnergyFlux::GModelSpectralPlawEnergyFlux(const GXmlElement& xml) : GModelSpectral() { // Initialise members init_members(); // Read information from XML element read(xml); // Return return; } /***********************************************************************//** * @brief Copy constructor * * @param[in] model Spectral power law model. ***************************************************************************/ GModelSpectralPlawEnergyFlux::GModelSpectralPlawEnergyFlux(const GModelSpectralPlawEnergyFlux& model) : GModelSpectral(model) { // Initialise members init_members(); // Copy members copy_members(model); // Return return; } /***********************************************************************//** * @brief Destructor ***************************************************************************/ GModelSpectralPlawEnergyFlux::~GModelSpectralPlawEnergyFlux(void) { // Free members free_members(); // Return return; } /*========================================================================== = = = Operators = = = ==========================================================================*/ /***********************************************************************//** * @brief Assignment operator * * @param[in] model Spectral power law model. * @return Spectral power law model. ***************************************************************************/ GModelSpectralPlawEnergyFlux& GModelSpectralPlawEnergyFlux::operator=(const GModelSpectralPlawEnergyFlux& model) { // Execute only if object is not identical if (this != &model) { // Copy base class members this->GModelSpectral::operator=(model); // Free members free_members(); // Initialise members init_members(); // Copy members copy_members(model); } // endif: object was not identical // Return return *this; } /*========================================================================== = = = Public methods = = = ==========================================================================*/ /***********************************************************************//** * @brief Clear power law model ***************************************************************************/ void GModelSpectralPlawEnergyFlux::clear(void) { // Free class members (base and derived classes, derived class first) free_members(); this->GModelSpectral::free_members(); // Initialise members this->GModelSpectral::init_members(); init_members(); // Return return; } /***********************************************************************//** * @brief Clone power law model * * @return Pointer to deep copy of power law model ***************************************************************************/ GModelSpectralPlawEnergyFlux* GModelSpectralPlawEnergyFlux::clone(void) const { // Clone power law model return new GModelSpectralPlawEnergyFlux(*this); } /***********************************************************************//** * @brief Evaluate function * * @param[in] srcEng True photon energy. * @param[in] srcTime True photon arrival time. * @param[in] gradients Compute gradients? * @return Model value (ph/cm2/s/MeV). * * Computes * * \f[ * S_{\rm E}(E | t) = {\tt m\_eflux} * \frac{{\tt m\_index}+2} * {{\tt e\_max}^{{\tt m\_index}+2} - * {\tt e\_min}^{{\tt m\_index}+2}} * E^{\tt m\_index} * \f] * * for \f${\tt m\_index} \ne -2\f$ and * * \f[ * S_{\rm E}(E | t) = * \frac{{\tt m\_eflux}} * {\log {\tt e\_max} - \log {\tt e\_min}} * E^{\tt m\_index} * \f] * * for \f${\tt m\_index} = -2\f$, where * - \f${\tt e\_min}\f$ is the minimum energy of an interval, * - \f${\tt e\_max}\f$ is the maximum energy of an interval, * - \f${\tt m\_eflux}\f$ is the energy flux between * \f${\tt e\_min}\f$ and \f${\tt e\_max}\f$, and * - \f${\tt m\_index}\f$ is the spectral index. * * If the @p gradients flag is true the method will also compute the * partial derivatives of the model with respect to the parameters using * * \f[ * \frac{\delta S_{\rm E}(E | t)}{\delta {\tt m\_eflux}} = * \frac{S_{\rm E}(E | t)}{{\tt m\_eflux}} * \f] * * \f[ * \frac{\delta S_{\rm E}(E | t)}{\delta {\tt m\_index}} = * S_{\rm E}(E | t) \, * \left( \frac{1}{{\tt m\_index}+2} - * \frac{\log({\tt e\_max}) {\tt e\_max}^{{\tt m\_index}+2} - * \log({\tt e\_min}) {\tt e\_min}^{{\tt m\_index}+2}} * {{\tt e\_max}^{{\tt m\_index}+2} - * {\tt e\_min}^{{\tt m\_index}+2}} * + \ln(E) \right) * \f] * * for \f${\tt m\_index} \ne -2\f$ and * * \f[ * \frac{\delta S_{\rm E}(E | t)}{\delta {\tt m\_index}} = * S_{\rm E}(E | t) \, \ln(E) * \f] * * for \f${\tt m\_index} = -2\f$. * * No partial derivatives are supported for the energy boundaries. ***************************************************************************/ double GModelSpectralPlawEnergyFlux::eval(const GEnergy& srcEng, const GTime& srcTime, const bool& gradients) const { // Update precomputed values update(srcEng); // Compute function value double value = m_eflux.value() * gammalib::erg2MeV * m_norm * m_power; // Optionally compute gradients if (gradients) { // Compute partial derivatives of the parameter values double g_eflux = (m_eflux.is_free() && m_eflux.factor_value() > 0.0) ? g_eflux = value / m_eflux.factor_value() : 0.0; double g_index = (m_index.is_free()) ? value * (m_g_norm + gammalib::ln10 * srcEng.log10MeV()) * m_index.scale() : 0.0; // Set gradients m_eflux.factor_gradient(g_eflux); m_index.factor_gradient(g_index); } // endif: gradient computation was requested // Compile option: Check for NaN/Inf #if defined(G_NAN_CHECK) if (gammalib::is_notanumber(value) || gammalib::is_infinite(value)) { std::cout << "*** ERROR: GModelSpectralPlawEnergyFlux::eval"; std::cout << "(srcEng=" << srcEng; std::cout << ", srcTime=" << srcTime << "):"; std::cout << " NaN/Inf encountered"; std::cout << " (value=" << value; std::cout << ", eflux=" << eflux(); std::cout << ", m_norm=" << m_norm; std::cout << ", m_power=" << m_power; std::cout << ")" << std::endl; } #endif // Return return value; } /***********************************************************************//** * @brief Returns model photon flux between [emin, emax] (units: ph/cm2/s) * * @param[in] emin Minimum photon energy. * @param[in] emax Minimum photon energy. * @return Photon flux (ph/cm2/s). * * Computes * * \f[ * \int_{\tt emin}^{\tt emax} S_{\rm E}(E | t) dE * \f] * * where * - [@p emin, @p emax] is an energy interval, and * - \f$S_{\rm E}(E | t)\f$ is the spectral model (ph/cm2/s/MeV). ***************************************************************************/ double GModelSpectralPlawEnergyFlux::flux(const GEnergy& emin, const GEnergy& emax) const { // Initialise flux double flux = 0.0; // Compute only if integration range is valid if (emin < emax) { // Compute power law normalization double norm = 0.0; if (index() != -2.0) { double gamma = m_index.value() + 2.0; double pow_ref_emin = std::pow(this->emin().MeV(), gamma); double pow_ref_emax = std::pow(this->emax().MeV(), gamma); norm = m_eflux.value() * gammalib::erg2MeV * gamma / (pow_ref_emax - pow_ref_emin); } else { double log_ref_emin = std::log(this->emin().MeV()); double log_ref_emax = std::log(this->emax().MeV()); norm = m_eflux.value() * gammalib::erg2MeV / (log_ref_emax - log_ref_emin); } // Compute photon flux if (index() != -1.0) { double gamma = m_index.value() + 1.0; double pow_emin = std::pow(emin.MeV(), gamma); double pow_emax = std::pow(emax.MeV(), gamma); flux = norm / gamma * (pow_emax - pow_emin); } // Case B: Index is -1 else { double log_emin = std::log(emin.MeV()); double log_emax = std::log(emax.MeV()); flux = norm * (log_emax - log_emin); } } // endif: integration range was valid // Return flux return flux; } /***********************************************************************//** * @brief Returns model energy flux between [emin, emax] (units: erg/cm2/s) * * @param[in] emin Minimum photon energy. * @param[in] emax Minimum photon energy. * @return Energy flux (erg/cm2/s). * * Computes * * \f[ * \int_{\tt emin}^{\tt emax} S_{\rm E}(E | t) E \, dE * \f] * * where * - [@p emin, @p emax] is an energy interval, and * - \f$S_{\rm E}(E | t)\f$ is the spectral model (ph/cm2/s/MeV). ***************************************************************************/ double GModelSpectralPlawEnergyFlux::eflux(const GEnergy& emin, const GEnergy& emax) const { // Initialise flux double eflux = 0.0; // Compute only if integration range is valid if (emin < emax) { // Compute power law normalization double norm; if (index() != -2.0) { double gamma = m_index.value() + 2.0; double pow_ref_emin = std::pow(this->emin().MeV(), gamma); double pow_ref_emax = std::pow(this->emax().MeV(), gamma); double pow_emin = std::pow(emin.MeV(), gamma); double pow_emax = std::pow(emax.MeV(), gamma); double factor = (pow_emax - pow_emin) / (pow_ref_emax - pow_ref_emin); eflux = m_eflux.value() * factor; } else { double log_emin = std::log(emin.MeV()); double log_emax = std::log(emax.MeV()); double log_ref_emin = std::log(this->emin().MeV()); double log_ref_emax = std::log(this->emax().MeV()); double factor = (log_emax - log_emin) / (log_ref_emax - log_ref_emin); eflux = m_eflux.value() * factor; } } // endif: integration range was valid // Return flux return eflux; } /***********************************************************************//** * @brief Returns MC energy between [emin, emax] * * @param[in] emin Minimum photon energy. * @param[in] emax Maximum photon energy. * @param[in] time True photon arrival time. * @param[in,out] ran Random number generator. * @return Energy. * * @exception GException::erange_invalid * Energy range is invalid (emin < emax required). * * Returns Monte Carlo energy by randomly drawing from a power law. ***************************************************************************/ GEnergy GModelSpectralPlawEnergyFlux::mc(const GEnergy& emin, const GEnergy& emax, const GTime& time, GRan& ran) const { // Throw an exception if energy range is invalid if (emin >= emax) { throw GException::erange_invalid(G_MC, emin.MeV(), emax.MeV(), "Minimum energy < maximum energy required."); } // Allocate energy GEnergy energy; // Case A: Index is not -1 if (index() != -1.0) { double exponent = index() + 1.0; double e_max = std::pow(emax.MeV(), exponent); double e_min = std::pow(emin.MeV(), exponent); double u = ran.uniform(); double eng = (u > 0.0) ? std::exp(std::log(u * (e_max - e_min) + e_min) / exponent) : 0.0; energy.MeV(eng); } // Case B: Index is -1 else { double e_max = std::log(emax.MeV()); double e_min = std::log(emin.MeV()); double u = ran.uniform(); double eng = std::exp(u * (e_max - e_min) + e_min); energy.MeV(eng); } // Return energy return energy; } /***********************************************************************//** * @brief Read model from XML element * * @param[in] xml XML element. * * Reads the spectral information from an XML element. ***************************************************************************/ void GModelSpectralPlawEnergyFlux::read(const GXmlElement& xml) { // Get parameter pointers const GXmlElement* eflux = gammalib::xml_get_par(G_READ, xml, m_eflux.name()); const GXmlElement* index = gammalib::xml_get_par(G_READ, xml, m_index.name()); const GXmlElement* emin = gammalib::xml_get_par(G_READ, xml, m_emin.name()); const GXmlElement* emax = gammalib::xml_get_par(G_READ, xml, m_emax.name()); // Read parameters m_eflux.read(*eflux); m_index.read(*index); m_emin.read(*emin); m_emax.read(*emax); // Return return; } /***********************************************************************//** * @brief Write model into XML element * * @param[in] xml XML element. * * @exception GException::model_invalid_spectral * Existing XML element is not of type "PowerLaw" * * Writes the spectral information into an XML element. ***************************************************************************/ void GModelSpectralPlawEnergyFlux::write(GXmlElement& xml) const { // Set model type if (xml.attribute("type") == "") { xml.attribute("type", type()); } // Verify model type if (xml.attribute("type") != type()) { throw GException::model_invalid_spectral(G_WRITE, xml.attribute("type"), "Spectral model is not of type \""+type()+"\"."); } // Get XML parameters GXmlElement* eflux = gammalib::xml_need_par(G_WRITE, xml, m_eflux.name()); GXmlElement* index = gammalib::xml_need_par(G_WRITE, xml, m_index.name()); GXmlElement* emin = gammalib::xml_need_par(G_WRITE, xml, m_emin.name()); GXmlElement* emax = gammalib::xml_need_par(G_WRITE, xml, m_emax.name()); // Write parameters m_eflux.write(*eflux); m_index.write(*index); m_emin.write(*emin); m_emax.write(*emax); // Return return; } /***********************************************************************//** * @brief Print power law information * * @param[in] chatter Chattiness. * @return String containing power law information. ***************************************************************************/ std::string GModelSpectralPlawEnergyFlux::print(const GChatter& chatter) const { // Initialise result string std::string result; // Continue only if chatter is not silent if (chatter != SILENT) { // Append header result.append("=== GModelSpectralPlawEnergyFlux ==="); // Append information result.append("\n"+gammalib::parformat("Number of parameters")); result.append(gammalib::str(size())); for (int i = 0; i < size(); ++i) { result.append("\n"+m_pars[i]->print(chatter)); } } // endif: chatter was not silent // Return result return result; } /*========================================================================== = = = Private methods = = = ==========================================================================*/ /***********************************************************************//** * @brief Initialise class members ***************************************************************************/ void GModelSpectralPlawEnergyFlux::init_members(void) { // Initialise model type m_type = "PowerLaw"; // Initialise energy flux m_eflux.clear(); m_eflux.name("EnergyFlux"); m_eflux.unit("erg/cm2/s"); m_eflux.scale(1.0); m_eflux.value(1.0); // default: 1.0 m_eflux.range(0.0, 10.0); // range: [0,10] m_eflux.free(); m_eflux.gradient(0.0); m_eflux.has_grad(true); // Initialise powerlaw index m_index.clear(); m_index.name("Index"); m_index.scale(1.0); m_index.value(-2.0); // default: -2.0 m_index.range(-10.0,+10.0); // range: [-10,+10] m_index.free(); m_index.gradient(0.0); m_index.has_grad(true); // Initialise lower limit m_emin.clear(); m_emin.name("LowerLimit"); m_emin.unit("MeV"); m_emin.scale(1.0); m_emin.value(100.0); // default: 100 m_emin.range(0.001, 1.0e15); // range: [0.001, 1e15] m_emin.fix(); m_emin.gradient(0.0); m_emin.has_grad(false); // Initialise upper limit m_emax.clear(); m_emax.name("UpperLimit"); m_emax.unit("MeV"); m_emax.scale(1.0); m_emax.value(500000.0); // default: 500000 m_emin.range(0.001, 1.0e15); // range: [0.001, 1e15] m_emax.fix(); m_emax.gradient(0.0); m_emax.has_grad(false); // Set parameter pointer(s) m_pars.clear(); m_pars.push_back(&m_eflux); m_pars.push_back(&m_index); m_pars.push_back(&m_emin); m_pars.push_back(&m_emax); // Initialise last parameters (for fast computation) m_log_emin = 0.0; m_log_emax = 0.0; m_pow_emin = 0.0; m_pow_emax = 0.0; m_norm = 0.0; m_power = 0.0; m_last_index = 1000.0; m_last_emin.MeV(0.0); m_last_emax.MeV(0.0); m_last_energy.MeV(0.0); // Return return; } /***********************************************************************//** * @brief Copy class members * * @param[in] model Spectral power law model. ***************************************************************************/ void GModelSpectralPlawEnergyFlux::copy_members(const GModelSpectralPlawEnergyFlux& model) { // Copy members m_type = model.m_type; m_eflux = model.m_eflux; m_index = model.m_index; m_emin = model.m_emin; m_emax = model.m_emax; // Set parameter pointer(s) m_pars.clear(); m_pars.push_back(&m_eflux); m_pars.push_back(&m_index); m_pars.push_back(&m_emin); m_pars.push_back(&m_emax); // Copy bookkeeping information m_log_emin = model.m_log_emin; m_log_emax = model.m_log_emax; m_pow_emin = model.m_pow_emin; m_pow_emax = model.m_pow_emax; m_norm = model.m_norm; m_power = model.m_power; m_last_index = model.m_last_index; m_last_emin = model.m_last_emin; m_last_emax = model.m_last_emax; m_last_energy = model.m_last_energy; // Return return; } /***********************************************************************//** * @brief Delete class members ***************************************************************************/ void GModelSpectralPlawEnergyFlux::free_members(void) { // Return return; } /***********************************************************************//** * @brief Update precomputed values * * @param[in] srcEng Source energy ***************************************************************************/ void GModelSpectralPlawEnergyFlux::update(const GEnergy& srcEng) const { // Compute index+1 double gamma = index() + 2.0; // Change in spectral index? if (index() != m_last_index) { // Save actual spectral index m_last_index = index(); // Change in energy boundaries? if (emin() != m_last_emin || emax() != m_last_emax) { m_log_emin = std::log(emin().MeV()); m_last_emin = emin(); m_log_emax = std::log(emax().MeV()); m_last_emax = emax(); } // Compute normalization factors if (gamma != 0.0) { m_pow_emin = std::pow(emin().MeV(), gamma); m_pow_emax = std::pow(emax().MeV(), gamma); double d = m_pow_emax - m_pow_emin; m_norm = gamma / d; m_g_norm = 1.0/gamma - (m_pow_emax*m_log_emax - m_pow_emin*m_log_emin)/d; } else { m_norm = 1.0 / (m_log_emax - m_log_emin); m_g_norm = 0.0; } // Update power law factor m_power = std::pow(srcEng.MeV(), index()); m_last_energy = srcEng; } // endif: change in spectral index // ... no change in spectral index else { // Change in energy boundaries? if (emin() != m_last_emin || emax() != m_last_emax) { // Update energy boundaries m_log_emin = std::log(emin().MeV()); m_last_emin = emin(); m_log_emax = std::log(emax().MeV()); m_last_emax = emax(); // Compute power law normalization if (gamma != 0.0) { m_pow_emin = std::pow(emin().MeV(), gamma); m_pow_emax = std::pow(emax().MeV(), gamma); double d = m_pow_emax - m_pow_emin; m_norm = gamma / d; m_g_norm = 1.0/gamma - (m_pow_emax*m_log_emax - m_pow_emin*m_log_emin)/d; } else { m_norm = 1.0 / (m_log_emax - m_log_emin); m_g_norm = 0.0; } } // endif: change in energy boundaries // Change in energy? if (srcEng != m_last_energy) { m_power = std::pow(srcEng.MeV(), index()); m_last_energy = srcEng; } } // endelse: no change in spectral index // Return return; }