ElectricPotential.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 _ElectricPotential_h
#define _ElectricPotential_h

// Quantity includes
#include "Quantities/Quantity/Variable.h"
#include "Quantities/Quantity/Constant.h"
#include "Quantities/Quantity/QuantityAggregates.h"

namespace quantity {
  namespace electricPotential {

class Class;

class Unit;

/* declaration of ElectricPotential units */
class VoltUnits;
class GauUnit;
class MeanInternationalVoltUnit;
class USInternationalVoltUnit;
class AtomicUnit;

typedef unit::Prefixable<Unit, VoltUnits> Volts;

typedef unit::Prefixed<Volts> Volt;

typedef unit::Prefixed<Volts, unit::Milli> MilliVolt;

typedef unit::Prefixed<Volts, unit::Micro> MicroVolt;

typedef unit::Prefixed<Volts, unit::Kilo> KiloVolt;

typedef unit::Prefixed<Volts, unit::Mega> MegaVolt;

typedef unit::NonPrefixable<Unit, GauUnit> Gau;

typedef unit::NonPrefixable<Unit, 
                       MeanInternationalVoltUnit> MeanInternationalVolt;

typedef unit::NonPrefixable<Unit, 
                           USInternationalVoltUnit> USInternationalVolt;

typedef unit::NonPrefixable<Unit, AtomicUnit> Atomic;

typedef Loki::Typelist<Volts, Loki::Typelist<Gau, 
  Loki::Typelist<MeanInternationalVolt, Loki::Typelist<USInternationalVolt, 
                    Loki::Typelist<Atomic, Loki::NullType> > > > > Units;

/* declare some abbreviated electric potential units */

typedef Volt V;
typedef MilliVolt mV;
typedef MicroVolt uV;

/* ElectricPotential quantity */

typedef Quantity<Class> Quantity;

class DerivedElectricPotential;

  } // end namespace electricPotential

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

    typedef electricPotential::DerivedElectricPotential DefaultDerivedQuantityType;

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

  };

// the derived quantity traits template for Volt ElectricPotential
template<>
  struct DerivedQuantityTraits<electricPotential::Class, electricPotential::DerivedElectricPotential>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

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

  };


typedef Variable<electricPotential::Quantity> ElectricPotential;

typedef Constant<electricPotential::Quantity> ElectricPotentialConstant;

typedef VariableVector<QuantityVector<electricPotential::Class> > 
                                                ElectricPotentialVector;
}

#endif /* _ElectricPotential_h */

---