Base of the hierarchy of all vertex model types to be included in a FlowSheet This class manages the connection of vertexes with edges and derived classes must implement the Calculatable interface. More...

#include <VertexBase.h>

Inheritance diagram for VertexBase:

[legend]

Public Types
enum	PortLocation { north , south , east , west }

Public Types inherited from Calculatable
enum	SolutionMode { Null = 0 , sequential , simultaneous , singlePassSimultaneous }

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

	QUANTITY (cmdot, "Cumulative mass flow inlet minus outlet", one, "kg/s")

	QUANTITY (mdotin, "inlet mass flow", one, "kg/s")

	QUANTITY (mdotout, "outlet mass flow", one, "kg/s")

	QUANTITY (cduty, "Cumulative enthalpy flow inlet minus outlet", one, "W")

virtual void	attach (EdgeBase &edge, std::string &port)

virtual void	detach (std::string port)
	Detaches the edge from the port with name "port". More...

virtual bool	check (void)=0
	Checks the connectivity for this instance of VertexBase and returns true if something is out of order. More...

void	translate (std::string &s)
	translates port name from user-friendly synonyms into the canonical form, or leaves unchanged More...

virtual void	checkBalance (void)
	call calculateBalance, then issue error/warning if required More...

virtual void	calculateBalance (void)=0
	calculate cmdot, mdotin, mdotout, mdotcomps[] and cduty based on inlet/outlet streams More...

virtual Value	massBalance (void) const
	return should-be net mass balance of unit (inlet-outlet), defaults to zero and must be overridden if required More...

virtual Value	energyBalance (void) const
	return should-be net energy balance of unit (inlet-outlet), defaults to zero and must be overridden if required More...

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

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

virtual PortLocation	locationFromPort (std::string port) const

PortLocation	locationFromEdge (std::string edgeTag) const

const std::string &	edgeFromPort (const std::string &port) const

const std::string &	portFromEdge (const std::string &edgeTag) const

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

Public Member Functions inherited from Task
	Task (void)

	~Task (void)

double	cost (void) const

int	level (void) const

int	core (void) const
	get the core where this task is scheduled or -1 if not yet scheduled More...

double	startTime (void) const
	return forecast start time More...

double	endTime (void) const
	return forecast end time More...

void	setLevel (int l)

void	setCore (int c)

double	setStartTime (double t)
	sets the start time and returns the end time More...

Public Member Functions inherited from Calculatable
virtual void	go (SolutionMode solutionMode, int level)=0

Public Attributes
std::vector< Quantity >	mdotcomps
	Cumulative mass flow of each component, inlet - outlet. More...

Public Attributes inherited from Task
int	weight
	for backTrack_ and findCycles More...

Protected Member Functions
void	registerSynonym (std::string synonym, std::string port)

void	clearBalance (void)
	used in calculateBalance, zeroes out the required variables 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 Member Functions inherited from Calculatable
virtual	~Calculatable ()=default

Additional Inherited Members
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

Base of the hierarchy of all vertex model types to be included in a FlowSheet This class manages the connection of vertexes with edges and derived classes must implement the Calculatable interface.

#include <libpf/core/VertexBase.h>

Remarks

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

Member Enumeration Documentation

◆ PortLocation

enum VertexBase::PortLocation

Enumerator
north
south
east
west

Constructor & Destructor Documentation

◆ VertexBase()

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

Member Function Documentation

◆ attach()

virtual void VertexBase::attach	(	EdgeBase &	edge,
		std::string &	port
	)

virtual

Attaches the Edge edge to the port "port" of this instance of VertexBase

Parameters

[in]	edge	the edge
[in,out]	port	name of the port; only untranslated names are accepted

Remarks: if an in/out port is specified, on exit the port will contain the inXX/outXX port name

Reimplemented in Connectivity.

◆ calculateBalance()

virtual void VertexBase::calculateBalance ( void )

pure virtual

calculate cmdot, mdotin, mdotout, mdotcomps[] and cduty based on inlet/outlet streams

Implemented in Connectivity.

◆ category()

Libpf::Utility::Category VertexBase::category ( void ) const

overridevirtual

return model Category

Implements Model.

Reimplemented in FlowSheet.

◆ check()

virtual bool VertexBase::check ( void )

pure virtual

Checks the connectivity for this instance of VertexBase and returns true if something is out of order.

Implemented in FlowSheet, and Connectivity.

◆ checkBalance()

virtual void VertexBase::checkBalance ( void )

virtual

call calculateBalance, then issue error/warning if required

◆ clearBalance()

void VertexBase::clearBalance ( void )

protected

used in calculateBalance, zeroes out the required variables

◆ detach()

virtual void VertexBase::detach ( std::string port )

virtual

Detaches the edge from the port with name "port".

