Volume.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 volume_h
#define volume_h

// Quantity includes
#include "Quantity/Variable.h"
#include "Quantity/Constant.h"
#include "PhysicalQuantities/Length.h"

namespace quantity {
  namespace volume {

class Class;

class Unit;

/* declaration of Volume units */
class LitreUnit;
class LambdaUnit;
class BarrelUnit;
class USGallonUnit;
class UKGallonUnit;


typedef LOKI_TYPELIST_3(length::Metre, length::CentiMetre,
                                        length::MilliMetre) LengthList;

typedef 
  unit::ComposeElement<Unit, LengthList, 
                               BSUtilities::Rational<3> > LengthElement;

typedef 
   unit::ComposeBase<Unit, LOKI_TYPELIST_1(LengthElement)> 
                                                     VolumeComposedUnit;

typedef 
  unit::Composed<VolumeComposedUnit, LOKI_TYPELIST_1(length::Metre)> 
                                                             CubicMetre;

typedef unit::Composed<VolumeComposedUnit, 
                   LOKI_TYPELIST_1(length::MilliMetre)> CubicMilliMetre;

typedef unit::Composed<VolumeComposedUnit, 
                   LOKI_TYPELIST_1(length::CentiMetre)> CubicCentiMetre;

typedef unit::Prefixable<Unit, LitreUnit> Litres;

typedef unit::Prefixed<Litres> Litre;

typedef unit::NonPrefixable<Unit, LambdaUnit> Lambda;

typedef unit::NonPrefixable<Unit, BarrelUnit> Barrel;

typedef unit::NonPrefixable<Unit, USGallonUnit> USGallon;


typedef unit::NonPrefixable<Unit, UKGallonUnit> UKGallon;

typedef LOKI_TYPELIST_8(CubicMetre, CubicCentiMetre, CubicMilliMetre,
                       Litres::Units, Lambda, Barrel, USGallon, UKGallon) Units;

/* Volume quantity */

typedef Quantity<Class> Quantity;

class DerivedVolume;

  } // end namespace volume


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

template<typename ST> const ST Standard<volume::VolumeComposedUnit, ST>::ratio = 1.0;

template<typename ST> const bool Standard<volume::VolumeComposedUnit, ST>::exact = true;


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

template<typename ST> const ST Standard<volume::Litres, ST>::ratio = 1.0e-3;

template<typename ST> const bool Standard<volume::Litres, ST>::exact = true;


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

template<typename ST> const ST Standard<volume::Lambda, ST>::ratio = 1.0e-6;

template<typename ST> const bool Standard<volume::Lambda, ST>::exact = true;


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

template<typename ST> const ST Standard<volume::Barrel, ST>::ratio = 0.158987;

template<typename ST> const bool Standard<volume::Barrel, ST>::exact = false;


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

template<typename ST> const ST Standard<volume::USGallon, ST>::ratio = 0.00378541;

template<typename ST> const bool Standard<volume::USGallon, ST>::exact = true;


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

template<typename ST> const ST Standard<volume::UKGallon, ST>::ratio = 0.00378541;

template<typename ST> const bool Standard<volume::UKGallon, ST>::exact = true;

template<>
  struct QuantityTraits<volume::Class>
  {
    typedef
      dimension::Dimension<BSUtilities::Rational<3>,
        BSUtilities::Rational<0>, BSUtilities::Rational<0>,
          BSUtilities::Rational<0>, BSUtilities::Rational<0>,
            BSUtilities::Rational<0>, BSUtilities::Rational<0> > Dimension;
    typedef volume::Unit UnitType;
    typedef volume::Units UnitList;
    typedef volume::CubicMetre DefaultUnit;

    typedef volume::DerivedVolume DefaultDerivedQuantityType;

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

// the derived quantity traits template for CubicMetre Volume
template<>
  struct DerivedQuantityTraits<volume::Class, volume::DerivedVolume>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

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

  };

typedef Variable<volume::Quantity> Volume;

typedef Constant<volume::Quantity> VolumeConstant;

typedef QuantityVector<Variable, volume::Quantity> VolumeVector;

}

#endif /* volume_h */

---