Virtual class used to provide the interface for all GasDiffusionLayer children. More...

#include <gas_diffusion_layer.h>

Inheritance diagram for FuelCellShop::Layer::GasDiffusionLayer< dim >:

Collaboration diagram for FuelCellShop::Layer::GasDiffusionLayer< dim >:

Public Member Functions
Initalization
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. More...

Accessors and info
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. More...

virtual void	test_class () const
	Class test. More...

Effective property calculators
virtual void	effective_gas_diffusivity (const double &, const double &, double &) const
	Compute the effective property in the pores of the GDL. More...

virtual void	effective_gas_diffusivity (const double &, const double &, Tensor< 2, dim > &) const
	Compute the effective property in the pores of the GDL. More...

virtual void	effective_gas_diffusivity (std::vector< Tensor< 2, dim > > &) const
	Return the effective diffusivity [`m^2/s`] for nonisothermal with/without two-phase case in the GDL. More...

virtual void	derivative_effective_gas_diffusivity (std::map< VariableNames, std::vector< Tensor< 2, dim > > > &) const
	Return the derivative of effective diffusivity w.r.t solution variables/design parameters for nonisothermal with/without two-phase case in the GDL. More...

virtual void	effective_gas_diffusivity (Table< 2, double > &D_eff) const
	Return the effective diffusivty in the GDL for all the gases assigned to the layer using set_gases_and_compute. More...

virtual void	effective_gas_diffusivity (Table< 2, Tensor< 2, dim > > &D_eff) const
	Return a tensor with the effective diffusivty in the GDL for all the gases assigned to the layer using set_gases_and_compute. More...

virtual void	effective_electron_conductivity (double &) const
	Compute the effective electron conductivity in the GDL. More...

virtual void	effective_electron_conductivity (const double &, double &) const
	Compute the effective electron conductivity in the GDL. More...

virtual void	effective_electron_conductivity (Tensor< 2, dim > &) const
	Compute the effective electron conductivity in the GDL. More...

virtual void	effective_electron_conductivity (const double &, Tensor< 2, dim > &) const
	Compute the effective electron conductivity in the GDL. More...

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. More...

virtual void	effective_thermal_conductivity (double &) const
	Compute the effective thermal conductivity (isotropic) in the GDL. More...

virtual void	effective_thermal_conductivity (Tensor< 2, dim > &) const
	Compute the effective thermal conductivity (anisotropic) in the GDL. More...

virtual void	effective_thermal_conductivity (std::vector< Tensor< 2, dim > > &) const
	Compute the effective thermal conductivity (anisotropic) in the GDL, dependent on various solution variables, eg: Temperature. More...

virtual void	derivative_effective_thermal_conductivity (std::vector< Tensor< 2, dim > > &) const
	Compute the derivative of the effective thermal conductivity in the GDL with respect to either the solution or design parameters. More...

virtual void	gas_permeablity (double &) const
	Compute the GDL gas permeability. More...

virtual void	gas_permeablity (Tensor< 2, dim > &) const
	Compute the GDL gas permeability. More...

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. More...

virtual void	liquid_permeablity (std::vector< Tensor< 2, dim > > &) const
	Compute the anisotropic GDL liquid permeability $\left[ cm^2 \right]$ , at all quadrature points in the cell. More...

virtual void	derivative_liquid_permeablity (std::map< VariableNames, std::vector< Tensor< 2, dim > > > &) const
	Compute the derivative of the anisotropic liquid permeability in the GDL with respect to either the solution or design parameters, at all quadrature points in the cell. More...

virtual void	relative_liquid_permeability_PSD (std::vector< Tensor< 2, dim > > &) const
	Compute the derivative of the anisotropic liquid permeability in the GDL with respect to either the solution or design parameters, at all quadrature points in the cell. More...

virtual void	derivative_relative_liquid_permeablity_PSD (std::vector< double > &) const

virtual void	derivative_relative_liquid_permeablity_PSD (std::map< VariableNames, std::vector< Tensor< 2, dim > > > &) const

virtual void	saturated_liquid_permeablity_PSD (double &) const

virtual void	pcapillary (std::vector< double > &) const
	Compute $p_c \quad \left[ dyne \cdot cm^{-2}\right]$ , at all quadrature points in the cell. More...

virtual void	saturation_from_capillary_equation (std::vector< double > &) const

virtual void	derivative_saturation_from_capillary_equation_PSD (std::vector< double > &) const