Reimplemented in Connectivity.

◆ edgeFromPort()

const std::string & VertexBase::edgeFromPort ( const std::string & port ) const

Returns: the edge tag connected to the specified port

Parameters

[in] port untranslated port name

Exceptions

ErrorConnectivity if the port is not connected

◆ energyBalance()

virtual Value VertexBase::energyBalance ( void ) const

virtual

return should-be net energy balance of unit (inlet-outlet), defaults to zero and must be overridden if required

Reimplemented in FlowSheet, Terminator, Compressor, Exchanger, FlashDegasser, FlashDrum, FlashSplitter, MultiExchanger, Multiplier, Pump, Selector, and Separator.

◆ locationFromEdge()

PortLocation VertexBase::locationFromEdge ( std::string edgeTag ) const

Returns: the port location for the SVG icon; can be overriden by deroved classes as required; the default implementation always returns west for inlets and east for outlets

Parameters

edgeTag the tag of the edge

See also: Layout

◆ locationFromPort()

virtual PortLocation VertexBase::locationFromPort ( std::string port ) const

virtual

Returns: the port location for the SVG icon; can be overriden by deroved classes as required; the default implementation always returns west for inlets and east for outlets

Parameters

port	the name of the port (i.e. in1, out ...)

Remarks: this is independent from whether an edge is attached

See also: Layout

Reimplemented in Column, Decanter, PressureSwingAbsorption, Compressor, Degasser, Exchanger, FlashDegasser, FlashSplitter, HtuNtu, and MultiExchanger.

◆ massBalance()

virtual Value VertexBase::massBalance ( void ) const

virtual

return should-be net mass balance of unit (inlet-outlet), defaults to zero and must be overridden if required

Reimplemented in FlowSheet, Terminator, Multiplier, and Selector.

◆ portFromEdge()

const std::string & VertexBase::portFromEdge ( const std::string & edgeTag ) const

Returns: the untranslated port name where the specified edge tag is connected

Parameters

[in] edgeTag tag of the edge

Exceptions

ErrorConnectivity if the edge is not connected

◆ printSvg()

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

overridevirtual

Output the model in SVG format

Parameters

fileName	SVG file name (optional full path + file name and .svg extension)
tiny	if true, print to SVG Tiny 1.1 format, else to Full SVG 1.1 format
raster	if true, the xlinks in the image elements will point to raster (png) icons, else they will be vector (svg) icons
offset	offset to apply to the ids

Remarks: any flowsheet will be modified afterwards because all cut streams will be reattached and reverted

Reimplemented from Model.

Reimplemented in FlowSheet.

◆ QUANTITY() [1/4]

VertexBase::QUANTITY	(	cduty	,
		"Cumulative enthalpy flow inlet minus outlet"	,
		one	,
		"W"
	)

◆ QUANTITY() [2/4]

VertexBase::QUANTITY	(	cmdot	,
		"Cumulative mass flow inlet minus outlet"	,
		one	,
		"kg/s"
	)

◆ QUANTITY() [3/4]

VertexBase::QUANTITY	(	mdotin	,
		"inlet mass flow"	,
		one	,
		"kg/s"
	)

◆ QUANTITY() [4/4]

VertexBase::QUANTITY	(	mdotout	,
		"outlet mass flow"	,
		one	,
		"kg/s"
	)

◆ registerSynonym()

void VertexBase::registerSynonym	(	std::string	synonym,
		std::string	port
	)

protected

defines user-friendly synonym (example "vapor") for canonical port name (example "in1", "in2", "in3", .... "out1", "out2", ...)

Parameters

synonym	can optionally be used to connect to the port, besides the canonical port name; allowed synonyms do not start with "in" or "out"
port	canonical port name

Exceptions

ErrorConnectivity if the supplied synonym is not allowed

◆ translate()

void VertexBase::translate ( std::string & s )

translates port name from user-friendly synonyms into the canonical form, or leaves unchanged

Member Data Documentation

◆ mdotcomps

std::vector<Quantity> VertexBase::mdotcomps

Cumulative mass flow of each component, inlet - outlet.

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

VertexBase.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PortLocation

Constructor & Destructor Documentation

◆ VertexBase()

Member Function Documentation

◆ attach()

◆ calculateBalance()

◆ category()

◆ check()

◆ checkBalance()

◆ clearBalance()

◆ detach()

◆ edgeFromPort()

◆ energyBalance()

◆ locationFromEdge()

◆ locationFromPort()

◆ massBalance()

◆ portFromEdge()

◆ printSvg()

◆ QUANTITY() [1/4]

◆ QUANTITY() [2/4]

◆ QUANTITY() [3/4]

◆ QUANTITY() [4/4]

◆ registerSynonym()

◆ translate()

Member Data Documentation

◆ mdotcomps