#include <FlowSheet.h>

Inheritance diagram for FlowSheet:

[legend]

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

	~FlowSheet (void)

	INTEGERVECTOR (enableAssignment, "Enable Assignment", 0, 0)

	INTEGER (NITER, "Number of iterations for flowsheet cuts convergence", -1)

	QUANTITY (seqTol, "Tolerance for sequential modular mode", 1e-6, "")

	QUANTITY (seqErr, "Current error for sequential modular mode", 1e-6, "")

void	addCut (std::string s)
	makes the stream with tag s a cut stream, allocates a new stream with tag s+"bis" with same type as s, reconnects More...

void	removeCut (std::string s)
	deletes the cut stream with tag s+"bis" and reconnects stream s as required More...

void	restoreCuts (void)
	recursively restore cut streams More...

void	calculate (int level=0) override

void	go (Calculatable::SolutionMode solutionMode, int level) override final

virtual void	pre (Calculatable::SolutionMode solutionMode, int level)=0

virtual void	post (Calculatable::SolutionMode solutionMode, int level)=0

void	addUnit (const std::string &type, Libpf::Persistency::Defaults defaults)

void	addStream (const std::string &type, Libpf::Persistency::Defaults defaults, const std::string &from, const std::string &port_from, const std::string &to, const std::string &port_to)
	non-template variant, see #236 More...

void	makeSequentialAssembly (std::list< Assignment * >::iterator &p)
	build equations associated with sequential mode solution (cut streams) More...

virtual void	makeUserEquations (std::list< Assignment * >::iterator &p)=0
	user will code here "specification" equation list for sequential calculation More...

bool	isAssignmentActive (std::list< Assignment * >::iterator &q) const override
	will be implemented in Model-aware derived class More...

virtual int	sequential (void)

void	setMinSequential (int minSequential)

virtual bool	supportsSimultaneous (void)
	returns true if flowsheet can be solved in simultaneous mode; defaults to true More...

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

SolverNleInterface *	solver (void)

int	calculateResidualsLocal (void) override
	compute residuals and store into local vector y_; must be provided by implementations More...

void	setup_of (void) override
	set up problem size, pick up objective functions, assemble unknowns, residuals and scalers list More...

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

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

void	check_inout (void)
	Check flowsheet-level in- and out-flows. More...

bool	check (void) override
	Check connections in Edges and Vertexes. More...

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

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

Value	massBalance (void) const override

Value	energyBalance (void) const override

void	printPluggable (void) const
	diagnostic print More...

int	inletIdFromPort (const std::string &port) const

const std::string &	inletTag (unsigned int i) const

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

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

int	outletIdFromPort (const std::string &port) const

const std::string &	outletTag (unsigned int i) const

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

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

bool	isDag (void) const
	Returns true if the graph is a Directed Acyclic Graph (DAG) More...

void	printDot (const char *s, int id=0) const

void	printGraph (std::ostream &os) const
	print Vertex and Edge lists to os More...

Public Member Functions inherited from VertexBase
	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...

virtual void	go (SolutionMode solutionMode, int level)=0

Public Member Functions inherited from SequentialAssembly
	SequentialAssembly (void)
	Lifecycle. More...

	~SequentialAssembly (void)

double	deltaseq (void) const

int	neqs (void) const
	returns the number of Assignments More...

void	wegsteinstep (void)
	Substitutes RHS into *LHSP for all Assignments. More...

void	directstep (void)
	Updates *LHSP with RHS using Wegstein accelerated direct substitution for all Assignments. More...

void	makeAssignment (std::list< Assignment * >::iterator &p, Value &lhs, Value rhs, std::string tag, std::string rhsstring, int i, Libpf::Utility::ScalingMode sm=Libpf::Utility::ScalingMode::noscaling, double xmin=0.0, double xmax=1.0, Value factor=One)

void	addCut (std::string name, Stream in, Stream out)

void	removeCut (std::string tag)

Assignment *	operator<< (Assignment *ep)
	includes a new Assignment to the corresponding collection More...

