Energy.h

Go to the documentation of this file.

/* Copyright (C) 2002 - 2011, 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 "Quantities/Quantity/Variable.h"
#include "Quantities/Quantity/Constant.h"
#include "Quantities/Quantity/QuantityAggregates.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::Typelist<Joules, Loki::Typelist<Erg, 
  Loki::Typelist<Hartree, Loki::Typelist<Rydberg, Loki::Typelist<ElectronVolts, 
    Loki::Typelist<ThermochemicalCalory, Loki::Typelist<InternationalCalory,  
      Loki::Typelist<FifteenDegreeCalory,  Loki::Typelist<LitreAtmosphere,
        Loki::Typelist<BritishThermalUnit, Loki::NullType> > > > > > > > > > 
                                                                       Units;

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

/* Energy Quantity */

typedef Quantity<Class> Quantity;

class DerivedEnergy;

  } // end namespace energy

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 VariableVector<QuantityVector<energy::Class> > EnergyVector;

} // end namespace quantity

#endif /* _Energy_h */

---