ficks_transport_equation.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: ficks_transport_equation.h
//    - Description: Base Catalyst Layer Class. It implements the interface for other catalyst layer class
//        and some common methods.
//    - Developers: M. Secanell
//    - $Id: ficks_transport_equation.h 1354 2013-08-17 00:01:22Z secanell $
//
//---------------------------------------------------------------------------

#ifndef dimension
#if   deal_II_dimension == 1
#define _1D_
#elif deal_II_dimension == 2
#define _2D_
#elif deal_II_dimension == 3
#define _3D_
#endif
#endif

#ifndef _FCST_FUELCELLSHOP_EQUATION_FICKS_EQUATION_H_
#define _FCST_FUELCELLSHOP_EQUATION_FICKS_EQUATION_H_

// FCST includes
#include "equation_base.h"
#include "fcst_constants.h"
#include "gas_diffusion_layer.h"
#include "SGL_24_BA.h"
#include "micro_porous_layer.h"
#include "SGL_24_BC.h"
#include "catalyst_layer.h"

// Appframe includes
#include "appframe/matrix_shop_cell.h"

// STD
#include <sstream>
#include <string>

namespace FuelCellShop
{
    namespace Equation
    {
        
        template<int dim>
        class FicksTransportEquation : public EquationBase<dim>
        {
        public:
            
            FicksTransportEquation(FuelCell::SystemManagement& system_management);
            
            FicksTransportEquation(FuelCell::SystemManagement& system_management,
                                   FuelCellShop::Material::PureGas* solute,
                                   FuelCellShop::Material::PureGas* solvent);
            
            inline void set_solute_and_solvent( FuelCellShop::Material::PureGas* solute, FuelCellShop::Material::PureGas* solvent1 )
            {
                this->gas = solute;
                this->solvent = solvent1;
                
                std::stringstream s;
                s <<"Ficks Transport Equation - "<<gas->get_name();
                this->name_equation = s.str();
                
                std::stringstream ss;
                ss <<gas->get_name()<<"_molar_fraction";
                this->name_solution = ss.str();
            }
            
            virtual ~FicksTransportEquation();
            
            virtual void declare_parameters(ParameterHandler& param);
            
            virtual void initialize(ParameterHandler& param);
            
            virtual void assemble_cell_matrix(AppFrame::MatrixVector&                                 cell_matrices,
                                              const typename AppFrame::DoFApplication<dim>::CellInfo& cell_info,
                                              FuelCellShop::Layer::BaseLayer<dim>* const              layer);
            
            virtual void assemble_bdry_matrix(AppFrame::MatrixVector&                                 bdry_matrices,
                                              const typename AppFrame::DoFApplication<dim>::FaceInfo& bdry_info,
                                              FuelCellShop::Layer::BaseLayer<dim>* const              layer){};
                                              
           virtual void assemble_cell_residual(AppFrame::FEVector&                                     cell_rhs,
                                               const typename AppFrame::DoFApplication<dim>::CellInfo& cell_info,
                                               FuelCellShop::Layer::BaseLayer<dim>* const              layer);
           
           virtual void assemble_bdry_residual(AppFrame::FEVector&                                     bdry_rhs,
                                               const typename AppFrame::DoFApplication<dim>::FaceInfo& bdry_info,
                                               FuelCellShop::Layer::BaseLayer<dim>* const              layer){};
                                               
           virtual const couplings_map& get_internal_cell_couplings() const
           {
               return internal_cell_couplings;
           }
           
           virtual void print_equation_info() const;
           
           DeclException1(GasDoesNotExistInGDL,
                          std::string,
                          << "Gas "  << arg1 << " does not exist in the Gas diffusion layer");
           
           void class_test();
                                                                                  
        protected:
            FuelCellShop::Material::PureGas* gas;
            FuelCellShop::Material::PureGas* solvent;
            std::string name_equation;
            std::string name_solution;
            virtual void make_internal_cell_couplings();
            
            couplings_map internal_cell_couplings;
            
            std::vector<unsigned int> matrix_block_indices;
            
            std::vector<unsigned int> component_indices;
        };
        
    } // Equation
    
} // FuelCellShop
    
#endif