void	print (void) const

void	purgeAss (void)
	delete all equations More...

void	setDamping (double d)
	set damping coefficient for direct substitution More...

double	damping (void) const
	returns current value of the damping coefficient for direct substitution More...

void	setMaxChange (double c)
	set maximum relative step change for direct substitution More...

double	maxChange (void) const
	returns current value of maximum relative step change for direct substitution More...

Public Member Functions inherited from ObjectiveNleAdFlowsheet
	ObjectiveNleAdFlowsheet (std::string t)
	constructor More...

	~ObjectiveNleAdFlowsheet (void)

Public Member Functions inherited from ObjectiveNleAdVertex
	ObjectiveNleAdVertex (std::string t)
	constructor More...

void	unscalex (double *x) override
	transforms back the vector of scaled variables x by applying the unscaling More...

int	calculateResiduals (std::vector< Value > &y, uint32_t offset) override

void	operator() (double , double , Jacobian *) override
	implements the () operator by calling calculateResidualsLocal and calculateResiduals; overrides ObjectiveNleAd::operator() More...

virtual int	calculateResidualsLocal (void)=0
	compute residuals and store into local vector y_; must be provided by implementations More...

virtual void	setup_of (void)=0
	setup and resize appropriately internal vectors; must be provided by implementations More...

Public Member Functions inherited from ObjectiveNleAd
	ObjectiveNleAd (std::string t)
	constructor More...

double	xmin (unsigned int i)
	return the lower bound on unknown i More...

double	xmax (unsigned int i)
	return the upper bound on unknown i More...

unsigned int	size (void) const override
	returns the current size of the problem More...

void	scalex (double *x) override
	transforms the vector of "real" variables x by applying the scaling More...

void	unscalex (double *x) override
	transforms back the vector of scaled variables x by applying the unscaling More...

void	operator() (double , double , Jacobian *J) override
	implements the () operator by calling calculateResiduals; derived class may override it More...

void	addUnknown (Value *x, Scaler scaler, const std::string &tag)

void	changeUnknown (unsigned int i, Value *x, Scaler scaler, const std::string &tag)
	change the i-th unknown More...

void	addObjectiveFunction (ObjectiveNleAd &of)
	append the remote objective function More...

Public Member Functions inherited from ObjectiveNleAuto
	ObjectiveNleAuto (std::string t)
	constructor More...

virtual unsigned int	size (void) const
	returns the current size of the problem More...

bool	init (double *x)

void	setValue (unsigned int i, double x)
	copies the value for the i-th unknown from x in the Value pointed to, without altering the derivatives More...

void	copyresults (double *x)
	copies the unknown values from the x vector into the Values pointed to More...

void	inactivate (void)
	inactivates all unknowns More...

void	clearderivatives (void)
	clears the derivative information for all unknowns without setting to inactive More...

void	setActive (unsigned int i)
	activates the i-th unknown More...

void	scalex (double *) override
	transforms the vector of "real" variables x by applying the scaling More...

void	unscalex (double *x) override
	transforms back the vector of scaled variables x by applying the unscaling More...

void	operator() (double , double , Jacobian *J) override
	implements the () operator by calling calculateResiduals; derived class may override it More...

void	setx (unsigned int i, Value &x)
	sets the i-th unknown to x More...

const Value &	unknown (unsigned int i) const
	returns a reference to the i-th unknown More...

const std::string &	unknownTag (unsigned int i) const
	returns a reference to the tag of the i-th unknown More...

double	xmin (unsigned int i)
	return the lower bound on unknown i More...

double	xmax (unsigned int i)
	return the upper bound on unknown i More...

void	print (void) const
	lists unknowns More...

const std::string &	tagof (void) const
	returns the tag of the instance More...

void	settagof (std::string t)
	sets the tag of the instance More...

void	appendtagof (const std::string &t)
	appends to the tag of the instance More...

int	zero_residuals (std::vector< Value > &y, uint32_t offset)

virtual int	calculateResiduals (std::vector< Value > &y, uint32_t offset)=0

