parametric_study.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
//
//    FCST: Fuel Cell Simulation Toolbox
//
//    Copyright (C) 2009-13 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: parametric_study.h
//    - Description: Application used to perform parameteric studies on a given application.
//    - Developers: M. Secanell
//
//---------------------------------------------------------------------------

#ifndef _FUELCELL__PARAMETRIC_STUDY_H_
#define _FUELCELL__PARAMETRIC_STUDY_H_

// OpenFCST
#include <application_core/optimization_block_matrix_application.h>
#include <utils/simulation_selector.h>
#include <utils/fcst_utilities.h>

// STD include files
#include <string>
#include <vector>
#include <iostream>
#include <fstream>

#include <stdio.h>
#include <stdlib.h>

namespace FuelCell
{
    template <int dim>
    class ParametricStudy
    {
    public:
        ParametricStudy();

        ~ParametricStudy();

        void declare_parameters (ParameterHandler& ) const;

        void initialize (ParameterHandler& );

        void run (ParameterHandler& param,
                  std::string simulator_parameter_file_name,
                  boost::shared_ptr<SimulationSelector<dim> > sim_selector);

    protected:
        virtual void set_parameters(ParameterHandler& param,
                                    const shared_ptr<FuelCell::ApplicationCore::AdaptiveRefinement<dim> >& solver,
                                    const int iteration,
                                    const std::vector<std::string> parameter_name,
                                    const std::vector<double> param_value);

        void run_point (ParameterHandler& param,
                        const std::string simulator_parameter_file_name,
                        const boost::shared_ptr<SimulationSelector<dim> > sim_selector,
                        const int iteration,
                        const std::vector<std::string> parameter_name,
                        const std::vector<double> param_value,
                        std::map<std::string, double>& functionals);
        
        inline void print_iteration_info(const unsigned int iteration,
                                         const double param_value) const 
        {
            FcstUtilities::log<<"============================================================================="<<std::endl;
            FcstUtilities::log<<"Iteration : "<<iteration<<std::endl;
            FcstUtilities::log<<"Solving for..."<<std::endl;
            FcstUtilities::log<<"Parameter name: ";
            if(!parameter_name.empty())
                FcstUtilities::log<<parameter_name[0];
            FcstUtilities::log<<std::endl;
            FcstUtilities::log<<"Cell param_value: "<<param_value<<std::endl;
            FcstUtilities::log<<"======"<<std::endl;
        }
        
        inline void print_iteration_info(const unsigned int iteration,
                                         const std::vector<double> param_value) const 
        {
            FcstUtilities::log<<"============================================================================="<<std::endl;
            FcstUtilities::log<<"Iteration : "<<iteration<<std::endl;
            FcstUtilities::log<<"Solving for..."<<std::endl;
            for(unsigned int i = 0; i < parameter_name.size(); ++i)
            {
                FcstUtilities::log<<"Parameter " << i+1 << " name: "<<parameter_name[i]<<std::endl;
                FcstUtilities::log<<"Parameter " << i+1 << " value: "<<param_value[i]<<std::endl;
            }
            FcstUtilities::log<<"======"<<std::endl;
        }
        
        virtual void print_parameters() const;

        virtual void print_parameteric_study_header() ;

        void register_data(const double ,
                           std::map<std::string, double>& functionals);

        std::string parameter_filename;
        
        std::vector<std::string> parameter_name;

        double p_init;

        double p_end;

        double dp;

        std::vector< std::vector<double> > p_values;

        bool adaptive;

        double min_dp;

        int n_dpPts;

        bool convergence;

        std::vector<std::vector<double> > curve;
        
        std::ofstream myfile;

        std::vector<std::string> name_responses;

        int n_resp;
        
        const unsigned int max_num_parameters = 10;

        FuelCell::ApplicationCore::FEVector coarse_solution;
    };
}

#endif