#include <MultiReactionElectrochemical.h>

Inheritance diagram for MultiReactionElectrochemical:

[legend]

Public Member Functions
	MultiReactionElectrochemical (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency persistency=nullptr, Persistent parent=nullptr, Persistent *root=nullptr)

	QUANTITY (action, "Cell action 1 for fuelcell and -1 for electrolyzers", 1.0, "")

	QUANTITY (Teq, "Equilibrium temperature", 298.15, "K")

	QUANTITY (Tact, "Actual temperature", 298.15, "K")

	QUANTITY (deltaT, "Temperature approach to equilibrium", 0.0, "K")

	QUANTITY (Kin, "Equilibrium constant at inlet stream compositions", 1.0, "")

	QUANTITY (Kout, "Equilibrium constant at outlet stream compositions", 1.0, "")

	QUANTITY (H, "Cell length", 0.595, "m")

	QUANTITY (W, "Cell width", 1.195, "m")

	QUANTITY (A, "Cell area", 0.0, "m2")

	QUANTITY (nCells, "Number of cells in a stack", 40.0, "")

	QUANTITY (E0, "Thermodynamic voltage", 0.0, "V")

	QUANTITY (E, "Open circuit voltage OCV", 0.0, "V")

	QUANTITY (Rarea, "Areic electrical resistance", 0.0, "ohm*m2")

	QUANTITY (F, "Faraday constant", 96485339.9, "C/kmol")

	QUANTITY (J, "Average value of current density", 0.0, "A/m2")

	QUANTITY (Jset, "Set current density used if J option", 0.0, "A/m2")

	QUANTITY (I, "Current", 1.0, "A")

	QUANTITY (Iset, "Set current used if I option", 0.0, "A")

	QUANTITY (Voffset, "Correction to cell voltage to account for the effect of the microscale", 0.0, "V")

	QUANTITY (V, "Cell voltage", 0.0, "V")

	QUANTITY (Vset, "Set cell voltage used if V option", 0.0, "V")

	QUANTITY (Vstack, "Stack voltage", 0.0, "V")

	QUANTITY (Power, "Stack net power output", 1.0, "W")

	QUANTITY (PowerDensity, "Stack areic power density", 0.0, "W/m2")

	STRING (option, "Calculation option", "z")

	STRING (averageOption, "Composition average option", "log")

Value	calceqconst (const Value &P0, const Value &P1, const Vector &x0, const Vector &x1)

virtual void	calcE0 (const Value &P0, const Value &P1, const Vector &x0, const Vector &x1)=0

void	calculateEquilibrium (const Value &P0, const Value &P1)

const std::string &	type (void) const override

Public Member Functions inherited from MultiReaction< 2 >
	MultiReaction (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency persistency=nullptr, Persistent parent=nullptr, Persistent *root=nullptr)

	INTEGER (nPhases, "Number of reacting phases", -1)

	INTEGER (keyphase, "Phase the key component is located in", -1)

	INTEGER (keycomp, "Key component", -1)

	QUANTITY (z, "Set fractional conversion in terms of key component", 0.0, "")

	QUANTITY (actz, "Actual fractional conversion in terms of key component", 0.0, "")

	QUANTITY (conv, "Rate of Reaction", 0.0, "kmol/s")

	~MultiReaction (void)

ObjectiveNleAd *	objectiveFunction (void) override
	returns a pointer to the model's objective function More...

void	initializeNonPersistents (void) override
	estimates hidden, non-persistent unknowns from the current results More...

void	calculate (int level=0) override

void	setup (void) override
	performs initializations required immediately before solution More...

const std::string &	type (void) const override

Libpf::Utility::Category	category (void) const override
	return model Category More...

Public Member Functions inherited from Model
	Model (Libpf::Persistency::Defaults defaults, uint32_t id, Persistency persistency, Persistent parent, Persistent *root)

	INTEGER (nCalculations, "Number of times the model has been calculated", 0)

	STRINGVECTOR (errors, "Errors from the last computation", 0, "")

	STRINGVECTOR (warnings, "Warnings from the last computation", 0, "")

