fcst_utilities.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_utilities.h
//    - Description: Namespace carrying a lot of utility functions
//    - Developers: Madhur Bhaiya, Valentin N. Zingan, Marc Secanell, Phil Wardlaw
//
//---------------------------------------------------------------------------

#ifndef _FUELCELLSHOP__FCST_UTILITIES_H
#define _FUELCELLSHOP__FCST_UTILITIES_H

//Include STL and boost libraries
#include <cmath>
#include <iostream>
#include <string>
#include <vector>
#include <map>
#include <cctype>
#include <boost/lexical_cast.hpp>
#include <fstream>
#include <algorithm>
#include <boost/tokenizer.hpp>
#include <stdlib.h>


//Include deal.ii classes
#include <deal.II/base/utilities.h>
#include <deal.II/base/exceptions.h>

#include <application_core/application_wrapper.h>

//Posix access function
#include <unistd.h>

using namespace dealii;

namespace FcstUtilities
{
    DeclException1 (ExcWrongString,
                    std::string,
                    << "Can't convert the string " << arg1
                    << " to the desired Number type");

    template <typename NumType>
    NumType string_to_number(const std::string&);

    template <typename NumType>
    std::vector<NumType> string_to_number(const std::vector<std::string>&);
    
    template <>
    unsigned char string_to_number<unsigned char>(const std::string& str);

    template <typename KeyType, typename ValueType>
    std::map< KeyType, ValueType > string_to_map(const std::vector<std::string>&);

    template< typename KeyType, typename ValueType >
    std::map< KeyType, ValueType > string_to_map(const std::string& name);

    int cellId_to_index(std::string& cell_id);

    bool is_number(const std::string& s);

    template< typename KeyType, typename ValueType >
    std::map< KeyType, std::vector<ValueType> > split_mapvalue_list(const std::map< KeyType, std::string >&, const char delimiter = ';');
    void print_parameter_file_PRM(ParameterHandler& param, std::string path = "default.prm");
        
    void print_parameter_file_XML(ParameterHandler& param, std::string path = "default.xml");

    std::string find_fcst_root();


    void run_python(std::string script_name,std::string arg);

    template <typename ValType>
    void modify_parameter_file(const std::string name_design_var,
                               const ValType value_design_var,
                               ParameterHandler& param);
    
    template <typename ValType>
    void modify_parameter_file(const std::vector<std::string> name_design_var,
                               const std::vector<ValType> value_design_var,
                               ParameterHandler& param);
    
    template <typename NumType>
    std::string number_to_string(const NumType &num);

    void read_parameter_files(ParameterHandler&  param,
                              const std::string& filename);

     bool file_exists(const std::string &file_name);

} //FcstUtilities
#endif //_FUELCELLSHOP__FCST_UTILITIES_H