void	addUnknown (Value *x, const std::string &tag)

void	changeUnknown (unsigned int i, Value *x, const std::string &tag)
	change the i-th unknown More...

Public Member Functions inherited from ObjectiveNleInterface
	ObjectiveNleInterface (void)

virtual void	operator() (double x, double y, Jacobian *J)=0
	computes the objective function vector y at the point x and optionally the Jacobian J More...

virtual void	scalex (double *x)=0
	transforms the vector of "real" variables x by applying the scaling More...

virtual void	unscalex (double *x)=0
	transforms back the vector of scaled variables x by applying the unscaling More...

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

	~Connectivity (void)

	INTEGER (nIn, "Number of connected inlet EdgeBases", 0)
	should not be set directly: use attach instead More...

	INTEGER (nOut, "Number of connected outlet EdgeBases", 0)
	should not be set directly: use attach instead More...

	INTEGER (maxNIn, "Maximum number of connected inlet EdgeBases or -1 for unlimited", -1)

	INTEGER (maxNOut, "Maximum number of connected outlet EdgeBases or -1 for unlimited", -1)

	STRING (constraints, "Used internally to persist connectivity constraints", "")

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

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

bool	check (void) override

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

std::string	portInlet (int i) const

std::string	portOutlet (int i) const

bool	isInletConnected (unsigned int i) const

bool	isOutletConnected (unsigned int i) const

EdgeBase &	inlet (unsigned int i)

EdgeBase &	outlet (unsigned int i)

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

void	printConnectivity (void) const
	diagnostic print More...

Public Attributes
Libpf::Utility::CutsSolution	mode
	Mode used for solving the cuts in the flowsheet. More...

Public Attributes inherited from VertexBase
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...

Public Attributes inherited from SequentialAssembly
std::map< std::string, Cut * >	cuts_
	collection of cut streams to automatically generate the Assignments converging them More...

std::list< Assignment * >	ass_
	collection of Assignments, containing the assembly of explicit equations More...

std::vector< Scaler * >	scalers_
	collection of optional scalers for the unknowns More...

Public Attributes inherited from ObjectiveNleInterface
int	verbosityLocal

Protected Member Functions
void	setInputConnection (std::string port, std::string internalStream)

void	setOutputConnection (std::string port, std::string internalStream)

Protected Member Functions inherited from VertexBase
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

virtual bool	isAssignmentActive (std::list< Assignment * >::iterator &q) const =0
	will be implemented in Model-aware derived class More...

Protected Member Functions inherited from ObjectiveNleAd
void	prepare_ (double x, Jacobian J) override
	uscales x (unknowns) values from calling function and puts them in x_ Quantities More...

void	packResults_ (double x, double y, Jacobian *J)

	~ObjectiveNleAd ()

Protected Member Functions inherited from ObjectiveNleAuto
	~ObjectiveNleAuto ()

Protected Member Functions inherited from ObjectiveNleInterface
	~ObjectiveNleInterface ()

Protected Member Functions inherited from Connectivity
void	inletRequired (unsigned int i)

Protected Attributes
ObjectiveNleAd *	myof_
	derived classes can supply their own additional equations and set this pointer in the constructor More...

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

Protected Attributes inherited from ObjectiveNleAdVertex
bool	set_
	true if setup_of has already been called More...

Protected Attributes inherited from ObjectiveNleAd
std::vector< Scaler >	scaler_
	provide scaling and unscaling More...

Protected Attributes inherited from ObjectiveNleAuto
std::vector< Value >	residuals
	Residuals. More...

Protected Attributes inherited from Connectivity
std::vector< EdgeBase * >	inlets_
	inlet EdgeBase pointer vector More...

std::vector< EdgeBase * >	outlets_
	outlet EdgeBase pointer vector More...

Additional Inherited Members
Public Types inherited from VertexBase
enum	PortLocation { north , south , east , west }

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

Detailed Description

Edge model to represent a FlowSheet.

#include <libpf/flowsheet/FlowSheet.h>

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

Constructor & Destructor Documentation

