catalyst_base.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
//
//    FCST: Fuel Cell Simulation Toolbox
//
//    Copyright (C) 2011-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: catalyst_base.h
//    - Description: Base catalyst material class
//    - Developers: M. Secanell and Madhur Bhaiya
//    - $Id: catalyst_base.h 2605 2014-08-15 03:36:44Z secanell $
//
//---------------------------------------------------------------------------

#ifndef _FUELCELLSHOP_CATALYST_BASE__H
#define _FUELCELLSHOP_CATALYST_BASE__H

// Include deal.II classes
#include <deal.II/base/parameter_handler.h>
#include <deal.II/base/point.h>
#include <deal.II/base/function.h>
#include <deal.II/lac/vector.h>
#include <deal.II/fe/fe_values.h>

// Include FCST classes
#include <materials/base_material.h>
#include <utils/fcst_constants.h>


namespace FuelCellShop
{
    namespace Material
    {
        class CatalystBase 
        :
        public BaseMaterial
        {
        public:


            static void declare_Catalyst_parameters (ParameterHandler &param)
            {
                
                for (typename FuelCellShop::Material::CatalystBase::_mapFactory::iterator iterator = FuelCellShop::Material::CatalystBase::get_mapFactory()->begin(); 
                     iterator != FuelCellShop::Material::CatalystBase::get_mapFactory()->end(); 
                iterator++)
                     {
                         iterator->second->declare_parameters(param);
                     }        
            }

            static boost::shared_ptr<FuelCellShop::Material::CatalystBase > create_Catalyst (ParameterHandler &param,
                                                                                              std::string catalyst_name)
             {       
                 boost::shared_ptr<FuelCellShop::Material::CatalystBase > pointer;

                 typename FuelCellShop::Material::CatalystBase::_mapFactory::iterator iterator = FuelCellShop::Material::CatalystBase::get_mapFactory()->find(catalyst_name);
                 
                 if (iterator != FuelCellShop::Material::CatalystBase::get_mapFactory()->end())
                 {
                     if (iterator->second)
                     {
                         pointer = iterator->second->create_replica();
                     }
                     else 
                     {
                         FcstUtilities::log<<"Pointer not initialized"<<std::endl;
                         abort();
                     }
                 }
                 else
                 {
                     FcstUtilities::log<<"Concrete name in FuelCellShop::Material::CatalystBase::create_Catalyst does not exist"<<std::endl;
                     abort();
                 }
                 
                 pointer->initialize(param);
                 
                 return pointer;
             }


            virtual void set_reaction_kinetics(const ReactionNames)
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };


            virtual void alpha_anodic(double&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual void derivative_alpha_anodic(std::vector<double>& ) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual void alpha_cathodic(double&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual void derivative_alpha_cathodic(std::vector<double>& ) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual double exchange_current_density(const double&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            virtual double derivative_exchange_current_density(const double&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
                  
            virtual void reference_concentration(const std::vector<VariableNames>&,
                                                 std::map<VariableNames, double>& ) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual double voltage_cell_th(const double&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual double dvoltage_cell_th_dT(const double&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual void reaction_order(const std::vector<VariableNames>&,
                                        std::map<VariableNames, double>&) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
                       
            inline ReactionNames get_reaction_name() const
            {
                Assert(name_reaction_kinetics != noReaction, ExcMessage("Reaction name not yet set in the CatalystBase object."));
                return name_reaction_kinetics;
            }
            
            inline std::string get_kinetic_parameter_method() const
            {
                Assert(method_kinetics_ORR.size() != 0, ExcMessage("Kinetic parameter method not yet set in the CatalystBase object."));
                return method_kinetics_ORR;
            }


            inline double get_density() const
            { 
                return density; 
            };
              
        protected:


            CatalystBase(std::string name)
            : FuelCellShop::Material::BaseMaterial(name)
            {};

            CatalystBase()
            : FuelCellShop::Material::BaseMaterial()
            {};

            virtual ~CatalystBase()
            {};  
            
            virtual void declare_parameters(ParameterHandler &param) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            virtual void initialize (ParameterHandler &param)
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            


            typedef std::map< std::string, FuelCellShop::Material::CatalystBase* > _mapFactory;      
            


            static _mapFactory * get_mapFactory()
            {
                static _mapFactory mapFactory;
                return &mapFactory;
            }  
                     


            virtual boost::shared_ptr<FuelCellShop::Material::CatalystBase > create_replica ()
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name() << std::endl;
            }


            virtual bool check_reaction_implementation(const std::string) const
            {
                const std::type_info& info = typeid(*this);
                FcstUtilities::log << "Pure function " << __FUNCTION__
                << " called in Class "
                << info.name()  << std::endl;
            };
            
            


            ReactionNames name_reaction_kinetics;
            
            std::string method_kinetics_ORR;
            
            double density;
        };
        
    }
}


#endif