pressure.h

Go to the documentation of this file.

/*
 * #%L
 * OME-COMMON C++ library for C++ compatibility/portability
 * %%
 * Copyright © 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_COMMON_UNITS_PRESSURE_H
#define OME_COMMON_UNITS_PRESSURE_H

#include <ome/common/config.h>
#include <ome/common/units/types.h>

#include <boost/units/base_units/metric/bar.hpp>
#include <boost/units/base_units/metric/atmosphere.hpp>
#include <boost/units/base_units/metric/torr.hpp>
#include <boost/units/base_units/metric/mmHg.hpp>
#include <boost/units/unit.hpp>
#include <boost/units/quantity.hpp>
#include <boost/units/systems/si.hpp>

#ifdef _MSC_VER
#pragma push_macro("pascal")
#undef pascal
#endif

namespace ome
{
  namespace common
  {
    namespace units
    {

      // Pressure types, constants and quantities.

      typedef si::pressure pressure_unit;
      typedef quantity<si::pressure> pressure_quantity;

      typedef make_scaled_unit<si::pressure,scale<10,static_rational<-24>>>::type yoctopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<-21>>>::type zeptopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<-18>>>::type attopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<-15>>>::type femtopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<-12>>>::type picopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< -9>>>::type nanopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< -6>>>::type micropascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< -3>>>::type millipascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< -2>>>::type centipascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< -1>>>::type decipascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  0>>>::type pascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  1>>>::type dekapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  1>>>::type decapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  2>>>::type hectopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  3>>>::type kilopascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  6>>>::type megapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational<  9>>>::type gigapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< 12>>>::type terapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< 15>>>::type petapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< 18>>>::type exapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< 21>>>::type zettapascal_unit;
      typedef make_scaled_unit<si::pressure,scale<10,static_rational< 24>>>::type yottapascal_unit;

      BOOST_UNITS_STATIC_CONSTANT(yoctopascal, yoctopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(zeptopascal, zeptopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(attopascal, attopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(femtopascal, femtopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(picopascal, picopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(nanopascal, nanopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(micropascal, micropascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(millipascal, millipascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(centipascal, centipascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(decipascal, decipascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(pascal, pascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(dekapascal, dekapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(decapascal, decapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(hectopascal, hectopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(kilopascal, kilopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(megapascal, megapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(gigapascal, gigapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(terapascal, terapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(petapascal, petapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(exapascal, exapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(zettapascal, zettapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(yottapascal, yottapascal_unit);

      BOOST_UNITS_STATIC_CONSTANT(yoctopascals, yoctopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(zeptopascals, zeptopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(attopascals, attopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(femtopascals, femtopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(picopascals, picopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(nanopascals, nanopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(micropascals, micropascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(millipascals, millipascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(centipascals, centipascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(decipascals, decipascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(pascals, pascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(dekapascals, dekapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(decapascals, decapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(hectopascals, hectopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(kilopascals, kilopascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(megapascals, megapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(gigapascals, gigapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(terapascals, terapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(petapascals, petapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(exapascals, exapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(zettapascals, zettapascal_unit);
      BOOST_UNITS_STATIC_CONSTANT(yottapascals, yottapascal_unit);

      typedef quantity<yoctopascal_unit> yoctopascal_quantity;
      typedef quantity<zeptopascal_unit> zeptopascal_quantity;
      typedef quantity<attopascal_unit> attopascal_quantity;
      typedef quantity<femtopascal_unit> femtopascal_quantity;
      typedef quantity<picopascal_unit> picopascal_quantity;
      typedef quantity<nanopascal_unit> nanopascal_quantity;
      typedef quantity<micropascal_unit> micropascal_quantity;
      typedef quantity<millipascal_unit> millipascal_quantity;
      typedef quantity<centipascal_unit> centipascal_quantity;
      typedef quantity<decipascal_unit> decipascal_quantity;
      typedef quantity<pascal_unit> pascal_quantity;
      typedef quantity<dekapascal_unit> dekapascal_quantity;
      typedef quantity<decapascal_unit> decapascal_quantity;
      typedef quantity<hectopascal_unit> hectopascal_quantity;
      typedef quantity<kilopascal_unit> kilopascal_quantity;
      typedef quantity<megapascal_unit> megapascal_quantity;
      typedef quantity<gigapascal_unit> gigapascal_quantity;
      typedef quantity<terapascal_unit> terapascal_quantity;
      typedef quantity<petapascal_unit> petapascal_quantity;
      typedef quantity<exapascal_unit> exapascal_quantity;
      typedef quantity<zettapascal_unit> zettapascal_quantity;
      typedef quantity<yottapascal_unit> yottapascal_quantity;

      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational< -3>>>::unit_type millibar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational< -2>>>::unit_type centibar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational< -1>>>::unit_type decibar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational<  0>>>::unit_type bar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational<  1>>>::unit_type dekabar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational<  1>>>::unit_type decabar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational<  2>>>::unit_type hectobar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational<  3>>>::unit_type kilobar_unit;
      typedef scaled_base_unit<boost::units::metric::bar_base_unit,scale<10,static_rational<  6>>>::unit_type megabar_unit;

      BOOST_UNITS_STATIC_CONSTANT(millibar, millibar_unit);
      BOOST_UNITS_STATIC_CONSTANT(centibar, centibar_unit);
      BOOST_UNITS_STATIC_CONSTANT(decibar, decibar_unit);
      BOOST_UNITS_STATIC_CONSTANT(bar, bar_unit);
      BOOST_UNITS_STATIC_CONSTANT(dekabar, dekabar_unit);
      BOOST_UNITS_STATIC_CONSTANT(decabar, decabar_unit);
      BOOST_UNITS_STATIC_CONSTANT(hectobar, hectobar_unit);
      BOOST_UNITS_STATIC_CONSTANT(kilobar, kilobar_unit);
      BOOST_UNITS_STATIC_CONSTANT(megabar, megabar_unit);

      BOOST_UNITS_STATIC_CONSTANT(millibars, millibar_unit);
      BOOST_UNITS_STATIC_CONSTANT(centibars, centibar_unit);
      BOOST_UNITS_STATIC_CONSTANT(decibars, decibar_unit);
      BOOST_UNITS_STATIC_CONSTANT(bars, bar_unit);
      BOOST_UNITS_STATIC_CONSTANT(dekabars, dekabar_unit);
      BOOST_UNITS_STATIC_CONSTANT(decabars, decabar_unit);
      BOOST_UNITS_STATIC_CONSTANT(hectobars, hectobar_unit);
      BOOST_UNITS_STATIC_CONSTANT(kilobars, kilobar_unit);
      BOOST_UNITS_STATIC_CONSTANT(megabars, megabar_unit);

      typedef quantity<millibar_unit> millibar_quantity;
      typedef quantity<centibar_unit> centibar_quantity;
      typedef quantity<decibar_unit> decibar_quantity;
      typedef quantity<bar_unit> bar_quantity;
      typedef quantity<dekabar_unit> dekabar_quantity;
      typedef quantity<decabar_unit> decabar_quantity;
      typedef quantity<hectobar_unit> hectobar_quantity;
      typedef quantity<kilobar_unit> kilobar_quantity;
      typedef quantity<megabar_unit> megabar_quantity;

      typedef boost::units::metric::atmosphere_base_unit::unit_type atmosphere_unit;
      BOOST_UNITS_STATIC_CONSTANT(atmosphere, atmosphere_unit);
      BOOST_UNITS_STATIC_CONSTANT(atmospheres, atmosphere_unit);
      typedef quantity<atmosphere_unit> atmosphere_quantity;

      struct psi_base_unit : boost::units::base_unit<psi_base_unit,
                                                     boost::units::pressure_dimension, 3> { };
      typedef psi_base_unit::unit_type psi_unit;
      BOOST_UNITS_STATIC_CONSTANT(psi, psi_unit);
      typedef quantity<psi_unit> psi_quantity;

      typedef boost::units::metric::torr_base_unit::unit_type torr_unit;
      BOOST_UNITS_STATIC_CONSTANT(torr, torr_unit);
      typedef quantity<torr_unit> torr_quantity;

      typedef scaled_base_unit<boost::units::metric::torr_base_unit,scale<10,static_rational< -3>>>::unit_type millitorr_unit;
      BOOST_UNITS_STATIC_CONSTANT(millitorr, millitorr_unit);
      typedef quantity<millitorr_unit> millitorr_quantity;

      typedef boost::units::metric::mmHg_base_unit::unit_type mmHg_unit;
      BOOST_UNITS_STATIC_CONSTANT(mmHg, mmHg_unit);
      typedef quantity<mmHg_unit> mmHg_quantity;

    }
  }
}

// Conversion factor for pound-force per square inch (psi) to pascal.
BOOST_UNITS_DEFINE_CONVERSION_FACTOR(ome::common::units::psi_base_unit, si::pressure, double, 6894.7573); // exact conversion
// Default conversion for pound-force per square inch (psi) to is to SI pressure units (pascals).
BOOST_UNITS_DEFAULT_CONVERSION(ome::common::units::psi_base_unit, si::pressure);

namespace boost
{
  namespace units
  {

    template<> struct base_unit_info<ome::common::units::psi_base_unit>
    {
      static std::string name()   { return "pound-force per square inch"; }
      static std::string symbol() { return "lbf/in^2"; }
    };

  }
}

#ifdef _MSC_VER
#pragma pop_macro("pascal")
#endif

#endif // OME_COMMON_UNITS_PRESSURE_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */