Energy.h

Go to the documentation of this file.

/* Copyright (C) 2002 - 2009, Bernd Speiser */
/* This file is part of Quantities.

PhysicalQuantities 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 2
of the License, or (at your option) any later version.

PhysicalQuantities 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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
*/

#ifndef _Energy_h
#define _Energy_h

// Quantity includes
#include "Quantity/Variable.h"
#include "Quantity/Constant.h"
#include "Quantity/QuantityCluster.h"

namespace quantity {
  namespace energy {

class Class;

class Unit;

/* declaration of Energy units */
class JouleUnits;
class ErgUnit;
class HartreeUnit;
class RydbergUnit;
class ElectronVoltUnit;
class ThermochemicalCaloryUnit;
class InternationalCaloryUnit;
class FifteenDegreeCaloryUnit;
class LitreAtmosphereUnit;
class BritishThermalUnitUnit;

typedef unit::Prefixable<Unit, JouleUnits> Joules;

typedef unit::Prefixed<Joules> Joule;

typedef unit::Prefixed<Joules, unit::Kilo> KiloJoule;

typedef unit::NonPrefixable<Unit, ErgUnit> Erg;

typedef unit::NonPrefixable<Unit, HartreeUnit> Hartree;

typedef unit::NonPrefixable<Unit, RydbergUnit> Rydberg;

typedef unit::Prefixable<Unit, ElectronVoltUnit> ElectronVolts;

typedef unit::NonPrefixable<Unit, ThermochemicalCaloryUnit> 
                                                   ThermochemicalCalory;

typedef unit::NonPrefixable<Unit, InternationalCaloryUnit> 
                                                   InternationalCalory;

typedef unit::NonPrefixable<Unit, FifteenDegreeCaloryUnit> 
                                                   FifteenDegreeCalory;

typedef unit::NonPrefixable<Unit, LitreAtmosphereUnit> LitreAtmosphere;

typedef unit::NonPrefixable<Unit, BritishThermalUnitUnit> 
                                                     BritishThermalUnit;

typedef Loki::TL::Append<Joules::Units,
  LOKI_TYPELIST_9(Erg, Hartree, Rydberg, ElectronVolts::Units, 
    ThermochemicalCalory,
             InternationalCalory, FifteenDegreeCalory, LitreAtmosphere,
                                     BritishThermalUnit)>::Result Units;

/* declare some abbreviated energy units */
typedef Joule J;

/* Energy Quantity */

typedef Quantity<Class> Quantity;

class DerivedEnergy;

  } // end namespace energy


  template<typename ST>
    struct Standard<energy::Joules, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::Joules, ST>::ratio = 1.0;

template<typename ST> const bool Standard<energy::Joules, ST>::exact = true;


  template<typename ST>
    struct Standard<energy::Erg, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::Erg, ST>::ratio = 1.0e-7;

template<typename ST> const bool Standard<energy::Erg, ST>::exact = true;


  template<typename ST>
    struct Standard<energy::Hartree, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::Hartree, ST>::ratio = 4.35975e-18;

template<typename ST> const bool Standard<energy::Hartree, ST>::exact = false;


  template<typename ST>
    struct Standard<energy::Rydberg, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::Rydberg, ST>::ratio = 2.17987e-18;

template<typename ST> const bool Standard<energy::Rydberg, ST>::exact = false;


  template<typename ST>
    struct Standard<energy::ElectronVolts, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::ElectronVolts, ST>::ratio = 1.60218e-19;

template<typename ST> const bool Standard<energy::ElectronVolts, ST>::exact = false;


  template<typename ST>
    struct Standard<energy::ThermochemicalCalory, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::ThermochemicalCalory, ST>::ratio = 4.184;

template<typename ST> const bool Standard<energy::ThermochemicalCalory, ST>::exact = true;


  template<typename ST>
    struct Standard<energy::InternationalCalory, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::InternationalCalory, ST>::ratio = 4.1868;

template<typename ST> const bool Standard<energy::InternationalCalory, ST>::exact = true;


  template<typename ST>
    struct Standard<energy::FifteenDegreeCalory, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::FifteenDegreeCalory, ST>::ratio = 4.1855;

template<typename ST> const bool Standard<energy::FifteenDegreeCalory, ST>::exact = false;


  template<typename ST>
    struct Standard<energy::LitreAtmosphere, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::LitreAtmosphere, ST>::ratio = 101.325;

template<typename ST> const bool Standard<energy::LitreAtmosphere, ST>::exact = true;


  template<typename ST>
    struct Standard<energy::BritishThermalUnit, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<energy::BritishThermalUnit, ST>::ratio = 1055.06;

template<typename ST> const bool Standard<energy::BritishThermalUnit, ST>::exact = true;

template<>
  struct QuantityTraits<energy::Class>
  {
    typedef
      dimension::Dimension<BSUtilities::Rational<2>,
        BSUtilities::Rational<1>, BSUtilities::Rational<-2>,
          BSUtilities::Rational<0>, BSUtilities::Rational<0>,
            BSUtilities::Rational<0>, BSUtilities::Rational<0> > Dimension;
    typedef energy::Unit UnitType;
    typedef energy::Units UnitList;
    typedef energy::Joule DefaultUnit;

    typedef energy::DerivedEnergy DefaultDerivedQuantityType;

    static const std::string NameString;
    static const std::string SymbolString;

  };

// the derived quantity traits template for Joule Energy
template<>
  struct DerivedQuantityTraits<energy::Class, energy::DerivedEnergy>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

    static const std::string NameString;
    static const std::string SymbolString;

  };

typedef Variable<energy::Quantity> Energy;

typedef Constant<energy::Quantity> EnergyConstant;

typedef QuantityVector<Variable, energy::Quantity> EnergyVector;

} // end namespace quantity

#endif /* _Energy_h */

---