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

This is a class for the layer does not contain PSD information. More...

#include <PSD_none.h>

Inheritance diagram for FuelCellShop::MicroScale::NonePSD< dim >:
Inheritance graph
[legend]
Collaboration diagram for FuelCellShop::MicroScale::NonePSD< dim >:
Collaboration graph
[legend]

Public Member Functions

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 get_saturation (std::vector< double > &S) const
 This function is used to compute the saturation by using PSD. More...
 
virtual void get_derivative_saturation (std::vector< double > &S) const
 
virtual void get_global_saturated_permeability (double &saturated_permeability) const
 This function is used to compute the saturated_permeability by using PSD. More...
 
virtual void get_relative_liquid_permeability (std::vector< double > &liquid_permeability) const
 This function is used to compute the liquid_permeability by using PSD. More...
 
virtual void get_derivative_relative_liquid_permeability (std::vector< double > &liquid_permeability) const
 This function is used to compute the liquid_permeability by using PSD. More...
 
virtual void get_relative_gas_permeability (std::vector< double > &gas_permeability) const
 This function is used to compute the gas_permeability by using PSD. More...
 
virtual void get_liquid_gas_interfacial_surface (std::vector< double > &HI_liquid_gas_interfacial_surface) const
 This function is used to compute the liquid_gas_interfacial_surface by using PSD. More...
 
virtual void get_derivative_liquid_gas_interfacial_surface (std::vector< double > &) const
 This function is used to compute the liquid_gas_interfacial_surface by using PSD. More...
 
virtual void get_wetted_wall_surface_area (std::vector< double > &wetted_wall_surface_area) const
 This function is used to compute the pore_wetted_wall by using PSD. More...
 
virtual void get_knudsen_radius (std::vector< double > &knudsen_radius) const
 This function is used to compute the knudsen_radius by using PSD. More...
 
virtual void get_diffusivity () const
 This function is used to compute the diffusivity by using PSD. More...
 
virtual void get_PSD_plot () const
 
- Public Member Functions inherited from FuelCellShop::MicroScale::BasePSD< dim >
virtual ~BasePSD ()
 Destructor. More...
 
void set_porosity (double porosity)
 
double get_porosity () const
 
void set_derivative_flags (const std::vector< VariableNames > &flags)
 Set the names of FCST solution variables with respect to which you would like to compute the derivatives of material properties. 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 psd depend on the solution, the solution for a given cell should be passed to the class using this member function. More...
 
virtual void set_temperature (const SolutionVariable &T_in)
 Member function used to set the temperature [Kelvin] at every quadrature point inside the cell. More...
 
virtual void set_capillary_pressure (const SolutionVariable &C_in)
 Member function used to set the capillary pressure [psi] at every quadrature point inside the cell. More...
 
virtual void set_critical_radius ()
 Member function used to set the critical radius [nm] at every quadrature point inside the cell. More...
 
virtual void get_PSD_plot ()
 This function is used to create PSD configuration plot by outputing all the numbers. More...
 
virtual void set_saturation ()
 Member function used to set the saturation at every quadrature point inside the cell. More...
 
virtual void initialize (ParameterHandler &param)
 Member function used to set the saturation at every quadrature point inside the cell. More...
 
const std::string & name_psd () const
 Return the name of the PSD. More...
 
virtual void print_psd_properties () const
 This function prints out the psd properties. More...
 

Protected Member Functions

Instance Delivery (Replica creator)
virtual boost::shared_ptr
< FuelCellShop::MicroScale::BasePSD
< dim > > 
create_replica (const std::string &psd_section_name)
 This member function is used to create an object of type psd. More...
 
- Protected Member Functions inherited from FuelCellShop::MicroScale::BasePSD< dim >
 BasePSD ()
 Constructor. More...
 
 BasePSD (const std::string &name)
 Constructor. More...
 