bool	isPristine (void) const

void	unSetInput (void)
	wipes out all tags marked as inputs More...

void	reportMessages (void)
	recursively collect status of all sub-objects and report to parent More...

void	resetErrors (void)

void	setWarning (std::string s)
	send new warning message to local queue More...

void	setError (std::string s)
	send new error message to local queue More...

void	reportWarning (std::string s)
	propagate warning message from sub-object to local queue More...

void	reportError (std::string s)
	propagate error message from sub-object to local queue More...

void	setCalculated (void)
	increments nCalculations counter and unsets pristinity More...

void	setPristineRecursive (void)
	force next calculation to restart as if the model had never been calculated during this runtime session, also for all contained objects More...

void	setPristine (void)
	force next calculation to restart as if the model had never been calculated during this runtime session More...

void	setRunTime (double t)
	set the run time More...

virtual Libpf::Utility::Category	category (void) const =0
	return model Category More...

virtual void	calculate (int level=0)=0

virtual void	setup (void)=0
	performs initializations required immediately before solution More...

virtual int	maximumIterations (void)
	returns default maximum iterations for main computation; defaults to 200 More...

virtual void	initializeNonPersistents (void)=0
	estimates hidden, non-persistent unknowns from the current results More...

virtual ObjectiveNleAd *	objectiveFunction (void)=0
	returns a pointer to the model's objective function More...

std::ostream &	print (std::ostream &os, bool strings, bool quantities, bool integers, bool recursive) const

std::ostream &	printFull (std::ostream &) const
	print the model quantities, including derivative info, in text format to os More...

void	printHtml (const char *dir) const

virtual void	printSvg (const char *fileName, bool tiny, bool raster, int offset)

void	printSvgAll (const char *dir, bool tiny, bool raster, int offset, std::vector< std::string > &list)
	Recursively output the model and all descendants in SVG format as separate id.SVG files in the directory dir. More...

virtual void	printXml (const char dir, Model precedingSibling, Model *followingSibling) const

void	printXmlToc (std::ofstream &toc, int indent) const

void	printOds (std::ofstream &ods) const

Public Member Functions inherited from Object
	Object (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency persistency=nullptr, Persistent parent=nullptr, Persistent *root=nullptr)

Libpf::Persistency::Defaults	defaults (void) const

std::ostream &	printJson (std::ostream &os, int level=0) const override
	print Node in JSON format More...

void	readVariables (Persistency *persistency) override
	reads Q, QV and QM from persistency More...

void	readParameters (Persistency *persistency) override
	reads I, IV, S and SV from persistency More...

Node &	operator= (const Node &) override
	copy assignment operator More...

Node &	operator= (Node &&other) override
	move assignment More...

	~Object (void)

const std::string &	type (void) const override

Object &	at (const std::string &fullRelativeTag)

const Object &	at (const std::string &fullRelativeTag) const

Object &	at (const std::string &fullRelativeTag, int index)

const Value &	Q (const std::string &tag) const

const Value &	Q (const std::string &tag, int index) const

const Value &	Q (const std::string &tag, int row, int column) const

Value &	Q (const std::string &tag)

Value &	Q (const std::string &tag, int index)

Value &	Q (const std::string &tag, int row, int column)

const Value &	Q (const std::string &tag, std::string componentName) const

Value &	Q (const std::string &tag, std::string componentName)

const Value &	Q (const std::string &tag, int index, std::string componentName) const

Value &	Q (const std::string &tag, int index, std::string componentName)

const int &	I (const std::string &tag) const

const int &	I (const std::string &tag, int index) const

int &	I (const std::string &tag)

int &	I (const std::string &tag, int index)

const std::string &	S (const std::string &tag) const

const std::string &	S (const std::string &tag, int index) const

std::string &	S (const std::string &tag)

std::string &	S (const std::string &tag, int index)

bool	operator!= (const Object &rhs) const

bool	operator== (const Object &rhs) const

bool	compareParameters (const Object &rhs) const

bool	existsI (const std::string &tag) const

bool	existsS (const std::string &tag) const

bool	existsQ (const std::string &tag) const

