FirstOrderRateConstant.h

Go to the documentation of this file.

/* Copyright (C) 2004 - 2009, Bernd Speiser, Kai Ludwig */

/* 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 _FirstOrderRateConstant_h
#define _FirstOrderRateConstant_h

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

namespace quantity {
  namespace firstOrderRateConstant {

class Class;

class Unit;

typedef LOKI_TYPELIST_3(time::Minute, time::Second, 
                                            time::MilliSecond) TimeList;

typedef unit::ComposeElement<Unit, TimeList, 
                                BSUtilities::Rational<-1> > TimeElement;

typedef unit::ComposeBase<Unit, 
       LOKI_TYPELIST_1(TimeElement)> FirstOrderRateConstantComposedUnit;

typedef unit::Composed<FirstOrderRateConstantComposedUnit, 
                            LOKI_TYPELIST_1(time::Minute)> OnePerMinute;

typedef unit::Composed<FirstOrderRateConstantComposedUnit, 
                            LOKI_TYPELIST_1(time::Second)> OnePerSecond;

typedef unit::Composed<FirstOrderRateConstantComposedUnit, 
                  LOKI_TYPELIST_1(time::MilliSecond)> OnePerMilliSecond;


typedef 
  LOKI_TYPELIST_3(OnePerMinute, OnePerSecond, OnePerMilliSecond) Units;

/* FirstOrderRateConstant Quantity */

typedef Quantity<Class> Quantity;

class DerivedFirstOrderRateConstant;

  } // end namespace firstOrderRateConstant


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

template<typename ST> const ST 
  Standard<firstOrderRateConstant::FirstOrderRateConstantComposedUnit, ST>::ratio = 1.0;

template<typename ST> const bool 
  Standard<firstOrderRateConstant::FirstOrderRateConstantComposedUnit, ST>::exact = true;

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

    typedef firstOrderRateConstant::DerivedFirstOrderRateConstant DefaultDerivedQuantityType;

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

// the derived quantity traits template for one per second first-order rate constant
template<>
  struct DerivedQuantityTraits<firstOrderRateConstant::Class, 
                                firstOrderRateConstant::DerivedFirstOrderRateConstant>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

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

  };

typedef Variable<firstOrderRateConstant::Quantity> FirstOrderRateConstant;

typedef Constant<firstOrderRateConstant::Quantity> FirstOrderRateConstantConstant;

typedef QuantityVector<Variable, firstOrderRateConstant::Quantity> FirstOrderRateConstantVector;

} // end namespace quantity

#endif /* _FirstOrderRateConstant_h */

---