virtual void declare_parameters (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...
 

Static Protected Attributes

Instance Delivery (Prototype)
static NonePSD< dim > const * PROTOTYPE
 PROTOTYPE is the pointer is the dynamic pointer pointing to the NonePSD class itself. More...
 

Initalization

static const std::string concrete_name
 Concrete name used for objects of this class. More...
 
 NonePSD ()
 Consturctor. More...
 
 NonePSD (std::string name)
 Constructor. More...
 
 ~NonePSD ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FuelCellShop::MicroScale::BasePSD< dim >
static void declare_PSD_parameters (ParameterHandler &param)
 Function used to declare all the data necessary in the parameter files for all BasePSD children. More...
 
static boost::shared_ptr
< FuelCellShop::MicroScale::BasePSD
< dim > > 
create_PSD (const std::string &psd_section_name, ParameterHandler &param)
 Function used to select the appropriate CatalystLayer type as specified in the ParameterHandler under line. More...
 
- Protected Types inherited from FuelCellShop::MicroScale::BasePSD< dim >
typedef std::map< std::string,
BasePSD< dim > * > 
_mapFactory
 This object is used to store all objects of type psd. More...
 
- Static Protected Member Functions inherited from FuelCellShop::MicroScale::BasePSD< dim >
static _mapFactoryget_mapFactory ()
 Return the map library that stores all childrens of this class. More...
 
- Protected Attributes inherited from FuelCellShop::MicroScale::BasePSD< dim >
const std::string name
 Name of the psd. More...
 
std::vector< VariableNamesderivative_flags
 Flags for derivatives: These flags are used to request derivatives of material properties. More...
 
std::map< VariableNames, double > constant_solutions
 Map storing values of solution variables constant in a particular application. More...
 
double gamma
 The gamma is the Water-air interface surface tension. More...
 
double contact_angle
 The contact_angle is the contact angle between air and water. More...
 
double lamda
 The lamda is measured from the mercury intrusion experiment. More...
 
double F_HI
 The F_HI is the fraction of the total volume corresponding to the hydrophilic pores. More...
 
double F_HO
 The F_HO is the fraction of the total volume corresponding to the hydrophobic pores. More...
 
std::vector< double > f_k
 The f_k is the contribution of the log-normal distribution k to the total PSD. More...
 
std::vector< double > r_k
 The r_k is the characteristic pore size of the distribution k. More...
 
std::vector< double > s_k
 The s_k is the spread of the distribution k. More...
 
double por
 The por is the porosity inherited from the layer class. More...
 

Detailed Description

template<int dim>
class FuelCellShop::MicroScale::NonePSD< dim >

This is a class for the layer does not contain PSD information.

Author
J. Zhou

Marc Secanell

Date
2014

Constructor & Destructor Documentation

template<int dim>
FuelCellShop::MicroScale::NonePSD< dim >::NonePSD ( )

Consturctor.

template<int dim>
FuelCellShop::MicroScale::NonePSD< dim >::NonePSD ( std::string  name)

Constructor.

template<int dim>
FuelCellShop::MicroScale::NonePSD< dim >::~NonePSD ( )
inline

Destructor.

Member Function Documentation

template<int dim>
virtual boost::shared_ptr<FuelCellShop::MicroScale::BasePSD <dim> > FuelCellShop::MicroScale::NonePSD< dim >::create_replica ( const std::string &  psd_section_name)
inlineprotectedvirtual

This member function is used to create an object of type psd.

Reimplemented from FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
const std::type_info& FuelCellShop::MicroScale::NonePSD< dim >::get_base_type ( ) const
inlinevirtual

This member function returns a type_info object with the name of the base layer type the inherited class belongs to, i.e.

HIPSD HOPSD DualPSD

Note that this is necessary if we want to find out not the name of the actual class which can be obtain using

const std::type_info& name = typeid(*this)

but the name of the parent class.

Note
Do not re-implement this class in children classes

Reimplemented from FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_derivative_liquid_gas_interfacial_surface ( std::vector< double > &  ) const
inlinevirtual

This function is used to compute the liquid_gas_interfacial_surface by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_derivative_relative_liquid_permeability ( std::vector< double > &  ) const
inlinevirtual

This function is used to compute the liquid_permeability by using PSD.

Warning
This function is a virtual function and it must be reimplemented in the child class

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_derivative_saturation ( std::vector< double > &  S) const
inlinevirtual
template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_diffusivity ( ) const
inlinevirtual

This function is used to compute the diffusivity by using PSD.

This function contains no information, does not return anything.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_global_saturated_permeability ( double &  saturated_permeability) const
inlinevirtual

This function is used to compute the saturated_permeability by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_knudsen_radius ( std::vector< double > &  knudsen_radius) const
inlinevirtual

This function is used to compute the knudsen_radius by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_liquid_gas_interfacial_surface ( std::vector< double > &  HI_liquid_gas_interfacial_surface) const
inlinevirtual

This function is used to compute the liquid_gas_interfacial_surface by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_PSD_plot ( ) const
inlinevirtual
template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_relative_gas_permeability ( std::vector< double > &  gas_permeability) const
inlinevirtual

This function is used to compute the gas_permeability by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_relative_liquid_permeability ( std::vector< double > &  liquid_permeability) const
inlinevirtual

This function is used to compute the liquid_permeability by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_saturation ( std::vector< double > &  S) const
inlinevirtual

This function is used to compute the saturation by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

template<int dim>
virtual void FuelCellShop::MicroScale::NonePSD< dim >::get_wetted_wall_surface_area ( std::vector< double > &  wetted_wall_surface_area) const
inlinevirtual

This function is used to compute the pore_wetted_wall by using PSD.

This function contains no information, does not return anything.

Implements FuelCellShop::MicroScale::BasePSD< dim >.

Member Data Documentation

template<int dim>
const std::string FuelCellShop::MicroScale::NonePSD< 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

* set psd type = NonePSD # <-here I select the type of object of type psd
* subsection NonePSD # <- this is the concrete_name for this class
* set all info relevant to this object
* end
* end
*
template<int dim>
NonePSD<dim> const* FuelCellShop::MicroScale::NonePSD< dim >::PROTOTYPE
staticprotected

PROTOTYPE is the pointer is the dynamic pointer pointing to the NonePSD class itself.


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