void	push (void) const
	store the current status of the object and all its sub-objects in the last-in-first-out queue of real variables values More...

void	pop (void)
	restore the status of the object and all its sub-objects from the last-in-first-out queue of real variables values More...

void	clear (void) const
	clear the last-in-first-out queue of real variables values used for storing and retrieving the status More...

const RangeQuantities	quantities (void)

const ConstRangeQuantities	quantities (void) const

Public Member Functions inherited from Node
	Node (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency persistency=nullptr, Persistent parent=nullptr, Persistent *root=nullptr)

	Node (const Node &other)
	copy constructor More...

	Node (Node &&other)
	move constructor More...

virtual std::unique_ptr< Node >	clone (void) const

virtual Node &	operator= (const Node &other)
	copy assignment operator copies all elements but root which is set to nullptr More...

virtual Node &	operator= (Node &&other)
	move assignment More...

	~Node ()

int	insert (Persistency *persistency) const override

int	update (Persistency *persistency) const override

void	restore (Persistency *persistency) override

void	remove (Persistency *persistency) const override

uint32_t	rootId (void) const override

uint32_t	range (void) const override

uint32_t	getId (void) override
	returns the next available id and increments the internal counter More...

const std::string &	type (void) const override

virtual std::ostream &	printJson (std::ostream &os, int level=0) const
	print Node in JSON format More...

Node &	addChild (std::string type, uint32_t id, Persistency *persistency)

Node &	addChild (std::string type, Libpf::Persistency::Defaults defaults)

Node &	addChild (const Node &child)

Node &	addChild (std::unique_ptr< Node > child)

std::unique_ptr< Node >	prune (const std::string &tag)

const Node &	child (const std::string &tag) const

Node &	at (const std::string &fullRelativeTag)

const Node &	at (const std::string &fullRelativeTag) const

uint32_t	descendants (void) const

Persistent *	root (void) const

void	renameChild (const std::string &oldName, const std::string &newName)

bool	existsChild (std::string tag) const

bool	exists (uint32_t id)

Node &	search (uint32_t id)

bool	operator!= (const Node &rhs) const

bool	operator== (const Node &rhs) const

virtual void	readVariables (Persistency *)
	reads Q, QV and QM from persistency More...

virtual void	readParameters (Persistency *)
	reads I, IV, S and SV from persistency More...

bool	isRestored (void) const
	return whether the Node has just been retrieved from persistent storage More...

void	setIcon (std::string icon, double width, double height)

bool	hasIcon (void) const

std::string	iconName (bool raster) const

double	iconWidth (void) const

double	iconHeight (void) const

const Range	children (void)

const ConstRange	children (void) const

Public Member Functions inherited from Persistent
	Persistent (const std::string &tag, const std::string &description, Persistent *parent, uint32_t id)
	main constructor More...

	Persistent (const Persistent &)
	copy constructor More...

Persistent &	operator= (const Persistent &)
	copy assignment More...

	Persistent (Persistent &&other)
	move constructor More...

Persistent &	operator= (Persistent &&other)
	move assignment More...

	~Persistent (void)

uint32_t	id (void) const

std::string	uuid (void) const

uint32_t	parentId (void) const

virtual uint32_t	rootId (void) const =0

virtual uint32_t	range (void) const =0

virtual uint32_t	getId (void)=0
	returns the next available id and increments the internal counter More...

double	created_at (void) const

double	updated_at (void) const

void	updated_at (double u) const

virtual int	insert (Persistency *persistency) const =0

virtual int	update (Persistency *persistency) const =0

virtual void	restore (Persistency *persistency)=0

virtual void	remove (Persistency *persistency) const =0

Public Member Functions inherited from Item
	Item (const Item &other)
	copy constructor copies all elements but parent which is set to nullptr More...

Item &	operator= (const Item &other)
	copy assignment operator copies all elements but parent which is set to nullptr More...

	Item (const std::string &tag, const std::string &description, Persistent *parent)

	Item (Item &&other)
	move constructor More...

Item &	operator= (Item &&other)
	move assignment operator More...