◆ FlowSheet()

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

◆ ~FlowSheet()

FlowSheet::~FlowSheet ( void )

Member Function Documentation

◆ addCut()

void FlowSheet::addCut ( std::string s )

makes the stream with tag s a cut stream, allocates a new stream with tag s+"bis" with same type as s, reconnects

◆ addStream()

void FlowSheet::addStream	(	const std::string &	type,
		Libpf::Persistency::Defaults	defaults,
		const std::string &	from,
		const std::string &	port_from,
		const std::string &	to,
		const std::string &	port_to
	)

non-template variant, see #236

adds a new Stream of supplied type, creating a new node

Parameters

type	edge type
defaults	custom Defaults for the edge type
from	source edge name
port_from	source vertex outlet port
to	destination vertex name
port_to	destination vertex outlet port

◆ addUnit()

void FlowSheet::addUnit	(	const std::string &	type,
		Libpf::Persistency::Defaults	defaults
	)

adds a new Unit of supplied type, creating a new node

Parameters

type	vertex type
defaults	custom Defaults for the vertex type

◆ calculate()

void FlowSheet::calculate ( int level = 0 )

overridevirtual

calculates the model; implementations must call setCalculated

Parameters

level used for indenting, defaults to 0

Implements Model.

◆ calculateResidualsLocal()

int FlowSheet::calculateResidualsLocal ( void )

overridevirtual

compute residuals and store into local vector y_; must be provided by implementations

Implements ObjectiveNleAdVertex.

◆ category()

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

overridevirtual

return model Category

Reimplemented from VertexBase.

◆ check()

bool FlowSheet::check ( void )

overridevirtual

Check connections in Edges and Vertexes.

Implements VertexBase.

◆ check_inout()

void FlowSheet::check_inout ( void )

Check flowsheet-level in- and out-flows.

◆ energyBalance()

Value FlowSheet::energyBalance ( void ) const

overridevirtual

Remarks: call calculate before !

Reimplemented from VertexBase.

◆ go()

void FlowSheet::go	(	Calculatable::SolutionMode	solutionMode,
		int	level
	)

finaloverridevirtual

Calculate the Model

Parameters

solutionMode	solution mode to use
level	used for indenting

Implements Calculatable.

◆ initializeNonPersistents()

void FlowSheet::initializeNonPersistents ( void )

overridevirtual

estimates hidden, non-persistent unknowns from the current results

Implements Model.

◆ inletConnection()

int FlowSheet::inletConnection ( const std::string & tag ) const

Parameters

[in] tag internal stream tag

Returns: zero-index inlet connection id corresponding to the supplied internal stream tag

Exceptions

ErrorConnection if the supplied tag does not correspond to an inlet stream

◆ inletIdFromPort()

int FlowSheet::inletIdFromPort ( const std::string & port ) const

Returns: the zero-index inlet connection id corresponding to the supplied inlet port

Parameters

[in] port canonical port name such as "in1", "in2" ...

Exceptions

ErrorConnection if the port name is invalid

◆ inletTag()

const std::string & FlowSheet::inletTag ( unsigned int i ) const

Parameters

[in] i zero-index inlet connection id

Returns: internal stream tag corresponding to the inlet connection with supplied index

Exceptions

ErrorConnection if the index is out of range

◆ INTEGER()

FlowSheet::INTEGER	(	NITER	,
		"Number of iterations for flowsheet cuts convergence"	,
		-	1
	)

◆ INTEGERVECTOR()

FlowSheet::INTEGERVECTOR	(	enableAssignment	,
		"Enable Assignment"	,
		0	,
		0
	)

◆ isAssignmentActive()

bool FlowSheet::isAssignmentActive ( std::list< Assignment * >::iterator & q ) const

overridevirtual

will be implemented in Model-aware derived class

Implements SequentialAssembly.

◆ isDag()

bool FlowSheet::isDag ( void ) const

Returns true if the graph is a Directed Acyclic Graph (DAG)

◆ isInletConnection()

