OpenFCST: The open-source Fuel Cell Simulation Toolbox
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Attributes | List of all members
FuelCellShop::Layer::DummyGDL< dim > Class Template Reference

This class is used when we want to input the effective properties to the GDL directly, without taking into account the structure of the GDL \ UNDER DEVELOPMENT. More...

#include <dummy_GDL.h>

Inheritance diagram for FuelCellShop::Layer::DummyGDL< dim >:
Inheritance graph
[legend]
Collaboration diagram for FuelCellShop::Layer::DummyGDL< dim >:
Collaboration graph
[legend]

Public Member Functions

Destructor, and initalization
 DummyGDL ()
 Replica Constructors.
 
 ~DummyGDL ()
 Destructor.
 
void declare_parameters (ParameterHandler &param) const
 Declare parameters for a parameter file.
 
virtual void initialize (ParameterHandler &param)
 Member function used to read in data and initialize the necessary data to compute the coefficients.
 
virtual void set_parameters (const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, ParameterHandler &param)
 
Accessors and info
virtual void effective_gas_diffusivity (Table< 2, double > &) const
 Compute the effective diffusivty in the GDL.
 
virtual void effective_gas_diffusivity (Table< 2, Tensor< 2, dim > > &) const
 Compute the effective diffusivty in the GDL.
 
virtual void effective_electron_conductivity (double &) const
 Compute the effective electron conductivity in the GDL.
 
virtual void effective_electron_conductivity (Tensor< 2, dim > &) const
 Compute the effective electron conductivity in the GDL.
 
- Public Member Functions inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
virtual void set_diffusion_species_name (std::string &name)
 Member function used by some applications such as dummyGDL in order to know which value to return.
 
const std::type_info & get_base_type () const
 This member function returns a type_info object with the name of the base layer type the inherited class belongs to, i.e.
 
virtual void test_class () const
 Class test.
 
virtual void effective_gas_diffusivity (const double &, double &) const
 Return the effective diffusivty in the GDL.
 
virtual void effective_gas_diffusivity (const double &, Tensor< 2, dim > &) const
 Return the effective diffusivty in the GDL.
 
virtual void derivative_effective_gas_diffusivity (std::vector< Table< 2, Tensor< 2, dim > > > &) const
 Return the derivative of the effective gas diffusion in the GDL with respect to either the solution or design parameters for all the gases assigned to the layer using set_gases_and_compute.
 
virtual void effective_electron_conductivity (const double &, double &) const
 Compute the effective electron conductivity in the GDL.
 
virtual void effective_electron_conductivity (const double &, Tensor< 2, dim > &) const
 Compute the effective electron conductivity in the GDL.
 
virtual void derivative_effective_electron_conductivity (std::vector< Tensor< 2, dim > > &) const
 Compute the derivative of the effective electron conductivity in the GDL with respect to either the solution or design parameters.
 
virtual void gas_permeablity (double &) const
 Compute the GDL gas permeability.
 
virtual void gas_permeablity (Tensor< 2, dim > &) const
 Compute the GDL gas permeability.
 
virtual void derivative_gas_permeablity (std::vector< Tensor< 2, dim > > &) const
 Compute the derivative of the effective gas permeability in the GDL with respect to either the solution or design parameters.
 
virtual void liquid_permeablity (double &) const
 Compute the GDL liquid permeability.
 
virtual void liquid_permeablity (Tensor< 2, dim > &) const
 Compute the GDL liquid permeability.
 
virtual void derivative_liquid_permeablity (std::vector< Tensor< 2, dim > > &) const
 Compute the derivative of the effective gas diffusion in the GDL with respect to either the solution or design parameters.
 
- Public Member Functions inherited from FuelCellShop::Layer::PorousLayer< dim >
void set_gases_and_compute (std::vector< FuelCellShop::Material::PureGas * > &gases_in, const double &pressure_in, const double &temperature_in)
 Member function used to store all the gases that are in the pore space in the gas diffusion layer as well as their temperature [Kelvin] and total pressure [atm].
 
void compute_gas_diffusion (FuelCellShop::Material::PureGas *solute_gas, FuelCellShop::Material::PureGas *solvent_gas)
 Member function used to compute bulk diffusion coefficients and derivatives w.r.t temperature for non-isothermal case and store inside the layer.
 
void set_gases (std::vector< FuelCellShop::Material::PureGas * > &gases_in, const double &pressure_in)
 Member function used to store all the gases that are in the pore space in the porous layer.
 
void set_temperature (const SolutionVariable &T_in)
 Member function used to set the temperature ]Kelvin] at every quadrature point inside the cell.
 
FuelCellShop::Material::PureGasget_gas_pointer (int index) const
 Return the FuelCellShop::Material::PureGas pointer that is stored inside the class in the ith position.
 
std::vector
< FuelCellShop::Material::PureGas * > 
get_gases () const
 Returns the vector of FuelCellShop::Material::PureGas pointers stored in the porous layer.
 