virtual	~Item ()

const std::string &	tag () const

const std::string &	description () const

std::string	fullTag () const

const Persistent *	parent () const

virtual const std::string &	type () const =0

void	setTag (const std::string &tag)

void	setDescription (const std::string &description)

void	setWideTag (const std::wstring &tag)
	wide-character variant, More...

void	setWideDescription (const std::wstring &description)
	wide-character variant, More...

bool	operator!= (const Item &rhs) const

bool	operator== (const Item &rhs) const

Public Member Functions inherited from Diagnostic
	Diagnostic (void)

void	setVerbosity (int verbosity)
	sets the verbosity level for this instance More...

int	verbosity (void) const

Static Public Attributes
static const std::string	type_

Static Public Attributes inherited from MultiReaction< 2 >
static const std::string	type_

Additional Inherited Members
Public Attributes inherited from MultiReaction< 2 >
std::vector< Phase::Mass * >	outp
	Vector of reacting phase pointers. More...

std::vector< PhaseTotal >	phases
	Vector of phases containing component fluxes entering each reacting phase. More...

std::vector< std::vector< Quantity > >	coeffv
	Vector of vectors of stoichiometric coefficients for each reacting phase. More...

Protected Member Functions inherited from Model
void	printSvgXlink (std::ostream &svg, const std::string &link, double width, double height)

void	addComponentVectorVariable (std::vector< Quantity > &variable, const std::string &tag, const std::string &description, Quantity::ValueType value)

template<typename T >
void	addSubObjects (int verbosityFile, Libpf::Persistency::Defaults defaults, Persistency persistency, int count, const std::string &optionKey, const std::string &typeKey, const std::string &tagKey, const std::string &description, std::vector< T > &vector)

Protected Member Functions inherited from Object
int	retrieveInteger (const Libpf::Persistency::Defaults &defaults, uint32_t id, Persistency *persistency, std::string tag, int min, int max, int def=-1)

std::string	retrieveString (const Libpf::Persistency::Defaults &defaults, uint32_t id, Persistency *persistency, std::string tag, const std::string def)

template<class T >
void	addVariable (T &variable)

template<class T >
void	addVectorVariable (std::vector< T > &variable, const std::string &tag, const std::string &description, uint32_t size, typename T::ValueType value)

	Object (const Object &other)
	copy constructor More...

	Object (Object &&other)
	move constructor More...

Object &	operator= (const Object &)
	copy assignment operator More...

Object &	operator= (Object &&other)
	move assignment operator More...

Protected Member Functions inherited from Node
int	offset (void) const

Protected Member Functions inherited from Diagnostic
virtual	~Diagnostic ()=default

Protected Attributes inherited from Object
std::map< std::string, Integer * >	integers_
	collection of integer variables More...

std::map< std::string, IntegerVector * >	integerVectors_
	collection of integer variable vectors More...

std::map< std::string, Quantity * >	quantities_
	collection of real variables More...

std::map< std::string, QuantityVector * >	quantityVectors_
	collection of real variable vectors More...

std::map< std::string, QuantityMatrix * >	quantityMatrices_
	collection of real variable matrices More...

std::map< std::string, String * >	strings_
	collection of string variables More...

std::map< std::string, StringVector * >	stringVectors_
	collection of string variable vectors More...

Protected Attributes inherited from Node
std::map< std::string, std::unique_ptr< Node > >	children_
	the collection of direct descendants More...

Protected Attributes inherited from Item
Persistent *	parent_
	pointer to the parent Persistent; set to this by the constructor if Item is self-standing or a root Persistent of a tree More...

Protected Attributes inherited from Diagnostic
int	verbosityInstance

Detailed Description

Model for electrochemical multiphase reaction

#include <libpf/units/MultiReactionElectrochemical.h>

Remarks

Warning: Thread safe:; Extendable:; Platform dependencies:

Constructor & Destructor Documentation

◆ MultiReactionElectrochemical()

MultiReactionElectrochemical::MultiReactionElectrochemical	(	Libpf::Persistency::Defaults	defaults,
		uint32_t	id = `0`,
		Persistency *	persistency = `nullptr`,
		Persistent *	parent = `nullptr`,
		Persistent *	root = `nullptr`
	)

