FuelCellShop::Layer::Channel< dim > Class Template Reference

This class describes a channel and stores pointers to. More...

#include <channel.h>

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

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

Public Member Functions
Constructors, destructor, and initialization
	Channel (const std::string &name)
	Constructor. More...
	Channel (const std::string &name, FuelCellShop::Material::ExperimentalFluid &fluid)
	Constructor. More...
	Channel (const std::string &name, FuelCellShop::Material::GasMixture &gas_mixture)
	Constructor. More...
virtual	~Channel ()
	Destructor. More...
void	initialize (FuelCellShop::Material::ExperimentalFluid &rfluid)
	Initialize fluid. More...
void	initialize (FuelCellShop::Material::GasMixture &rgas_mixture)
	Initialize gas_mixture. More...
virtual void	declare_parameters (ParameterHandler &param) const
	Declare parameters. More...
virtual void	initialize (ParameterHandler &param)
	Initialize parameters. More...
Accessors and info
const FuelCellShop::Material::ExperimentalFluid *const	get_fluid () const
	This function returns fluid. More...
const FuelCellShop::Material::GasMixture *const	get_gas_mixture () const
	This function returns gas_mixture. More...
const double &	get_roughness () const
	This function returns roughness [cm]. More...
const Tensor< 2, dim > &	get_effective_electronic_conductivity () const
	This function returns effective_electronic_conductivity [S/cm]. More...
const std::type_info &	get_base_type () const
	This function returns typeid of this class. More...
virtual void	print_layer_properties () const
	This function prints out the layer properties. 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...

Protected Attributes
Layer properties
FuelCellShop::Material::ExperimentalFluid *	fluid
FuelCellShop::Material::GasMixture *	gas_mixture
	Gas mixture. More...
double	roughness
	Roughness, cm. More...
Tensor< 2, dim >	effective_electronic_conductivity
	Effective electronic conductivity, . 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...

Additional Inherited Members
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	declare_parameters (const std::string &object_name, ParameterHandler &param) const
	Declare parameters for a parameter file. 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...

Detailed Description

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

This class describes a channel and stores pointers to.

• ExperimentalFluid object,
• GasMixture object.

This class also stores the roughness of the channel walls and effective electronic conductivity of solid plates.

The functionality of this class can be extended if needed.

Author

Valentin N. Zingan, 2012

Constructor & Destructor Documentation

template<int dim>

FuelCellShop::Layer::Channel< dim >::Channel

(

const std::string &

name

)

Constructor.

template<int dim>

FuelCellShop::Layer::Channel< dim >::Channel	(	const std::string &	name,
		FuelCellShop::Material::ExperimentalFluid &	fluid
	)

Constructor.

template<int dim>

FuelCellShop::Layer::Channel< dim >::Channel	(	const std::string &	name,
		FuelCellShop::Material::GasMixture &	gas_mixture
	)

Constructor.

template<int dim>

virtual FuelCellShop::Layer::Channel< dim >::~Channel ( )

virtual

Destructor.

Member Function Documentation

template<int dim>

virtual void FuelCellShop::Layer::Channel< dim >::declare_parameters ( ParameterHandler &  param ) const

virtual

Declare parameters.

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

template<int dim>

const std::type_info& FuelCellShop::Layer::Channel< dim >::get_base_type ( ) const

inlinevirtual

This function returns typeid of this class.

All classes derived from this class must share the same typeid for dynamic swapping.

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

template<int dim>

const Tensor<2,dim>& FuelCellShop::Layer::Channel< dim >::get_effective_electronic_conductivity ( ) const

inline

This function returns effective_electronic_conductivity [S/cm].

References FuelCellShop::Layer::Channel< dim >::effective_electronic_conductivity.

template<int dim>

const FuelCellShop::Material::ExperimentalFluid* const FuelCellShop::Layer::Channel< dim >::get_fluid ( ) const

inline

This function returns fluid.

References FuelCellShop::Layer::Channel< dim >::fluid.

template<int dim>

const FuelCellShop::Material::GasMixture* const FuelCellShop::Layer::Channel< dim >::get_gas_mixture ( ) const

inline

This function returns gas_mixture.

References FuelCellShop::Layer::Channel< dim >::gas_mixture.

template<int dim>

const double& FuelCellShop::Layer::Channel< dim >::get_roughness ( ) const

inline

This function returns roughness [cm].

References FuelCellShop::Layer::Channel< dim >::roughness.

template<int dim>

void FuelCellShop::Layer::Channel< dim >::initialize ( FuelCellShop::Material::ExperimentalFluid &  rfluid )

inline

Initialize fluid.

template<int dim>

void FuelCellShop::Layer::Channel< dim >::initialize ( FuelCellShop::Material::GasMixture &  rgas_mixture )

inline

Initialize gas_mixture.

template<int dim>

virtual void FuelCellShop::Layer::Channel< dim >::initialize ( ParameterHandler &  param )

virtual

Initialize parameters.

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

template<int dim>

virtual void FuelCellShop::Layer::Channel< dim >::print_layer_properties ( ) const

virtual

This function prints out the layer properties.

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

Member Data Documentation

template<int dim>

Tensor<2,dim> FuelCellShop::Layer::Channel< dim >::effective_electronic_conductivity

protected

Effective electronic conductivity, .

Referenced by FuelCellShop::Layer::Channel< dim >::get_effective_electronic_conductivity().

template<int dim>

FuelCellShop::Material::ExperimentalFluid* FuelCellShop::Layer::Channel< dim >::fluid

protected

• incompressible,
• isothermal,
• single-phase,
• single-component

fluid.

Referenced by FuelCellShop::Layer::Channel< dim >::get_fluid().

template<int dim>

FuelCellShop::Material::GasMixture* FuelCellShop::Layer::Channel< dim >::gas_mixture

protected

Gas mixture.

Referenced by FuelCellShop::Layer::Channel< dim >::get_gas_mixture().

template<int dim>

double FuelCellShop::Layer::Channel< dim >::roughness

protected

Roughness, cm.

Referenced by FuelCellShop::Layer::Channel< dim >::get_roughness().

---

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

• channel.h