void get_gas_index (FuelCellShop::Material::PureGas *gas_type, int &index) const
 Return the gas index in the GDL class.
 
void get_T_and_p (double &T, double &p) const
 Return the constant temperature [Kelvin] and constant pressure [atm] inside the layer.
 
void get_p (double &p) const
 Return the constant pressure [atm] inside the layer.
 
virtual void print_layer_properties () const
 This member function is a virtual class that can be used to output to screen information from the layer.
 
virtual bool test_layer () const
 This virtual class should be used for any derived class to be able to test the functionality of the class.
 
- Public Member Functions inherited from FuelCellShop::Layer::BaseLayer< dim >
virtual void set_derivative_flags (const std::vector< VariableNames > &flags)
 Set the variables for which you would like to compute the derivatives.
 
void set_position (std::vector< Point< dim > > &p)
 Member function used by some applications such as dummyGDL in order to know which value to return.
 
virtual void set_constant_solution (const double &value, const VariableNames &name)
 Set those solution variables which are constant in the particular application.
 
virtual void set_solution (const std::vector< SolutionVariable > &)
 If the effective properties in the layer depend on the solution, the solution for a given cell should be passed to the class using this member function.
 
bool belongs_to_material (const char material_id)
 Check if a given cell belongs to the catalyst layer.
 
const std::string & name_material ()
 Return the name of the layer.
 
virtual bool test_layer ()
 This virtual class should be used for any derived class to be able to test the functionality of the class.
 
unsigned int get_material_id ()
 Return the material id of the layer.
 

Static Public Attributes

static const std::string concrete_name
 Concrete name used for objects of this class.
 
- Static Public Attributes inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
static const std::string concrete_name
 Concrete name used for objects of this class.
 

Private Member Functions

Constructors, destructor, and initalization
 DummyGDL (std::string name)
 Constructor.
 
virtual void declare_parameters (const std::string &name, ParameterHandler &param) const
 Declare parameters for a parameter file.
 
virtual void set_parameters (const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, const std::string &gdl_section_name, ParameterHandler &param)
 
Instance Delivery (functions)
virtual boost::shared_ptr
< FuelCellShop::Layer::GasDiffusionLayer
< dim > > 
create_replica (const std::string &name)
 This member function is used to create an object of type gas diffusion layer.
 

Private Attributes

Internal variables
bool anisotropy
 Anisotropy ?
 
double porosity
 Porosity of the GDL.
 
std::vector< double > D_O2
 Oxygen diffusion coefficient.
 
std::vector< double > D_wv
 Water vapour diffusion coefficient.
 
std::vector< double > sigma_e
 Solid network conductivity.
 

Static Private Attributes

Instance Delivery (attributes)
static DummyGDL< dim > const * PROTOTYPE
 

Additional Inherited Members

- Static Public Member Functions inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
static void declare_GasDiffusionLayer_parameters (const std::string &gld_section_name, ParameterHandler &param)
 Function used to declare all the data necessary in the parameter files for all GasDiffusionLayer children.
 
static void set_GasDiffusionLayer_parameters (const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, std::string gld_section_name, ParameterHandler &param)
 
static boost::shared_ptr
< FuelCellShop::Layer::GasDiffusionLayer
< dim > > 
create_GasDiffusionLayer (const std::string &gld_section_name, ParameterHandler &param)
 Function used to select the appropriate GasDiffusionLayer type as specified in the ParameterHandler under line.
 
- Protected Types inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
typedef std::map< std::string,
GasDiffusionLayer< dim > * > 
_mapFactory
 This object is used to store all objects of type GasDiffusionLayer.
 
- Protected Member Functions inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
 GasDiffusionLayer ()
 Replica Constructors.
 
 ~GasDiffusionLayer ()
 Destructor.
 
 GasDiffusionLayer (const std::string &name)
 Constructor.
 
void declare_parameters (ParameterHandler &param) const
 Declare parameters for a parameter file.
 
virtual void set_parameters (const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, const std::string &name, ParameterHandler &param) const
 Member function used to set new parameters values in the optimization loop.
 
void initialize (ParameterHandler &param)
 Member function used to read in data and initialize the necessary data to compute the coefficients.
 
- Static Protected Member Functions inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
static _mapFactoryget_mapFactory ()
 