bool FlowSheet::isInletConnection ( const std::string & tag ) const

Parameters

[in] tag internal stream tag

Returns: true if the supplied internal stream tag is an inlet connection

◆ isOutletConnection()

bool FlowSheet::isOutletConnection ( const std::string & tag ) const

Parameters

[in] tag internal stream tag

Returns: true if the supplied internal stream tag is an outlet connection

◆ makeSequentialAssembly()

void FlowSheet::makeSequentialAssembly ( std::list< Assignment * >::iterator & p )

build equations associated with sequential mode solution (cut streams)

◆ makeUserEquations()

virtual void FlowSheet::makeUserEquations ( std::list< Assignment * >::iterator & p )

pure virtual

user will code here "specification" equation list for sequential calculation

Implemented in LiquidRingVacuumPump, CompressionStage, MultiCompressorIntercooled< N >, MultiStage, MultiStageOneTwo, PressureSwingAbsorption, Zone, Column, Decanter, FallingFilm, and ReboilerCrossFlow.

◆ massBalance()

Value FlowSheet::massBalance ( void ) const

overridevirtual

Remarks: call calculate before !

Reimplemented from VertexBase.

◆ objectiveFunction()

ObjectiveNleAd * FlowSheet::objectiveFunction ( void )

inlineoverridevirtual

returns a pointer to the model's objective function

Implements Model.

◆ outletConnection()

int FlowSheet::outletConnection ( const std::string & tag ) const

Parameters

[in] tag internal stream tag

Returns: zero-index outlet connection id corresponding to the supplied internal stream tag

Exceptions

ErrorConnection if the supplied tag does not correspond to an outlet stream

◆ outletIdFromPort()

int FlowSheet::outletIdFromPort ( const std::string & port ) const

Returns: the zero-index outlet connection id corresponding to the supplied outlet port

Parameters

[in] port canonical port name such as "out1", "out2" ...

Exceptions

ErrorConnection if the port name is invalid

◆ outletTag()

const std::string & FlowSheet::outletTag ( unsigned int i ) const

Parameters

[in] i zero-index outlet connection id

Returns: internal stream tag corresponding to the outlet connection with supplied index

Exceptions

ErrorConnection if the index is out of range

◆ post()

virtual void FlowSheet::post	(	Calculatable::SolutionMode	solutionMode,
		int	level
	)

pure virtual

flowsheet post-computations; to be implemented by any concrete FlowSheet-derived class

Remarks: will be executed after each sequential or simultaneous iteration

Implemented in Column, ColumnSection, Decanter, FallingFilm, LiquidRingVacuumPump, CompressionStage, MultiCompressorIntercooled< N >, MultiStage, MultiStage2D, PressureSwingAbsorption, ReboilerCrossFlow, and Zone.

◆ pre()

virtual void FlowSheet::pre	(	Calculatable::SolutionMode	solutionMode,
		int	level
	)

pure virtual

flowsheet pre-computations; to be implemented by any concrete FlowSheet-derived class

Remarks: will be executed before each sequential or simultaneous iteration

Implemented in Column, Decanter, FallingFilm, LiquidRingVacuumPump, CompressionStage, MultiCompressorIntercooled< N >, MultiStage, MultiStage2D, PressureSwingAbsorption, ReboilerCrossFlow, and Zone.

◆ printDot()

void FlowSheet::printDot	(	const char *	s,
		int	id = `0`
	)		const

Output the graph in AT&T DOT format (graphviz)

Parameters

s	.dot file name (file name and dot extension)
id	offset subtract id to all catalog ids

◆ printGraph()

void FlowSheet::printGraph ( std::ostream & os ) const

print Vertex and Edge lists to os

◆ printPluggable()

void FlowSheet::printPluggable ( void ) const

diagnostic print

◆ printSvg()

void FlowSheet::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 VertexBase.

◆ QUANTITY() [1/2]

FlowSheet::QUANTITY	(	seqErr	,
		"Current error for sequential modular mode"	,
		1e-	6,
		""
	)

◆ QUANTITY() [2/2]

