simulation_selector.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
//
// FCST: Fuel Cell Simulation Toolbox
//
// Copyright (C) 2006-2015 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: simulation_selector.h
// - Description: This class selects an openFCST application which will run
// - Developers: P. Dobson,
//               M. Secanell,
//               A. Koupaei,
//               V. Zingan,
//               M. Bhaiya,
//               M. Sabharwal
//
// ----------------------------------------------------------------------------

#ifndef _SIMULATION_SELECTOR_H_
#define _SIMULATION_SELECTOR_H_

#include <string>
#include <iostream>

#include <boost/shared_ptr.hpp>
#include <application_core/application_data.h>
#include <application_core/optimization_block_matrix_application.h>

#include <solvers/adaptive_refinement.h>
#include <solvers/newton_basic.h>
#include <solvers/newton_w_line_search.h>
#include <solvers/newton_w_3pp.h>
#include <solvers/picard.h>

// FUEL CELL APPLICATIONS WITH DIFFUSION-FICKS-BASED TRANSPORT //

#include <applications/app_cathode.h>
#include <applications/app_pemfc.h>
#include <applications/app_pemfc_nonisothermal.h>
#include <applications/app_pemfc_twophase_saturation.h>
#include <applications/app_thermal_test.h>
#include <applications/app_test.h>
#include <applications/app_diffusion.h>
#include <applications/app_ohmic.h>

// OTHER APPLICATIONS //

#include <applications/app_read_mesh.h>

using namespace boost;

template<int dim>
class SimulationSelector
{
public:

       SimulationSelector(boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData > data = 
            boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData >());

      ~SimulationSelector();

       void declare_parameters(ParameterHandler& param) const;

       void initialize(ParameterHandler& param);

       boost::shared_ptr< FuelCell::ApplicationCore::OptimizationBlockMatrixApplication<dim> > select_application();

       boost::shared_ptr< FuelCell::ApplicationCore::ApplicationWrapper > select_solver(FuelCell::ApplicationCore::OptimizationBlockMatrixApplication<dim>* app_lin);

       boost::shared_ptr< FuelCell::ApplicationCore::AdaptiveRefinement<dim> > select_solver_method(FuelCell::ApplicationCore::OptimizationBlockMatrixApplication<dim>* app_lin,
                                                                                                    FuelCell::ApplicationCore::ApplicationWrapper*                      newton_solver,
                                                                                                    const FuelCell::ApplicationCore::FEVector&                          solution = FuelCell::ApplicationCore::FEVector());

protected:

       const std::string get_simulator_names() const
       {
              std::stringstream result;

              result << "cathode"
                     << " | "
                     << "anode"
                     << " | "
                     << "cathode_MPL"
                     << " | "
                     << "cathodeNIT"
                     << " | "
                     << "MEA"
                     << " | "
                     << "meaNIT"
                     << " | "
                     << "meaTwoPhaseSaturationNIT"
                     << " | "
                     << "test"
                     << " | "
                     << "thermalTest"
                     << " | "
                     << "test_mesh"
                     << " | "
                     << "diffusion"
                     << " | "
                     << "ohmic"
                     << " | "
                     << "meaTwoPhaseNITcapillary"
                     << " | "
                     << "Capillary_Testing";

              return result.str();
       }

       const std::string get_simulator_specifications() const
       {
              std::stringstream result;

              result << "None"
                     << " | "
                     << "sphere"
                     << " | "
                     << "with_channel"
                     << " | "
                     << "without_channel"
                     << " | "
                     << "reaction"
                     << "|"
                     << "knudsen"
                     << "|"
                     << "reaction_and_knudsen";

              return result.str();
       }

       const std::string get_nonlinear_solver_names() const
       {
              std::stringstream result;

              result << "None"
                     << " | "
                     << "NewtonBasic"
                     << " | "
                     << "NewtonLineSearch"
                     << " | "
                     << "Newton3pp"
                     << " | "
                     << "Picard";

              return result.str();
       }

       const std::string get_refinement_methods() const
       {
              std::stringstream result;

              result << "AdaptiveRefinement";

              return result.str();
       }
       

       // DATA //
       
       boost::shared_ptr <FuelCell::ApplicationCore::ApplicationData> data;

       std::string name_application;

       std::string app_specification;

       std::string name_nonlinear_solver;

       std::string name_refinement_method;
};

#endif