fcst_units.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
//
//    FCST: Fuel Cell Simulation Toolbox
//
//    Copyright (C) 2013 by Energy Systems Design Laboratory, University of Alberta
//
//    This software is distributed under the MIT License.
//    For more information, see the README file in /doc/LICENSE
//
//    - Class:  fcst_units.h
//    - Description: A cpp object that can be used by fcst programmers
//          when manipulating units in order to preserve
//          standards and prevent confusion.
//    - Developers: Philip Wardlaw and M. Secanell
//    - $Id: fcst_units.h 2605 2014-08-15 03:36:44Z secanell $
//
//---------------------------------------------------------------------------

#include <string>
#include <iostream>
#include <stdexcept>

#ifndef _FCST__UNITS
#define _FCST__UNITS

class Units {
    
public:
    inline static double convert(double unitToConvert, double to,  double from){
        
        if (to > 0 && from > 0){
            
            return unitToConvert*(to/from);
            
        }
        else if (to < 0 && from < 0){
            
            return unitToConvert*(from/to);
            
        }
        else {
            //invalid use of the convert function. To and from must be of the same sign
            throw std::logic_error("Incorrect unit conversion");
        }
        
        
        
        
    }
    
    inline static double convert(double unitToConvert, int specificCase){
        
        switch (specificCase)
        {
            case KJ_to_BTU:
                return unitToConvert/1.054;
            case BTU_to_KJ:
                return unitToConvert*1.054;
            case ATM_to_PA:
                return unitToConvert*1.01325e5;
        }
        
        //Invalid case, throw error
        throw std::invalid_argument("Specific case not implemented");
    }
    
    //Static Integers denoting specific conversion cases (Typically Non Metric)
    static const unsigned int KJ_to_BTU =1;
    static const unsigned int BTU_to_KJ =2;
    static const unsigned int ATM_to_PA =3;
    
    //Static doubles describing generic conversions
    
    static double PER_UNIT; // 1;
    static double PER_C_UNIT; // 1E-2;
    static double PER_MILLI_UNIT; // 1E-3;
    static double PER_MICRO_UNIT; // 1E-6;
    static double PER_N_UNIT; // 1E-9;
    static double PER_P_UNIT; // 1E-12;
    
    static double PER_UNIT2; // 1;
    static double PER_C_UNIT2; // 1E-4;
    static double PER_MILLI_UNIT2; // 1E-6;
    static double PER_MICRO_UNIT2; // 1E-12;
    static double PER_N_UNIT2; // 1E-18;
    static double PER_P_UNIT2; // 1E-24;
    
    static double PER_UNIT3; // 1;
    static double PER_C_UNIT3; // 1E-6;
    static double PER_MILLI_UNIT3; // 1E-9;
    static double PER_MICRO_UNIT3; // 1E-18;
    static double PER_N_UNIT3; // 1E-27;
    static double PER_P_UNIT3; // 1E-36;
    
    //Sign is to differentiate between "Per unit" and "by unit"
    
    static double UNIT; // -1;
    static double C_UNIT; //- 1E-2;
    static double MILLI_UNIT; //- 1E-3;
    static double MICRO_UNIT; //- 1E-6;
    static double N_UNIT; //- 1E-9;
    static double P_UNIT; // -1E-12;
    
    static double UNIT2; //- 1;
    static double C_UNIT2; // -1E-4;
    static double MILLI_UNIT2; // -1E-6;
    static double MICRO_UNIT2; //- 1E-12;
    static double N_UNIT2; //- 1E-18;
    static double P_UNIT2; //- 1E-24;
    
    static double UNIT3; // -1;
    static double C_UNIT3; // -1E-6;
    static double MILLI_UNIT3; // -1E-9;
    static double MICRO_UNIT3; // -1E-18;
    static double N_UNIT3; //- 1E-27;
    static double P_UNIT3; // -1E-36;
};




#endif