FlowSheet::QUANTITY	(	seqTol	,
		"Tolerance for sequential modular mode"	,
		1e-	6,
		""
	)

◆ removeCut()

void FlowSheet::removeCut ( std::string s )

deletes the cut stream with tag s+"bis" and reconnects stream s as required

◆ restoreCuts()

void FlowSheet::restoreCuts ( void )

recursively restore cut streams

◆ sequential()

virtual int FlowSheet::sequential ( void )

virtual

Returns: the maximum number of iterations for sequential computation defaults to 5; to increase it in complex flowsheets that contain sub-flowsheets, override this function; to decrease it for testing purposes, invoke setMinSequential in the constructor.

Reimplemented in LiquidRingVacuumPump, Column, FallingFilm, MultiStage, MultiStageOneTwo, and ReboilerCrossFlow.

◆ setInputConnection()

void FlowSheet::setInputConnection	(	std::string	port,
		std::string	internalStream
	)

protected

Setter for input stream naming

Parameters

port	externally-visible name for the input stream
internalStream	internal name of the input stream

◆ setMinSequential()

void FlowSheet::setMinSequential ( int minSequential )

sets the minimum number of maximum iterations for sequential computation; this number will override any value for this threshold returned by any overrider of the sequential virtual function, if the latter is lower

◆ setOutputConnection()

void FlowSheet::setOutputConnection	(	std::string	port,
		std::string	internalStream
	)

protected

Setter for output stream naming

Parameters

port	externally-visible name for the output stream
internalStream	internal name of the output stream

◆ setup()

void FlowSheet::setup ( void )

overridevirtual

performs initializations required immediately before solution

Implements Model.

Reimplemented in LiquidRingVacuumPump, CompressionStage, MultiCompressorIntercooled< N >, MultiStage, MultiStageOneTwo, PressureSwingAbsorption, ReboilerCrossFlow, and Zone.

◆ setup_of()

void FlowSheet::setup_of ( void )

overridevirtual

set up problem size, pick up objective functions, assemble unknowns, residuals and scalers list

Implements ObjectiveNleAdVertex.

◆ solver()

SolverNleInterface * FlowSheet::solver ( void )

◆ supportsSimultaneous()

virtual bool FlowSheet::supportsSimultaneous ( void )

virtual

returns true if flowsheet can be solved in simultaneous mode; defaults to true

Reimplemented in LiquidRingVacuumPump.

Member Data Documentation

◆ mode

Libpf::Utility::CutsSolution FlowSheet::mode

Mode used for solving the cuts in the flowsheet.

◆ myof_

ObjectiveNleAd* FlowSheet::myof_

protected

derived classes can supply their own additional equations and set this pointer in the constructor

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

FlowSheet.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FlowSheet()

◆ ~FlowSheet()

Member Function Documentation

◆ addCut()

◆ addStream()

◆ addUnit()

◆ calculate()

◆ calculateResidualsLocal()

◆ category()

◆ check()

◆ check_inout()

◆ energyBalance()

◆ go()

◆ initializeNonPersistents()

◆ inletConnection()

◆ inletIdFromPort()

◆ inletTag()

◆ INTEGER()

◆ INTEGERVECTOR()

◆ isAssignmentActive()

◆ isDag()

◆ isInletConnection()

◆ isOutletConnection()

◆ makeSequentialAssembly()

◆ makeUserEquations()

◆ massBalance()

◆ objectiveFunction()

◆ outletConnection()

◆ outletIdFromPort()

◆ outletTag()

◆ post()

◆ pre()

◆ printDot()

◆ printGraph()

◆ printPluggable()

◆ printSvg()

◆ QUANTITY() [1/2]

◆ QUANTITY() [2/2]

◆ removeCut()

◆ restoreCuts()

◆ sequential()

◆ setInputConnection()

◆ setMinSequential()

◆ setOutputConnection()

◆ setup()

◆ setup_of()

◆ solver()

◆ supportsSimultaneous()

Member Data Documentation

◆ mode

◆ myof_