virtual void	dpcapillary_dsat (std::vector< double > &) const
	Compute $\frac{\partial p_c}{\partial s} \quad \left[ dyne \cdot cm^{-2}\right]$ , at all quadrature points in the GDL. More...

virtual void	derivative_dpcapillary_dsat (std::map< VariableNames, std::vector< double > > &) const
	Compute the derivative of $\frac{\partial p_c}{\partial s} \quad \left[ dyne \cdot cm^{-2}\right]$ in the GDL, with respect to either the solution or design parameters, at all quadrature points in the cell. More...

virtual void	interfacial_surface_area (std::vector< double > &) const
	Compute the liquid-gas interfacial surface area per unit volume, $a_{lv} ~\left[ \frac{cm^2}{cm^3} \right]$ , at all quadrature points in the GDL. More...

virtual void	derivative_interfacial_surface_area (std::map< VariableNames, std::vector< double > > &) const
	Compute the derivative of the liquid-gas interfacial surface area per unit volume, with respect to either the solution variables or design parameters, at all quadrature points in the GDL. More...

virtual void	interfacial_surface_area_PSD (std::vector< double > &) const
	Compute the liquid-gas interfacial surface area per unit volume, $a_{lv} ~\left[ \frac{cm^2}{cm^3} \right]$ , at all quadrature points in the CL. More...

virtual void	derivative_interfacial_surface_area_PSD (std::map< VariableNames, std::vector< double > > &) const
	Compute the derivative of the liquid-gas interfacial surface area per unit volume, with respect to either the solution variables or design parameters, at all quadrature points in the CL. More...

virtual void	derivative_interfacial_surface_area_PSD (std::vector< double > &) const

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`]. More...

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). More...

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. More...

void	set_gas_mixture (FuelCellShop::Material::GasMixture &rgas_mixture)
	Set `gas_mixture`. More...

void	set_porosity_permeability_tortuosity_booleans (const bool &rporosity_is_constant, const bool &rpermeability_is_constant, const bool &rtortuosity_is_constant)
	Set. More...

void	set_pressure (const SolutionVariable &p_in)
	Member function used to set the temperature [`Kelvin`] at every quadrature point inside the cell. More...

void	set_temperature (const SolutionVariable &T_in)
	Member function used to set the temperature [`Kelvin`] at every quadrature point inside the cell. More...

void	set_saturation (const SolutionVariable &s_in)
	Member function used to set the liquid water saturation at every quadrature point inside the cell. More...

void	set_capillary_pressure (const SolutionVariable &p_in)
	Member function used to set the liquid water saturation at every quadrature point inside the cell. More...

FuelCellShop::Material::PureGas *	get_gas_pointer (int index) const
	Return the FuelCellShop::Material::PureGas pointer that is stored inside the class in the ith position. More...

std::vector < FuelCellShop::Material::PureGas * >	get_gases () const
	Returns the vector of FuelCellShop::Material::PureGas pointers stored in the porous layer. More...

const FuelCellShop::Material::GasMixture *const	get_gas_mixture () const
	This function returns `gas_mixture`. More...

void	get_gas_index (FuelCellShop::Material::PureGas *gas_type, int &index) const
	Return the gas index in the GDL class. More...

void	get_T_and_p (double &T, double &p) const
	Return the constant temperature [`Kelvin`] and constant pressure [`atm`] inside the layer. More...

void	get_p (double &p) const
	Return the constant pressure [`atm`] inside the layer. More...

const bool &	get_porosity_is_constant () const
	This function returns `porosity_is_constant`. More...

const bool &	get_permeability_is_constant () const
	This function returns `permeability_is_constant`. More...

const bool &	get_tortuosity_is_constant () const
	This function returns `tortuosity_is_constant`. More...

double	get_porosity () const
	This function computes constant porosity in quadrature points of a mesh entity. More...

void	get_porosity (std::vector< double > &dst) const
	This function computes constant porosity in quadrature points of a mesh entity. More...

void	get_porosity (std::vector< double > &dst, const std::vector< Point< dim > > &points) const
	This function computes variable porosity in quadrature points of a mesh entity. More...

void	get_permeability (std::vector< SymmetricTensor< 2, dim > > &dst) const
	This function computes constant permeability in quadrature points of a mesh entity. More...

void	get_permeability (std::vector< SymmetricTensor< 2, dim > > &dst, const std::vector< Point< dim > > &points) const
	This function computes variable permeability in quadrature points of a mesh entity. More...

void	get_SQRT_permeability (std::vector< SymmetricTensor< 2, dim > > &dst) const
	This function computes square root of constant permeability in quadrature points of a mesh entity. More...

void	get_SQRT_permeability (std::vector< SymmetricTensor< 2, dim > > &dst, const std::vector< Point< dim > > &points) const
	This function computes square root of variable permeability in quadrature points of a mesh entity. More...

void	get_permeability_INV (std::vector< SymmetricTensor< 2, dim > > &dst) const
	This function computes inverse of constant permeability in quadrature points of a mesh entity. More...

void	get_permeability_INV (std::vector< SymmetricTensor< 2, dim > > &dst, const std::vector< Point< dim > > &points) const
	This function computes inverse of variable permeability in quadrature points of a mesh entity. More...

void	get_SQRT_permeability_INV (std::vector< SymmetricTensor< 2, dim > > &dst) const
	This function computes inverse of square root of constant permeability in quadrature points of a mesh entity. More...

void	get_SQRT_permeability_INV (std::vector< SymmetricTensor< 2, dim > > &dst, const std::vector< Point< dim > > &points) const
	This function computes inverse of square root of variable permeability in quadrature points of a mesh entity. More...

void	get_Forchheimer_permeability (std::vector< SymmetricTensor< 2, dim > > &dst) const
	This function computes constant Forchheimer permeability in quadrature points of a mesh entity. More...

void	get_Forchheimer_permeability (std::vector< SymmetricTensor< 2, dim > > &dst, const std::vector< Point< dim > > &points) const
	This function computes variable Forchheimer permeability in quadrature points of a mesh entity. More...

void	get_tortuosity (std::vector< SymmetricTensor< 2, dim > > &dst) const
	This function computes constant tortuosity in quadrature points of a mesh entity. More...

void	get_tortuosity (std::vector< SymmetricTensor< 2, dim > > &dst, const std::vector< Point< dim > > &points) const
	This function computes variable tortuosity in quadrature points of a mesh entity. More...

virtual void	gas_diffusion_coefficient (std::vector< double > &D_b) const
	Member function used to compute diffusion for a solute_gas, solvent_gas combination at a given temperature and pressure. More...

virtual void	gas_diffusion_coefficient (std::vector< double > &D_b, std::vector< double > &dD_b_dT) const
	Member function used to compute diffusion for a solute_gas, solvent_gas combination at a given temperature and pressure. More...

void	molecular_gas_diffusion_coefficient (std::vector< double > &D_m) const
	Member function used to compute molecular diffusion for a solute_gas, solvent_gas combination at a given temperature and pressure. More...

void	molecular_gas_diffusion_coefficient (std::vector< double > &D_m, std::vector< double > &dD_m_dT) const
	Member function used to compute molecular diffusion for a solute_gas, solvent_gas combination at a given temperature and pressure. More...

void	Knudsen_diffusion (std::vector< double > &D) const
	Member function used to get the Knudsen diffusivity in the layer after calling compute_gas_diffusion. More...

void	Knudsen_diffusion (std::vector< double > &D, std::vector< double > &dD_dT) const
	Member function used to compute the Knudsen diffusivity in the layer.after calling compute_gas_diffusion. More...

void	compute_Knudsen_diffusion (const FuelCellShop::Material::PureGas *solute_gas, const SolutionVariable &T_in, std::vector< double > &D_k) const
	Member function used to compute the Knudsen diffusivity in the layer. More...

void	compute_Knudsen_diffusion (const FuelCellShop::Material::PureGas *solute_gas, const SolutionVariable &T_in, std::vector< double > &D_k, std::vector< double > &dD_k_dT) const
	Member function used to compute the Knudsen diffusivity in the layer. More...

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. More...

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. More...

void	set_position (const std::vector< Point< dim > > &p)
	Member function used by some applications such as dummyGDL in order to know which value to return. More...

virtual void	set_local_material_id (const unsigned int &id)
	Function for setting local material id, for unit testing purposes. More...

void	unset_local_material_id ()
	Function for unsetting local material id, so that it isn't incorrectly used later Once the key is "unset" to some invalid value, an error will be thrown if the key is requested again without being set. More...

virtual void	set_constant_solution (const double &value, const VariableNames &name)
	Set those solution variables which are constant in the particular application. More...

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. More...

bool	belongs_to_material (const unsigned int material_id)
	Check if a given cell belongs to the catalyst layer and assign. More...

const std::string &	name_layer () const
	Return the name of the layer. More...

virtual bool	test_layer ()
	This virtual class should be used for any derived class to be able to test the functionality of the class. More...

std::vector< unsigned int >	get_material_ids ()
	Return the local material id of the layer. More...

unsigned int	local_material_id () const
	Return the local material id of the layer, performs a check. More...

Static Public Member Functions
Instance Delivery (Public functions)
static void	declare_GasDiffusionLayer_parameters (const std::string &gdl_section_name, ParameterHandler &param)
	Function used to declare all the data necessary in the parameter files for all GasDiffusionLayer children. More...

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. More...

Static Public Attributes
Instance Delivery (Public variables)
static const std::string	concrete_name
	Concrete name used for objects of this class. More...

Protected Types
Instance Delivery (Types)
typedef std::map< std::string, GasDiffusionLayer< dim > * >	_mapFactory
	This object is used to store all objects of type GasDiffusionLayer. More...

Protected Member Functions
Constructors, destructor, and initalization
	GasDiffusionLayer ()
	Replica Constructors. More...

	~GasDiffusionLayer ()
	Destructor. More...

	GasDiffusionLayer (const std::string &name)
	Constructor. More...

void	declare_parameters (ParameterHandler &param) const
	Declare parameters for a parameter file. More...

virtual void	declare_parameters (const std::string &name, ParameterHandler &param) const
	Declare parameters for a parameter file. More...

void	initialize (ParameterHandler &param)
	Member function used to read in data and initialize the necessary data to compute the coefficients. More...

Instance Delivery (Private 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. More...

Protected Member Functions inherited from FuelCellShop::Layer::PorousLayer< dim >
	PorousLayer (const std::string &name)
	Constructor. More...

	PorousLayer ()
	Constructor. More...

	PorousLayer (const std::string &name, FuelCellShop::Material::GasMixture &gas_mixture)
	Constructor. More...

virtual	~PorousLayer ()
	Destructor. More...

void	print_caller_name (const std::string &caller_name) const
	This function is used to print out the name of another function that has been declared in the scope of this class, but not yet been implemented. More...

virtual void	gas_diffusion_coefficients (Table< 2, double > &) const
	Return the molecular diffusivty all the gases assigned to the layer using set_gases_and_compute. More...

virtual void	derivative_gas_diffusion_coefficients (std::vector< Table< 2, double > > &) const
	Return the derivative of the molecular diffusion coefficient with respect to the derivative flags for all the gases assigned to the layer using set_gases_and_compute. More...

Protected Member Functions inherited from FuelCellShop::Layer::BaseLayer< dim >
	BaseLayer ()
	Constructor. More...

	BaseLayer (const std::string &name)
	Constructor. More...

virtual	~BaseLayer ()
	Destructor. More...

virtual void	set_parameters (const std::string &object_name, const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, ParameterHandler &param)
	Member function used to change the values in the parameter file for a given list of parameters. More...

virtual void	set_parameters (const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, ParameterHandler &param)
	Set parameters in parameter file. More...

Static Protected Member Functions
Instance Delivery (Private and static)
static _mapFactory *	get_mapFactory ()

Protected Attributes
Internal variables
std::string	diffusion_species_name
	If GDL properties are stored inside the class (e.g. More...

std::string	PSD_type
	PSD class type from input file. More...

double	porosity
	Porosity of the GDL. More...

Tensor< 2, dim >	tortuosity_tensor
	Tortuosity tensor of the GDL. More...

Tensor< 2, dim >	thermal_conductivity_tensor
	Tensor storing the effective thermal conductivity of the layer. More...

double	electron_conductivity
	Double storing the electric conductivity of the GDL is the layer is isotropic. More...

Tensor< 2, dim >	electron_conductivity_tensor
	Tensor storing the effective electronic conductivity of the layer. More...

Protected Attributes inherited from FuelCellShop::Layer::PorousLayer< dim >
FuelCellShop::Material::GasMixture *	gas_mixture
	Gas mixture. More...

std::vector < FuelCellShop::Material::PureGas * >	gases
	Gases inside a porous layer. More...

bool	porosity_is_constant
	Variable defining if the porosity is constant. More...

bool	permeability_is_constant
	Variable defining if the permeability is constant. More...

bool	tortuosity_is_constant
	Variable defining if the tortuosity is constant. More...

double	porosity
	User defined constant porosity. More...

bool	use_Bosanquet
	Boolean flag that specifies if Knudsen effects should be accounted for. More...

double	Knudsen_radius
	Parameter used to define Knudsen pore radius. More...

SymmetricTensor< 2, dim >	permeability
	User defined constant permeability, m^2. More...

SymmetricTensor< 2, dim >	SQRT_permeability
	Square root of user defined constant permeability, m. More...

SymmetricTensor< 2, dim >	permeability_INV
	Inverse of user defined constant permeability, 1/m^2. More...

SymmetricTensor< 2, dim >	SQRT_permeability_INV
	Inverse of square root of user defined constant permeability, 1/m. More...

SymmetricTensor< 2, dim >	Forchheimer_permeability
	User defined constant Forchheimer permeability, 1/m. More...

SymmetricTensor< 2, dim >	tortuosity
	User defined constant tortuosity. More...

std::string	diffusion_species_name
	If GDL properties are stored inside the class (e.g DummyGDL) then, return the property stored under coefficient_name name. More...

double	temperature
	Temperature [`K`] used to compute gas diffusivity. More...

double	pressure
	Total pressure [`atm`] used to compute gas diffusivity. More...

SolutionVariable	p_vector
	Pressure at every quadrature point inside the cell in [Pa]. More...

SolutionVariable	T_vector
	Temperature at every quadrature point inside the cell in [K]. More...

SolutionVariable	s_vector
	Liquid water saturation at every quadrature point inside the cell [-]. More...

SolutionVariable	capillary_pressure_vector
	Liquid water capillary pressure at every quadrature point inside the cell in [Pa]. More...

Table< 2, double >	D_ECtheory
	Tensor of diffusion coefficients This are computed with setting up the gas so that they do not need to be recomputed all the time. More...

std::vector< Table< 2, double > >	dD_ECtheory_dx
	Vector of tensors for the derivative of the diffusion coefficients – This are computed with setting up the gas so that they do not need to be recomputed all the time. More...

std::vector< double >	D_molecular
	Vector of molecular diffusion coefficients at every quadrature point inside the cell in m^2/s. More...

std::vector< double >	dD_molecular_dT
	Vector of derivatives for molecular diffusion coefficients w.r.t temperature, at every quadrature in m^2/s. More...

std::vector< double >	D_k
	Vector of Knudsen diffusion coefficients at every quadrature point inside the cell in m^2/s. More...

std::vector< double >	dD_k_dT
	Vector of derivatives for Knudsen diffusion coefficients w.r.t temperature, at every quadrature in m^2/s. More...

std::vector< double >	D_bulk
	Vector of bulk diffusion coefficients at every quadrature point inside the cell. More...

std::vector< double >	dD_bulk_dT
	Vector of derivative of bulk diffusion coefficients w.r.t temperature, at every quadrature point inside the cell. More...

bool	PSD_is_used
	Boolean flag to specify if a PSD is to be used to estimate saturation, permeability, etc. More...

std::string	PSD_type
	PSD class type from input file. More...

boost::shared_ptr < FuelCellShop::MicroScale::BasePSD < dim > >	PSD
	Pointer to the PSD object. More...

FuelCellShop::MicroScale::BasePSD < dim > *	psd_pointer
	Pointer to the PSD object. More...

FuelCellShop::Material::PureGas *	solute_gas
	Pointer used to store the solute gas for computing binary diffusion coefficients. More...

FuelCellShop::Material::PureGas *	solvent_gas
	Pointer used to store the solute gas for computing binary diffusion coefficients. More...

Protected Attributes inherited from FuelCellShop::Layer::BaseLayer< dim >
const std::string	name
	Name of the layer. More...

std::vector< unsigned int >	material_ids
	List of material IDs that belong to the layer. More...

std::vector< Point< dim > >	point
	Coordinates of the point where we would like to compute the effective properties. More...

std::vector< VariableNames >	derivative_flags
	Flags for derivatives: These flags are used to request derivatives. More...

std::map< VariableNames, double >	constant_solutions
	Map storing values of solution variables constant in a particular application. More...

Detailed Description

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

Virtual class used to provide the interface for all GasDiffusionLayer children.

No object of type GasDiffusionLayer should ever be created, instead this layer is used to initialize pointers of type GasDiffusionLayer. The class has a database of children such that it will declare all necessary parameters for all children in the input file, read the input file, create the appripriate children and return a pointer to GasDiffusionLayer with the children selected.

All public functions are virtual but the static functions used to declare parameters and to initialize a pointer of GasDiffusionLayer, i.e. declare_all_GasDiffusionLayer_parameters, set_all_GasDiffusionLayer_parameters and create_GasDiffusionLayer.

Usage Details:

In order to create a gas diffusion layer within an application, the following steps need to be taken.

First, in the application .h file, create a pointer to a GasDiffusionLayer object, i.e.

* boost::shared_ptr<FuelCellShop::Layer::GasDiffusionLayer<dim> > CGDL;

*

This pointer object will be available anywhere inside the application. Because we do not want to worry about deleting the pointer afterwards, we use a Boost pointer which has its own memory management algorithms. See the Boost website for more information

Once the pointer is available, we need to do three things in the application

Call declare_all_GasDiffusionLayer_parameters in the application declare_parameters() member function. This member function is used to define all parameters that can be read from the input file
Call create_GasDiffusionLayer and initialize. The former member function will fill the pointer created above with the appropriate gas diffusion layer you have selected in the input file. Then, initialize reads from the input file all the data from the file in order to setup the object.

The object is ready for use now.

Here is a code example from app_cathode.cc:

* //--------- IN DECLARE_PARAMETERS ------------------------------------------------------
* template <int dim>
* void 
* NAME::AppCathode<dim>::declare_parameters(ParameterHandler& param)
* {
*   (...)
*   // Declare section on the input file where all info will be stored. In this case Fuel Cell Data > Cathode gas diffusion layer
*   FuelCellShop::Layer::GasDiffusionLayer<dim>::declare_GasDiffusionLayer_parameters("Cathode gas diffusion layer", param);
*   (...)
* }
* 
* //--------- IN INITIALIZE ------------------------------------------------------
* template <int dim>
* void
* NAME::AppCathode<dim>::_initialize(ParameterHandler& param)
* {   
*  (...) 
*   // Initialize layer classes:
*   std::vector< FuelCellShop::Material::PureGas * > gases;
*   gases.push_back(&oxygen);
*   gases.push_back(&nitrogen);
*    
*   CGDL = FuelCellShop::Layer::GasDiffusionLayer<dim>::create_GasDiffusionLayer("Cathode gas diffusion layer",param);
*   // Here, I specify the gases that exist in the GDL and their temperature and pressure (based on operating conditions):
*   CGDL->set_gases_and_compute(gases, OC.get_pc_atm (), OC.get_T());
*   (...)
* }
* 

Author: M. Secanell, 2013

Member Typedef Documentation

template<int dim>

typedef std::map< std::string, GasDiffusionLayer<dim>* > FuelCellShop::Layer::GasDiffusionLayer< dim >::_mapFactory

protected

This object is used to store all objects of type GasDiffusionLayer.

Constructor & Destructor Documentation

template<int dim>

FuelCellShop::Layer::GasDiffusionLayer< dim >::GasDiffusionLayer ( )

protected

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::GasDiffusionLayer< dim >::~GasDiffusionLayer ( )

protected

Destructor.

template<int dim>

FuelCellShop::Layer::GasDiffusionLayer< dim >::GasDiffusionLayer ( const std::string & name )

protected

Constructor.

Member Function Documentation

template<int dim>

static boost::shared_ptr<FuelCellShop::Layer::GasDiffusionLayer<dim> > FuelCellShop::Layer::GasDiffusionLayer< dim >::create_GasDiffusionLayer	(	const std::string &	gld_section_name,
		ParameterHandler &	param
	)

inlinestatic

Function used to select the appropriate GasDiffusionLayer type as specified in the ParameterHandler under line.

* set Gas diffusion layer type = DummyGDL

*

current options are [ DesignFibrousGDL | DummyGDL | SGL24BA ]

The class will read the appropriate section in the parameter file, i.e. the one with name

Parameters

gld_section_name,create an object of the desired type and return it.

References FuelCellShop::Layer::GasDiffusionLayer< dim >::create_replica(), FuelCellShop::Layer::GasDiffusionLayer< dim >::get_mapFactory(), and FcstUtilities::log.

Here is the call graph for this function:

template<int dim>

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

inlineprotectedvirtual

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

Warning: This class MUST be redeclared in every child.

Reimplemented in FuelCellShop::Layer::DesignFibrousGDL< dim >, FuelCellShop::Layer::DummyGDL< dim >, and FuelCellShop::Layer::SGL24BA< dim >.

gld_section_name	Name of the section that will encapuslate all the information about the GDL
param	ParameterHandler object used to store all information about the simulation. Used to read the parameter file.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

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

Usage Details:

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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