Member Function Documentation

◆ calcE0()

virtual void MultiReactionElectrochemical::calcE0	(	const Value &	P0,
		const Value &	P1,
		const Vector &	x0,
		const Vector &	x1
	)

pure virtual

compute thermodynamic voltage E0 and Rarea

Parameters

P0	pressure anode side adimensionalized against the reference pressure of 1 bar
P1	pressure cathode side adimensionalized against the reference pressure of 1 bar
x0	mole fractions in the anode outlet
x1	mole fractions in the cathode outlet

◆ calceqconst()

Value MultiReactionElectrochemical::calceqconst	(	const Value &	P0,
		const Value &	P1,
		const Vector &	x0,
		const Vector &	x1
	)

compute K

Parameters

P0	pressure anode side adimensionalized against the reference pressure of 1 bar
P1	pressure cathode side adimensionalized against the reference pressure of 1 bar
x0	mole fractions in the anode outlet
x1	mole fractions in the cathode outlet

◆ calculateEquilibrium()

void MultiReactionElectrochemical::calculateEquilibrium	(	const Value &	P0,
		const Value &	P1
	)

Parameters

P0	pressure anode side adimensionalized against the reference pressure of 1 bar
P1	pressure cathode side adimensionalized against the reference pressure of 1 bar

◆ QUANTITY() [1/24]

MultiReactionElectrochemical::QUANTITY	(	A	,
		"Cell area"	,
		0.	0,
		"m2"
	)

◆ QUANTITY() [2/24]

MultiReactionElectrochemical::QUANTITY	(	action	,
		"Cell action 1 for fuelcell and -1 for electrolyzers"	,
		1.	0,
		""
	)

◆ QUANTITY() [3/24]

MultiReactionElectrochemical::QUANTITY	(	deltaT	,
		"Temperature approach to equilibrium"	,
		0.	0,
		"K"
	)

◆ QUANTITY() [4/24]

MultiReactionElectrochemical::QUANTITY	(	E	,
		"Open circuit voltage OCV"	,
		0.	0,
		"V"
	)

◆ QUANTITY() [5/24]

MultiReactionElectrochemical::QUANTITY	(	E0	,
		"Thermodynamic voltage"	,
		0.	0,
		"V"
	)

◆ QUANTITY() [6/24]

MultiReactionElectrochemical::QUANTITY	(	F	,
		"Faraday constant"	,
		96485339.	9,
		"C/kmol"
	)

◆ QUANTITY() [7/24]

MultiReactionElectrochemical::QUANTITY	(	H	,
		"Cell length"	,
		0.	595,
		"m"
	)

◆ QUANTITY() [8/24]

MultiReactionElectrochemical::QUANTITY	(	I	,
		"Current"	,
		1.	0,
		"A"
	)

◆ QUANTITY() [9/24]

MultiReactionElectrochemical::QUANTITY	(	Iset	,
		"Set current used if I option"	,
		0.	0,
		"A"
	)

◆ QUANTITY() [10/24]

MultiReactionElectrochemical::QUANTITY	(	J	,
		"Average value of current density"	,
		0.	0,
		"A/m2"
	)

◆ QUANTITY() [11/24]

MultiReactionElectrochemical::QUANTITY	(	Jset	,
		"Set current density used if J option"	,
		0.	0,
		"A/m2"
	)

◆ QUANTITY() [12/24]

MultiReactionElectrochemical::QUANTITY	(	Kin	,
		"Equilibrium constant at inlet stream compositions"	,
		1.	0,
		""
	)

◆ QUANTITY() [13/24]

MultiReactionElectrochemical::QUANTITY	(	Kout	,
		"Equilibrium constant at outlet stream compositions"	,
		1.	0,
		""
	)

◆ QUANTITY() [14/24]

MultiReactionElectrochemical::QUANTITY	(	nCells	,
		"Number of cells in a stack"	,
		40.	0,
		""
	)

◆ QUANTITY() [15/24]

