FuelCellShop::Material::BaseMaterial Class Reference

Virtual class used to provide the interface for all material classes. More...

#include <base_material.h>

Inheritance diagram for FuelCellShop::Material::BaseMaterial:

Collaboration diagram for FuelCellShop::Material::BaseMaterial:

Public Member Functions
Initalization
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...
Accessors and info
const std::string &	name_material () const
	Return the name of the layer. More...
virtual void	print_material_properties () const
	This function prints out the material properties. More...

Protected Member Functions
Constructors, destructor, and parameter initalization
	BaseMaterial ()
	Constructor. More...
	BaseMaterial (const std::string &name)
	Constructor. More...
virtual	~BaseMaterial ()
	Destructor. More...
virtual void	declare_parameters (ParameterHandler &) const
	Declare parameters for a parameter file. More...
virtual void	initialize (ParameterHandler &)
	Member function used to read in data and initialize the necessary data to compute the coefficients. More...

Protected Attributes
Internal variables
const std::string	name
	Name of the layer. More...
std::vector< VariableNames >	derivative_flags
	Flags for derivatives: These flags are used to request derivatives of material properties. More...

Detailed Description

Virtual class used to provide the interface for all material classes.

No object of type BaseMaterial should ever be created.

Todo:

create a proper tree for materials. I think it should go, material_base, then childs: electrolyte, catalyst support, catalyst (...)

Author

Secanell

Bhaiya

Zingan

Constructor & Destructor Documentation

FuelCellShop::Material::BaseMaterial::BaseMaterial ( )

inlineprotected

Constructor.

FuelCellShop::Material::BaseMaterial::BaseMaterial ( const std::string &  name )

inlineprotected

Constructor.

Deprecated:

Material classes should not take any string. The string is not used for anything.

virtual FuelCellShop::Material::BaseMaterial::~BaseMaterial ( )

inlineprotectedvirtual

Destructor.

Member Function Documentation

virtual void FuelCellShop::Material::BaseMaterial::declare_parameters ( ParameterHandler &  ) const

inlineprotectedvirtual

Declare parameters for a parameter file.

Warning

This is a PureFunction and it does not declare anything, so please do not call this function in the children.

Reimplemented in FuelCellShop::Material::DummySolid, FuelCellShop::Material::PolymerElectrolyteBase, FuelCellShop::Material::Graphite, FuelCellShop::Material::CatalystBase, FuelCellShop::Material::PureSolid, FuelCellShop::Material::CatalystSupportBase, FuelCellShop::Material::Nafion, FuelCellShop::Material::CarbonBlack, FuelCellShop::Material::GasMixture, FuelCellShop::Material::PureGas, FuelCellShop::Material::Platinum, FuelCellShop::Material::LiquidWater, FuelCellShop::Material::MaterialPlateBase, FuelCellShop::Material::ExperimentalFluid, FuelCellShop::Material::ExperimentalMultiFluid, FuelCellShop::Material::MaterialPlateGraphite, FuelCellShop::Material::ExperimentalSolid, FuelCellShop::Material::FiberBase, and FuelCellShop::Material::CarbonFiber.

References FcstUtilities::log.

Referenced by FuelCellShop::Material::FiberBase::declare_parameters(), and FuelCellShop::Material::MaterialPlateBase::declare_parameters().

Here is the caller graph for this function:

virtual void FuelCellShop::Material::BaseMaterial::initialize ( ParameterHandler &  )

inlineprotectedvirtual

Member function used to read in data and initialize the necessary data to compute the coefficients.

Warning

This is a PureFunction and it does not initialize anything, so please do not call this function in the children.

Reimplemented in FuelCellShop::Material::DummySolid, FuelCellShop::Material::PolymerElectrolyteBase, FuelCellShop::Material::Graphite, FuelCellShop::Material::CatalystBase, FuelCellShop::Material::PureSolid, FuelCellShop::Material::CatalystSupportBase, FuelCellShop::Material::Nafion, FuelCellShop::Material::CarbonBlack, FuelCellShop::Material::GasMixture, FuelCellShop::Material::PureGas, FuelCellShop::Material::Platinum, FuelCellShop::Material::LiquidWater, FuelCellShop::Material::MaterialPlateBase, FuelCellShop::Material::ExperimentalFluid, FuelCellShop::Material::ExperimentalMultiFluid, FuelCellShop::Material::MaterialPlateGraphite, FuelCellShop::Material::ExperimentalSolid, FuelCellShop::Material::FiberBase, and FuelCellShop::Material::CarbonFiber.

References FcstUtilities::log.

Referenced by FuelCellShop::Material::FiberBase::initialize(), and FuelCellShop::Material::MaterialPlateBase::initialize().

Here is the caller graph for this function:

const std::string& FuelCellShop::Material::BaseMaterial::name_material ( ) const

inline

Return the name of the layer.

Referenced by FuelCellShop::Equation::NewFicksTransportEquation< dim >::set_solute_and_solvent(), and FuelCellShop::Equation::FicksTransportEquation< dim >::set_solute_and_solvent().

Here is the caller graph for this function:

virtual void FuelCellShop::Material::BaseMaterial::print_material_properties ( ) const

inlinevirtual

This function prints out the material properties.

Reimplemented in FuelCellShop::Material::GasMixture, FuelCellShop::Material::ExperimentalMultiFluid, and FuelCellShop::Material::ExperimentalFluid.

References FcstUtilities::log.

void FuelCellShop::Material::BaseMaterial::set_derivative_flags ( const std::vector< VariableNames > &  flags )

inline

Set the names of FCST solution variables with respect to which you would like to compute the derivatives of material properties.

Member Data Documentation

std::vector<VariableNames> FuelCellShop::Material::BaseMaterial::derivative_flags

protected

Flags for derivatives: These flags are used to request derivatives of material properties.

const std::string FuelCellShop::Material::BaseMaterial::name

protected

Name of the layer.

This value is used as a header in a subsection for the parameter file where all the information concerning this layer is held.

Referenced by FuelCellShop::Material::Platinum::set_reaction_kinetics().

---

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

• base_material.h