- Protected Attributes inherited from FuelCellShop::Layer::GasDiffusionLayer< dim >
std::string diffusion_species_name
 If GDL properties are stored inside the class (e.g.
 
double porosity
 Porosity of the GDL.
 
Tensor< 2, dimtortuosity_tensor
 Tortuosity tensor of the GDL.
 
double electron_conductivity
 Double storing the electric conductivity of the GDL is the layer is isotropic.
 
Tensor< 2, dimelectron_conductivity_tensor
 Tensor storing the effective electronic conductivity of the layer.
 

Detailed Description

template<int dim>
class FuelCellShop::Layer::DummyGDL< dim >

This class is used when we want to input the effective properties to the GDL directly, without taking into account the structure of the GDL \ UNDER DEVELOPMENT.

Author
M. Secanell, 2011-13

Constructor & Destructor Documentation

template<int dim>
FuelCellShop::Layer::DummyGDL< dim >::DummyGDL ( )

Replica Constructors.

Warning
For internal use only.

Constructor used only to create a prototype. Do not use in general since this will not include the name of the section in the parameter file you need.

template<int dim>
FuelCellShop::Layer::DummyGDL< dim >::~DummyGDL ( )
inline

Destructor.

template<int dim>
FuelCellShop::Layer::DummyGDL< dim >::DummyGDL ( std::string  name)
private

Constructor.

Deprecated:
Use create_GasDiffusionLayer

Member Function Documentation

template<int dim>
virtual boost::shared_ptr<FuelCellShop::Layer::GasDiffusionLayer<dim> > FuelCellShop::Layer::DummyGDL< dim >::create_replica ( const std::string &  name)
inlineprivatevirtual

This member function is used to create an object of type gas diffusion layer.

Warning
This class MUST be redeclared in every child.

Reimplemented from FuelCellShop::Layer::GasDiffusionLayer< dim >.

template<int dim>
void FuelCellShop::Layer::DummyGDL< dim >::declare_parameters ( ParameterHandler &  param) const
inlinevirtual

Declare parameters for a parameter file.

Deprecated:
Use declare_all_GasDiffusionLayer_parameters

Reimplemented from FuelCellShop::Layer::PorousLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::declare_parameters ( const std::string &  name,
ParameterHandler &  param 
) const
privatevirtual

Declare parameters for a parameter file.

Reimplemented from FuelCellShop::Layer::GasDiffusionLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::effective_electron_conductivity ( double &  ) const
virtual

Compute the effective electron conductivity in the GDL.

Reimplemented from FuelCellShop::Layer::GasDiffusionLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::effective_electron_conductivity ( Tensor< 2, dim > &  ) const
virtual

Compute the effective electron conductivity in the GDL.

Reimplemented from FuelCellShop::Layer::GasDiffusionLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::effective_gas_diffusivity ( Table< 2, double > &  ) const
virtual

Compute the effective diffusivty in the GDL.

This routine takes the gas diffusivity from FuelCellShop::BinaryDiffusion and transforms it into an effective property taking into account the porosity and structure of the GDL

Reimplemented from FuelCellShop::Layer::GasDiffusionLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::effective_gas_diffusivity ( Table< 2, Tensor< 2, dim > > &  ) const
virtual

Compute the effective diffusivty in the GDL.

This routine takes the gas diffusivity from FuelCellShop::BinaryDiffusion and transforms it into an effective property taking into account the porosity and structure of the GDL (Anisotropic case)

Reimplemented from FuelCellShop::Layer::GasDiffusionLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::initialize ( ParameterHandler &  param)
virtual

Member function used to read in data and initialize the necessary data to compute the coefficients.

Reimplemented from FuelCellShop::Layer::PorousLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::set_parameters ( const std::vector< std::string > &  name_dvar,
const std::vector< double > &  value_dvar,
ParameterHandler &  param 
)
inlinevirtual
Deprecated:
Use set_all_GasDiffusionLayer_parameters

Reimplemented from FuelCellShop::Layer::PorousLayer< dim >.

template<int dim>
virtual void FuelCellShop::Layer::DummyGDL< dim >::set_parameters ( const std::vector< std::string > &  name_dvar,
const std::vector< double > &  value_dvar,
const std::string &  gdl_section_name,
ParameterHandler &  param 
)
privatevirtual
Deprecated:
Use set_all_GasDiffusionLayer_parameters

Member Data Documentation

template<int dim>
bool FuelCellShop::Layer::DummyGDL< dim >::anisotropy
private

Anisotropy ?

template<int dim>
const std::string FuelCellShop::Layer::DummyGDL< dim >::concrete_name
static

Concrete name used for objects of this class.

This name is used when setting up the subsection where the data is stored in the input file.

The data will be store under

subsection name_specified_in_constructor
set Material id = 2
set Gas diffusion layer type = DummyGDL # <-here I select the type of object of type GasDiffusionLayer
subsection DummyGDL # <- this is the concrete_name for this class
set all info relevant to this object
end
end
template<int dim>
std::vector<double> FuelCellShop::Layer::DummyGDL< dim >::D_O2
private

Oxygen diffusion coefficient.

template<int dim>
std::vector<double> FuelCellShop::Layer::DummyGDL< dim >::D_wv
private

Water vapour diffusion coefficient.

template<int dim>
double FuelCellShop::Layer::DummyGDL< dim >::porosity
private

Porosity of the GDL.

template<int dim>
DummyGDL<dim> const* FuelCellShop::Layer::DummyGDL< dim >::PROTOTYPE
staticprivate
template<int dim>
std::vector<double> FuelCellShop::Layer::DummyGDL< dim >::sigma_e
private

Solid network conductivity.


The documentation for this class was generated from the following file: