This class deals with Proton Transport Equation. More...

#include <proton_transport_equation.h>

Inheritance diagram for FuelCellShop::Equation::ProtonTransportEquation< dim >:

Collaboration diagram for FuelCellShop::Equation::ProtonTransportEquation< dim >:

Public Member Functions
Constructors, destructor, and initalization
	ProtonTransportEquation (FuelCell::SystemManagement &system_management, boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData > data=boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData >())
	Constructor. More...

virtual	~ProtonTransportEquation ()
	Destructor. More...

virtual void	declare_parameters (ParameterHandler &param) const
	Declare parameters. More...

virtual void	initialize (ParameterHandler &param)
	Initialize parameters. More...

Local CG FEM based assemblers
virtual void	assemble_cell_matrix (FuelCell::ApplicationCore::MatrixVector &cell_matrices, const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local cell matrix. More...

virtual void	assemble_cell_residual (FuelCell::ApplicationCore::FEVector &cell_rhs, const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local cell residual. More...

virtual void	assemble_bdry_matrix (FuelCell::ApplicationCore::MatrixVector &bdry_matrices, const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local boundary matrix. More...

virtual void	assemble_bdry_residual (FuelCell::ApplicationCore::FEVector &bdry_rhs, const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local boundary residual. More...

Accessors and info
virtual void	print_equation_info () const
	The function prints out the equation's info. More...

std::map< unsigned int, double >	get_dirichlet_bdry_map () const
	Method to provide access to Dirichlet boundary conditions map filled using the parameter file. More...

void	class_test ()
	This member function creates an object of its own type and runs test to diagnose if there are any problems with the routines that you have created. More...

Public Member Functions inherited from FuelCellShop::Equation::EquationBase< dim >
const couplings_map &	get_internal_cell_couplings () const
	This function returns `internal_cell_couplings` of a derived equation class. More...

const couplings_map &	get_internal_flux_couplings () const
	This function returns `internal_flux_couplings` (DG FEM only) of a derived equation class. More...

const component_materialID_value_map &	get_component_materialID_value () const
	This function returns `component_materialID_value` of a derived equation class. More...

const component_boundaryID_value_map &	get_component_boundaryID_value () const
	This function returns `component_boundaryID_value` of a derived equation class. More...

const std::vector< BoundaryType > &	get_boundary_types () const
	This function returns `boundary_types` of a derived equation class. More...

const std::vector< std::vector < BoundaryType > > &	get_multi_boundary_types () const
	This function returns `multi_boundary_types` of a derived equation class. More...

const std::vector< OutputType > &	get_output_types () const
	This function returns `output_types` of a derived equation class. More...

const std::vector< std::vector < OutputType > > &	get_multi_output_types () const
	This function returns `multi_output_types` of a derived equation class. More...

const std::string &	get_equation_name () const
	This function returns `equation_name` of a derived equation class. More...

const std::vector< unsigned int > &	get_matrix_block_indices () const
	This function returns `matrix_block_indices` of a derived equation class. More...

const std::vector< unsigned int > &	get_residual_indices () const
	This function returns `residual_indices` of a derived equation class. More...

Protected Member Functions
Local CG FEM based assemblers - make_ functions
virtual void	make_assemblers_generic_constant_data ()
	This function computes Local CG FEM based assemblers - constant data (generic). More...

virtual void	make_assemblers_cell_constant_data (const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info)
	This function computes Local CG FEM based assemblers - constant data (cell) and allocates the memory for `shape` `functions`, `shape` `function` `gradients`, and `JxW_cell` in Local CG FEM based assemblers - variable data (cell) . More...

virtual void	make_assemblers_bdry_constant_data (const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info)
	This function computes Local CG FEM based assemblers - constant data (boundary) and allocates the memory for `shape` `functions`, normal_vectors, and `JxW_bdry` in Local CG FEM based assemblers - variable data (boundary) . More...

virtual void	make_assemblers_cell_variable_data (const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	This function computes Local CG FEM based assemblers - variable data (cell) . More...

virtual void	make_assemblers_bdry_variable_data (const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	This function computes Local CG FEM based assemblers - variable data (boundary) . More...

Other make_ functions
virtual void	make_internal_cell_couplings ()
	This function fills out `internal_cell_couplings`. More...

virtual void	make_boundary_types ()
	This function fills out `boundary_types`. More...

virtual void	make_output_types ()
	This function fills out `output_types`. More...

Protected Member Functions inherited from FuelCellShop::Equation::EquationBase< dim >
	EquationBase (FuelCell::SystemManagement &sys_management, boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData > data=boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData >())
	Constructor. More...

virtual	~EquationBase ()
	Destructor. More...

virtual void	set_parameters (const std::vector< std::string > &name_dvar, const std::vector< double > &value_dvar, ParameterHandler &param)
	Set parameters using the parameter file, in order to run parametric/optimization studies. More...

void	select_cell_assemblers (const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	This routine is used to select the make_assembly routines that need to be called inside assemble_cell_matrix to compute. More...

virtual void	make_internal_flux_couplings ()
	This function fills out `internal_flux_couplings` (DG FEM only) of a derived equation class. More...

virtual void	make_component_materialID_value ()
	This function fills out `component_materialID_value` of a derived equation class. More...

virtual void	make_component_boundaryID_value ()
	This function fills out `component_boundaryID_value` of a derived equation class. More...

virtual void	make_multi_boundary_types ()
	This function fills out `multi_boundary_types` of a derived equation class. More...

virtual void	make_multi_output_types ()
	This function fills out `multi_output_types` of a derived equation class. More...

virtual void	make_matrix_block_indices ()
	This function is only needed to provide the last argument to dealII_to_appframe. More...

virtual void	make_residual_indices ()
	This function is only needed to provide the last argument to dealII_to_appframe. More...

virtual void	assemble_cell_Jacobian_matrix (FuelCell::ApplicationCore::MatrixVector &cell_matrices, const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble the local Jacobian Matrix for Non-Linear problems. More...

virtual void	assemble_bdry_Jacobian_matrix (FuelCell::ApplicationCore::MatrixVector &bdry_matrices, const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local Jacobian boundary matrix for Non-Linear problems. More...

virtual void	assemble_cell_linear_matrix (FuelCell::ApplicationCore::MatrixVector &cell_matrices, const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble the local cell matrix for Linear problems. More...

virtual void	assemble_cell_residual_rhs (FuelCell::ApplicationCore::FEVector &cell_residual, const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local cell RHS for nonlinear problems. More...

virtual void	assemble_cell_linear_rhs (FuelCell::ApplicationCore::FEVector &cell_residual, const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &cell_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local cell RHS for Linear problems. More...

virtual void	assemble_bdry_linear_matrix (FuelCell::ApplicationCore::MatrixVector &bdry_matrices, const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local boundary matrix for linear problems. More...

virtual void	assemble_bdry_linear_rhs (FuelCell::ApplicationCore::FEVector &bdry_residual, const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &bdry_info, FuelCellShop::Layer::BaseLayer< dim > *const layer)
	Assemble local boundary RHS for linear problems. More...

void	standard_to_block_wise (FullMatrix< double > &target) const
	This function changes the order of dealii::FullMatrix<double> `target` from standard to block-wise. More...

void	standard_to_block_wise (Vector< double > &target) const
	This function changes the order of dealii::Vector<double> `target` from standard to block-wise. More...

void	dealII_to_appframe (FuelCell::ApplicationCore::MatrixVector &dst, const FullMatrix< double > &src, const std::vector< unsigned int > &matrix_block_indices) const
	This function converts the standard ordered structure dealii::FullMatrix<double> `src` into the block-wise ordered structure FuelCell::ApplicationCore::MatrixVector `dst`. More...

void	dealII_to_appframe (FuelCell::ApplicationCore::FEVector &dst, const Vector< double > &src, const std::vector< unsigned int > &residual_indices) const
	This function converts the standard ordered structure dealii::Vector<double> `src` into the block-wise ordered structure FuelCell::ApplicationCore::FEVector `dst`. More...

bool	belongs_to_boundary (const unsigned int &tria_boundary_id, const unsigned int &param_boundary_id) const
	This function returns `true` if a boundary indicator of an external face on the triangulation coincides with a boundary indicator defined in the parameters file of a derived equation class. 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...

Protected Attributes
bool	cell_residual_counter
	Counter set to TRUE when `cell_residual` is being assembled. More...

bool	bdry_residual_counter
	Counter set to TRUE when `bdry_residual` is being assembled. More...

unsigned int	last_iter_cell
	Variable used to store the index in cell_info->global_data of the previous Newton solution The solution at the previous iteration is used to compute cell_matrix and cell_residual. More...

unsigned int	last_iter_bdry
	Variable used to store the index in bdry_info->global_data of the previous Newton solution The solution at the previous iteration is used to compute bdry_matrix and bdry_residual. More...

Boundary conditions
std::map< unsigned int, double >	dirichlet_bdry_map
	`std::map<` `unsigned` `int`, `double` > container for Dirichlet boundary conditions. More...

std::map< unsigned int, double >	proton_current_flux_map
	`std::map<` `unsigned` `int`, `double` > container for details regarding Galvanostatic boundary conditions. More...

Generic Constant Data
VariableInfo	phi_m
	VariableInfo structure corresponding to `"protonic_electrical_potential"`. More...

VariableInfo	lambda
	VariableInfo structure corresponding to `"membrane_water_content"`. More...

VariableInfo	t_rev
	VariableInfo structure corresponding to `"temperature_of_REV"`. More...

Local CG FEM based assemblers - variable data (cell)
std::vector< double >	sigmaMeff_cell
	Effective proton conductivity, [`S/cm`], at all quadrature points of the cell. More...

std::vector< double >	dsigmaMeff_dlambda_cell
	Derivative of effective protonic conductivity w.r.t. More...

std::vector< double >	dsigmaMeff_dT_cell
	Derivative of effective protonic conductivity w.r.t `"temperature_of_REV"`, at all quadrature points in the cell. More...

std::vector< std::vector < Tensor< 1, dim > > >	grad_phi_phiM_cell
	$\mathbf{\phi_m}$ shape function gradients. More...

std::vector< std::vector < double > >	phi_lambda_cell
	$\mathbf{\lambda}$ shape functions. More...

std::vector< std::vector < double > >	phi_T_cell
	$\mathbf{T}$ shape functions. More...

Local CG FEM based assemblers - variable data (boundary)
std::vector< std::vector < double > >	phi_phiM_bdry
	$\mathbf{\phi_{M}}$ shape functions. More...

Protected Attributes inherited from FuelCellShop::Equation::EquationBase< dim >
unsigned int	dofs_per_cell
	Number of degrees of freedom per cell. More...

unsigned int	n_q_points_cell
	Number of quadrature points per cell. More...

unsigned int	n_q_points_bdry
	Number of quadrature points per boundary. More...

DoFHandler< dim > ::active_cell_iterator	cell
	Currently active DoFHandler<dim> active cell iterator. More...

DoFHandler< dim > ::active_face_iterator	bdry
	Currently active DoFHandler<dim> active boundary iterator. More...

std::vector< double >	JxW_cell
	Jacobian of mapping by Weight in the quadrature points of a cell. More...

std::vector< double >	JxW_bdry
	Jacobian of mapping by Weight in the quadrature points of a boundary. More...

std::vector< Point< dim > >	normal_vectors
	Normal vectors in the quadrature points of a boundary. More...

std::vector< std::vector < Point< dim > > >	tangential_vectors
	Tangential vectors in the quadrature points of a boundary. More...

FuelCell::SystemManagement *	system_management
	Pointer to the external YourApplication<dim>::system_management object. More...

couplings_map	internal_cell_couplings
	This object contains the info on how the equations and solution variables of a derived equation class are coupled. More...

couplings_map	internal_flux_couplings
	This object contains the info on how the "X" and "Y" of a derived equation class are coupled (DG FEM only). More...

component_materialID_value_map	component_materialID_value
	This object reflects the following structure (see FuelCell::InitialAndBoundaryData namespace docs): More...

component_boundaryID_value_map	component_boundaryID_value
	This object reflects the following structure (see FuelCell::InitialAndBoundaryData namespace docs): More...

std::vector< BoundaryType >	boundary_types
	The list of boundary types of a derived equation class. More...

std::vector< std::vector < BoundaryType > >	multi_boundary_types
	The list of multiple boundary types of a derived equation class. More...

std::vector< OutputType >	output_types
	The list of output types of a derived equation class. More...

std::vector< std::vector < OutputType > >	multi_output_types
	The list of multiple output types of a derived equation class. More...

std::string	equation_name
	The name of a derived equation class. More...

std::string	name_base_variable
	Const std::string member storing name of the base solution variable corresponding to the equation represented by this class. More...

std::vector< unsigned int >	matrix_block_indices
	The system matrix block indices (a derived equation class) drawn from the global structure (a derived equation class + other active equation classes included into the computation). More...

std::vector< unsigned int >	residual_indices
	The residual indices (a derived equation class) drawn from the global structure (a derived equation class + other active equation classes included into the computation). More...

std::vector< bool >	counter
	This vector contains the collection of internal "counters" used by the derived equation classes. More...

EquationFlags	assemble_flags
	This vector contains a collection of internal flags to tell derived equation classes what needs to be re-computed. More...

boost::shared_ptr < FuelCell::ApplicationCore::ApplicationData >	data
	Data object for the application data to be passed to the equation classes. More...

std::string	solution_vector_name
	The name of the solution vector in FEVectors. More...

std::string	residual_vector_name
	The name of the residual vector name in FEVectors. More...

Additional Inherited Members
Public Attributes inherited from FuelCellShop::Equation::EquationBase< dim >
bool	variable_initial_data
	`true`, if variable initial data is prescribed on a part of the domain. More...

bool	variable_boundary_data
	`true`, if variable Dirichlet boundary conditions are prescribed on a part of the boundary. More...

Detailed Description

template<int dim>
class FuelCellShop::Equation::ProtonTransportEquation< dim >

This class deals with Proton Transport Equation.

This equation solves a steady-state Ohm's law for proton transport inside the polymer electrolyte. Note that Ohm's law can be used in the polymer electrolyte because electro-neutrality is assumed due to the constant number of negative ionic charges that are attached to the electrolyte. Due to electro-neutrality, convective and diffusive current terms in the Nernst-Planck Equation become negligible, hence it simplifies to Ohm's Law.

It is solved with respect to:

$\mathbf{\phi_{m}}$ (protonic_electrical_potential )

where, $\mathbf{\phi_{m}}$ is in Voltages.

This equation can be written as:

$\qquad \mathbf{\nabla} \cdot \left( \hat{\sigma}_{m,eff} \cdot \mathbf{\nabla} \phi_m \right) = 0 \quad \in \quad \Omega$

$\hat{\sigma}_{m,eff}$ is effective proton conductivity tensor [S/cm], which can be function of other variables, viz., $\lambda$ (membrane_water_content ) and (temperature_of_REV ).

To be well-posed, these equations are equipped with the appropriate boundary conditions. All the boundary conditions can be described by boundary_id (s ) and boundary_type. Besides, this some boundary types require additional information, which can also be provided by the parameter file. We consider several types of boundary conditions:

Dirichlet: At this boundary, we specify the $\mathbf{\phi_{m}}$ values using parameter file. It is to be noted that these dirichlet values at the boundary should be supplied to Initial Solution methods used in a particular application. These are specified in the parameter file under subsection "Dirichlet Boundary Conditions", as a list of comma-separated map-like values.

e.g.

set Dirichlet Boundary Conditions = 2: 0.5, 4: -0.7
Galvanostatic (Constant Proton Current Flux): A constant protonic current flux, [A/cm^2] is provided at the boundary. This value is provided using parameter file. If the value is positive, it implies that protonic current flux is leaving out of the boundary, otherwise negative implies entering into the boundary.

$\qquad - \mathbf{n} \cdot \left( \hat{\sigma}_{m,eff} \cdot \mathbf{\nabla} \phi_m \right) = C$

These are specified in the parameter file under subsection "Constant Proton Current Flux Boundary Conditions", as a list of comma-separated map-like values.

e.g.

set Constant Proton Current Flux Boundary Conditions = 1: 2 , 4: -0.5

where, boundary_id "1" has constant proton current flux value of 2 [A/cm^2] (leaving out of the boundary) and boundary_id "4" has constant proton current flux value of -0.5 [A/cm^2] (entering into the boundary).

No current flux (Insulated) / Symmetric: A particular case of Neumann boundary condition.

$\qquad - \mathbf{n} \cdot \left( \hat{\sigma}_{m,eff} \cdot \mathbf{\nabla} \phi_m \right) = 0$

Remarks

There is no provision to specify boundary indicators for No current flux or Symmetric boundary conditions, as FEM formulation automatically implies a particular boundary is one of these cases, by default.
This class works with the following layer classes only:
- FuelCellShop::Layer::CatalystLayer<dim>
- FuelCellShop::Layer::MembraneLayer<dim>

We solve the whole problem by linearizing the governing equation at each Newton iteration with subsequent CG FEM discretization in space. The class contains the necessary class members to add the necessary contributions to cell_matrix and cell_residual to the governing equations used to analyze proton transport by Ohm's law,

Usage Details:

* // Creating Equation object (in Application Header file)
* FuelCellShop::Equation::ProtonTransportEquation<dim> proton_transport;
*
* // Declare parameters in application
* proton_transport.declare_parameters(param);
*
* // Initialize in application
* proton_transport.initialize(param);
*
* // Create a temporary vector in the application for storing couplings_map from all the equation used in the application.
* std::vector<couplings_map> tmp;
* ... // other equations
* tmp.push_back( proton_transport.get_internal_cell_couplings() );
*
* // Look at ReactionSourceTerms class here, if source terms due to electrochemical reaction are to be considered.
* // Making cell couplings using SystemManagement object created in the application
* system_management.make_cell_couplings(tmp);
*
* // cell_matrix in application
* // Do a check against layer and it should match with the layers currently working for this equation class.
* // for eg: CCL is FuelCellShop::Layer::HomogeneousCL<dim> object.
* proton_transport.assemble_cell_matrix(cell_matrices, cell_info, &CCL);
*
* // cell_residual in application
* proton_transport.assemble_cell_residual(cell_vector, cell_info, &CCL);
* 

Note: This class doesn't assemble for reaction source terms; that is taken care off by ReactionSourceTerms class. Please read the documentation of ReactionSourceTerms class, for additional methods to be implemented in the application.

Warning: If current source terms due to reaction are being considered, it's very important to use adjust_internal_cell_couplings member function of ReactionSourceTerms class, before using make_cell_couplings of SystemManagement at the application level.

TODO Old Boundary conditions including Dirichlet Boundary Conditions and Constant Proton Current Flux Boundary Conditions are supposed to be replaced with the new subsections, see TO BE REMOVED comments in .cc file.

Author: Madhur Bhaiya, 2013; Valentin N. Zingan, 2012-2014 - afterward improvements, optimization, checkings, CG FEM bug fixings

Constructor & Destructor Documentation

template<int dim>

FuelCellShop::Equation::ProtonTransportEquation< dim >::ProtonTransportEquation	(	FuelCell::SystemManagement &	system_management,
		boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData >	data = `boost::shared_ptr< FuelCell::ApplicationCore::ApplicationData >()`
	)

Constructor.

template<int dim>

virtual FuelCellShop::Equation::ProtonTransportEquation< dim >::~ProtonTransportEquation ( )

virtual

Destructor.

Member Function Documentation

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::assemble_bdry_matrix	(	FuelCell::ApplicationCore::MatrixVector &	bdry_matrices,
		const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &	bdry_info,
		FuelCellShop::Layer::BaseLayer< dim > *const	layer
	)

virtual

Assemble local boundary matrix.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::assemble_bdry_residual	(	FuelCell::ApplicationCore::FEVector &	bdry_rhs,
		const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &	bdry_info,
		FuelCellShop::Layer::BaseLayer< dim > *const	layer
	)

virtual

Assemble local boundary residual.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::assemble_cell_matrix	(	FuelCell::ApplicationCore::MatrixVector &	cell_matrices,
		const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &	cell_info,
		FuelCellShop::Layer::BaseLayer< dim > *const	layer
	)

virtual

Assemble local cell matrix.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::assemble_cell_residual	(	FuelCell::ApplicationCore::FEVector &	cell_rhs,
		const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &	cell_info,
		FuelCellShop::Layer::BaseLayer< dim > *const	layer
	)

virtual

Assemble local cell residual.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

void FuelCellShop::Equation::ProtonTransportEquation< dim >::class_test ( )

This member function creates an object of its own type and runs test to diagnose if there are any problems with the routines that you have created.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::declare_parameters ( ParameterHandler & param ) const

virtual

Declare parameters.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

std::map<unsigned int, double> FuelCellShop::Equation::ProtonTransportEquation< dim >::get_dirichlet_bdry_map ( ) const

inline

Method to provide access to Dirichlet boundary conditions map filled using the parameter file.

This function is useful in accessing the dircihlet values to be set in initial conditions methods of the application.

References FuelCellShop::Equation::ProtonTransportEquation< dim >::dirichlet_bdry_map.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::initialize ( ParameterHandler & param )

virtual

Initialize parameters.

This class will call make_internal_cell_couplings and make_boundary_types.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_assemblers_bdry_constant_data ( const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo & bdry_info )

protectedvirtual

This function computes Local CG FEM based assemblers - constant data (boundary) and allocates the memory for shape functions, normal_vectors, and JxW_bdry in Local CG FEM based assemblers - variable data (boundary) .

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_assemblers_bdry_variable_data	(	const typename FuelCell::ApplicationCore::DoFApplication< dim >::FaceInfo &	bdry_info,
		FuelCellShop::Layer::BaseLayer< dim > *const	layer
	)

protectedvirtual

This function computes Local CG FEM based assemblers - variable data (boundary) .

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_assemblers_cell_constant_data ( const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo & cell_info )

protectedvirtual

This function computes Local CG FEM based assemblers - constant data (cell) and allocates the memory for shape functions, shape function gradients, and JxW_cell in Local CG FEM based assemblers - variable data (cell) .

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_assemblers_cell_variable_data	(	const typename FuelCell::ApplicationCore::DoFApplication< dim >::CellInfo &	cell_info,
		FuelCellShop::Layer::BaseLayer< dim > *const	layer
	)

protectedvirtual

This function computes Local CG FEM based assemblers - variable data (cell) .

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_assemblers_generic_constant_data ( )

protectedvirtual

This function computes Local CG FEM based assemblers - constant data (generic).

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_boundary_types ( )

protectedvirtual

This function fills out boundary_types.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_internal_cell_couplings ( )

protectedvirtual

This function fills out internal_cell_couplings.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::make_output_types ( )

inlineprotectedvirtual

This function fills out output_types.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

template<int dim>

virtual void FuelCellShop::Equation::ProtonTransportEquation< dim >::print_equation_info ( ) const

virtual

The function prints out the equation's info.

Reimplemented from FuelCellShop::Equation::EquationBase< dim >.

Member Data Documentation

template<int dim>

bool FuelCellShop::Equation::ProtonTransportEquation< dim >::bdry_residual_counter

protected

Counter set to TRUE when bdry_residual is being assembled.

This ensures that only data required for bdry_residual is computed. (improves speed)

template<int dim>

bool FuelCellShop::Equation::ProtonTransportEquation< dim >::cell_residual_counter

protected

Counter set to TRUE when cell_residual is being assembled.

This ensures that only effective protonic conductivity is being calculated, not its derivatives. (improves speed)

template<int dim>

std::map<unsigned int, double> FuelCellShop::Equation::ProtonTransportEquation< dim >::dirichlet_bdry_map

protected

std::map< unsigned int, double > container for Dirichlet boundary conditions.

Here, Key (unsigned int ) represents the boundary_id and Value (double) represents the potential [V] .

Referenced by FuelCellShop::Equation::ProtonTransportEquation< dim >::get_dirichlet_bdry_map().

template<int dim>

std::vector<double> FuelCellShop::Equation::ProtonTransportEquation< dim >::dsigmaMeff_dlambda_cell

protected

Derivative of effective protonic conductivity w.r.t.

"membrane_water_content", at all quadrature points in the cell.

template<int dim>

std::vector<double> FuelCellShop::Equation::ProtonTransportEquation< dim >::dsigmaMeff_dT_cell

protected

Derivative of effective protonic conductivity w.r.t "temperature_of_REV", at all quadrature points in the cell.

template<int dim>

std::vector< std::vector< Tensor<1,dim> > > FuelCellShop::Equation::ProtonTransportEquation< dim >::grad_phi_phiM_cell

protected

$\mathbf{\phi_m}$ shape function gradients.

grad_phi_phiM_cell [ q ] [ k ] denotes $ k $ -th $\mathbf{\phi_m}$ shape function gradient computed in $ q $ -th quadrature point of the cell.

template<int dim>

VariableInfo FuelCellShop::Equation::ProtonTransportEquation< dim >::lambda

protected

VariableInfo structure corresponding to "membrane_water_content".

template<int dim>

unsigned int FuelCellShop::Equation::ProtonTransportEquation< dim >::last_iter_bdry

protected

Variable used to store the index in bdry_info->global_data of the previous Newton solution The solution at the previous iteration is used to compute bdry_matrix and bdry_residual.

template<int dim>

unsigned int FuelCellShop::Equation::ProtonTransportEquation< dim >::last_iter_cell

protected

Variable used to store the index in cell_info->global_data of the previous Newton solution The solution at the previous iteration is used to compute cell_matrix and cell_residual.

template<int dim>

std::vector< std::vector<double> > FuelCellShop::Equation::ProtonTransportEquation< dim >::phi_lambda_cell

protected

$\mathbf{\lambda}$ shape functions.

phi_lambda_cell [ q ] [ k ] denotes $ k $ -th $\mathbf{\lambda}$ shape function computed in $ q $ -th quadrature point of the cell.

template<int dim>

VariableInfo FuelCellShop::Equation::ProtonTransportEquation< dim >::phi_m

protected

VariableInfo structure corresponding to "protonic_electrical_potential".

template<int dim>

std::vector< std::vector<double> > FuelCellShop::Equation::ProtonTransportEquation< dim >::phi_phiM_bdry

protected

$\mathbf{\phi_{M}}$ shape functions.

phi_phiM_bdry [ q ] [ k ] denotes $ k $ -th $\mathbf{\phi_{M}}$ shape function computed in $ q $ -th quadrature point of the boundary.

template<int dim>

std::vector< std::vector<double> > FuelCellShop::Equation::ProtonTransportEquation< dim >::phi_T_cell

protected

$\mathbf{T}$ shape functions.

phi_T_cell [ q ] [ k ] denotes $ k $ -th $\mathbf{T}$ shape function computed in $ q $ -th quadrature point of the cell.

template<int dim>

std::map<unsigned int, double> FuelCellShop::Equation::ProtonTransportEquation< dim >::proton_current_flux_map

protected

std::map< unsigned int, double > container for details regarding Galvanostatic boundary conditions.

Here, Key (unsigned int) represents the boundary_id and Value (double) represents the constant protonic current flux values [A/cm^2].

template<int dim>

std::vector<double> FuelCellShop::Equation::ProtonTransportEquation< dim >::sigmaMeff_cell

protected

Effective proton conductivity, [S/cm], at all quadrature points of the cell.

template<int dim>

VariableInfo FuelCellShop::Equation::ProtonTransportEquation< dim >::t_rev

protected

VariableInfo structure corresponding to "temperature_of_REV".

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

proton_transport_equation.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<int dim> class FuelCellShop::Equation::ProtonTransportEquation< dim >

Usage Details:

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<int dim>
class FuelCellShop::Equation::ProtonTransportEquation< dim >