MultiReactionElectrochemical::QUANTITY	(	Power	,
		"Stack net power output"	,
		1.	0,
		"W"
	)

◆ QUANTITY() [16/24]

MultiReactionElectrochemical::QUANTITY	(	PowerDensity	,
		"Stack areic power density"	,
		0.	0,
		"W/m2"
	)

◆ QUANTITY() [17/24]

MultiReactionElectrochemical::QUANTITY	(	Rarea	,
		"Areic electrical resistance"	,
		0.	0,
		"ohm*m2"
	)

◆ QUANTITY() [18/24]

MultiReactionElectrochemical::QUANTITY	(	Tact	,
		"Actual temperature"	,
		298.	15,
		"K"
	)

◆ QUANTITY() [19/24]

MultiReactionElectrochemical::QUANTITY	(	Teq	,
		"Equilibrium temperature"	,
		298.	15,
		"K"
	)

◆ QUANTITY() [20/24]

MultiReactionElectrochemical::QUANTITY	(	V	,
		"Cell voltage"	,
		0.	0,
		"V"
	)

◆ QUANTITY() [21/24]

MultiReactionElectrochemical::QUANTITY	(	Voffset	,
		"Correction to cell voltage to account for the effect of the microscale"	,
		0.	0,
		"V"
	)

◆ QUANTITY() [22/24]

MultiReactionElectrochemical::QUANTITY	(	Vset	,
		"Set cell voltage used if V option"	,
		0.	0,
		"V"
	)

◆ QUANTITY() [23/24]

MultiReactionElectrochemical::QUANTITY	(	Vstack	,
		"Stack voltage"	,
		0.	0,
		"V"
	)

◆ QUANTITY() [24/24]

MultiReactionElectrochemical::QUANTITY	(	W	,
		"Cell width"	,
		1.	195,
		"m"
	)

◆ STRING() [1/2]

MultiReactionElectrochemical::STRING	(	averageOption	,
		"Composition average option"	,
		"log"
	)

Composition average option:

linear linear mean of the equilibrium constants based on inlet and outlet composition
outlet equilibrium constant based on outlet composition
log logarithm mean of the equilibrium constants based on inlet and outlet composition

◆ STRING() [2/2]

MultiReactionElectrochemical::STRING	(	option	,
		"Calculation option"	,
		"z"
	)

Calculation option:

z Fractional conversion in terms of key component is fixed by user
V Cell voltage is fixed by user
I Current is fixed by user
J Current density is fixed by user

◆ type()

const std::string & MultiReactionElectrochemical::type ( void ) const

inlineoverridevirtual

Returns: the C++ name of the class the instance belongs to

Note: it is the responsibility of the caller to not access this reference after the lifecycle of the Item

Reimplemented from Object.

Member Data Documentation

◆ type_

const std::string MultiReactionElectrochemical::type_

static

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

MultiReactionElectrochemical.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultiReactionElectrochemical()

Member Function Documentation

◆ calcE0()

◆ calceqconst()

◆ calculateEquilibrium()

◆ QUANTITY() [1/24]

◆ QUANTITY() [2/24]

◆ QUANTITY() [3/24]

◆ QUANTITY() [4/24]

◆ QUANTITY() [5/24]

◆ QUANTITY() [6/24]

◆ QUANTITY() [7/24]

◆ QUANTITY() [8/24]

◆ QUANTITY() [9/24]

◆ QUANTITY() [10/24]

◆ QUANTITY() [11/24]

◆ QUANTITY() [12/24]

◆ QUANTITY() [13/24]

◆ QUANTITY() [14/24]

◆ QUANTITY() [15/24]

◆ QUANTITY() [16/24]

◆ QUANTITY() [17/24]

◆ QUANTITY() [18/24]

◆ QUANTITY() [19/24]

◆ QUANTITY() [20/24]

◆ QUANTITY() [21/24]

◆ QUANTITY() [22/24]

◆ QUANTITY() [23/24]

◆ QUANTITY() [24/24]

◆ STRING() [1/2]

◆ STRING() [2/2]

◆ type()

Member Data Documentation

◆ type_