FuelCellShop::Equation Namespace Reference

Namespace to hold classes that describe physical processes in fuel cells. More...

Namespaces
	DebugTools

Classes
class	CapillaryPressureEquation
class	CompressibleMultiComponentKGEquationsCoupled
	This class implements the multi-component mass transport equations proposed by Kerkhof-Geboers for fluid transport. More...
class	ElectronTransportEquation
	This class deals with Electron Transport Equation. More...
struct	VariableInfo
	This simple structure stores certain information regarding a particular variable for the equation (all of them retrieved from #SystemManagement). More...
struct	EquationFlags
	Enumeration for flags used in equation classes to control assembly. More...
struct	BoundaryType
	This structure describes a boundary type of a derived equation class. More...
struct	OutputType
	This structure describes an output type of a derived equation class. More...
class	EquationBase
	This is the base class used for all Equation classes. More...
class	FicksTransportEquation
	This class deals with Fick's Transport Equation. More...
class	IncompressibleSingleComponentNSEquations
	This class deals with Navier-Stokes fluid transport equations. More...
class	LambdaTransportEquation
	This class deals with Membrane Water Content Transport Equation. More...
class	LiquidPressureEquation
	This class implements a mass conservation equation for liquid transport in a fuel cell porous media. More...
class	LiquidSourceEquation
	This class implements a liquid water condensation and evaporation term. More...
class	NewFicksTransportEquation
	This class deals with Ficks Transport Equation. More...
class	ProtonTransportEquation
	This class deals with Proton Transport Equation. More...
class	ReactionHeat
	This class is used to compute non-linear reaction heat source terms in a catalyst layer. More...
class	ReactionSourceTerms
	This class assembles the reaction source terms for all other transport equations, if there's any. More...
class	ReactionSourceTermsBase
	This class assembles the reaction source terms for all other transport equations, if there's any. More...
class	ReactionSourceTermsKG
	This class assembles the reaction source terms for all other transport equations, if there's any. More...
class	SaturationTransportEquation
	This class deals with Liquid Water Saturation Transport Equation. More...
class	SorptionSourceTerms
	This class assembles source terms corresponding to sorption/desorption of water inside the catalyst layer. More...
class	ThermalTransportEquation
	This class deals with Thermal Transport Equation. More...

Functions
Exceptions
	DeclException2 (VariableShouldExistForEquation, std::string, std::string,<< "The user-defined variable with name \""<< arg1<< "\" should be one of the solution variables for equation with name \""<< arg2<< "\"")
	Exception thrown when a particular variable required by the equation class, does not exist in the user defined solution variables. More...
	DeclException2 (IndexDoNotMatch, std::string, std::string,<< "The index of variable \""<< arg1<< "\" do not match with the index of equation \""<< arg2<< "\"")
	Exception thrown when index of the user defined equation do not match with the index of the base variable for the equation. More...
	DeclException2 (VariableNotFoundForKinetics, std::string, std::string,<< "For "<< arg1<< " kinetics source terms, \""<< arg2<< "\" is not found as one of the solution variables.")
	Exception thrown when a particular "Required" solution variable is not found for cathode or anode kinetics, in user-defined solution variables. More...
	DeclException2 (VariableNotFoundForSorption, std::string, std::string,<< arg1<< " should be one of the solution variables, in order to account for "<< arg2<< " .")
	Exception thrown when a particular "Required" solution variable is not found for sorption source terms, in user-defined solution variables. More...
	DeclException2 (VariableNotFoundForOhmicHeat, std::string, std::string,<< "For "<< arg1<< " ohmic heating source term set as True, \""<< arg2<< "\" is not found as one of the solution variables.")
	Exception thrown when ohmic heating (Protonic or Electronic) is set to TRUE, but respective solution variables, or , are not declared as user solution variables. More...

Detailed Description

Namespace to hold classes that describe physical processes in fuel cells.

This namespace should be used to take objects from the layer classes, compute the coefficients for the physical equations, and assemble the matrices and residuals.

Function Documentation

FuelCellShop::Equation::DeclException2	(	VariableNotFoundForSorption	,
		std::string	,
		std::string	,
		<< arg1<< " should be one of the solution	variables,
		in order to account for"<< arg2<< "."
	)

Exception thrown when a particular "Required" solution variable is not found for sorption source terms, in user-defined solution variables.

FuelCellShop::Equation::DeclException2	(	VariableNotFoundForOhmicHeat	,
		std::string	,
		std::string	,
		<< "For "<< arg1<< " ohmic heating source term set as	True,
		\""<< arg2<< "\" is not found as one of the solution variables."
	)

Exception thrown when ohmic heating (Protonic or Electronic) is set to TRUE, but respective solution variables, or , are not declared as user solution variables.

FuelCellShop::Equation::DeclException2	(	VariableNotFoundForKinetics	,
		std::string	,
		std::string	,
		<< "For "<< arg1<< " kinetics source	terms,
		\""<< arg2<< "\" is not found as one of the solution variables."
	)

Exception thrown when a particular "Required" solution variable is not found for cathode or anode kinetics, in user-defined solution variables.

FuelCellShop::Equation::DeclException2	(	VariableShouldExistForEquation	,
		std::string	,
		std::string	,
		<< "The user-defined variable with name \""<< arg1<< "\" should be one of the solution variables for equation with name \""<< arg2<< "\""
	)

Exception thrown when a particular variable required by the equation class, does not exist in the user defined solution variables.

FuelCellShop::Equation::DeclException2	(	IndexDoNotMatch	,
		std::string	,
		std::string	,
		<< "The index of variable \""<< arg1<< "\" do not match with the index of equation \""<< arg2<< "\""
	)

Exception thrown when index of the user defined equation do not match with the index of the base variable for the equation.