Vertex model to represent a general purpose separator with many inlets and nOutlets >= 2 outlets. More...

#include <Separator.h>

Inheritance diagram for Separator:

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

	~Separator (void)

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

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

void	calculate (int level=0)

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

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

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

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

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

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

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

	~Connectivity (void)

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

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

bool	check (void)

void	calculateBalance (void)
	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 (int i) const

bool	isOutletConnected (int i) const

EdgeBase &	inlet (int i)

EdgeBase &	outlet (int i)

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

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

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

void	translate (std::string &port)
	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 Value	massBalance (void) const
	return should-be net mass balance of unit (inlet-outlet), defaults to zero and must be overridden if required More...

Category	category (void) const
	return model Category More...

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

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::User::Defaults defaults, uint32_t id, Persistency persistency, Persistent parent, Persistent *root)

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...

void	stash (void) const

void	applyStash (void)

void	clearStash (void) const
	clear the store cache More...

virtual int	maximumIterations (void)
	returns default maximum iterations for main computation; defaults to 200 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

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::User::Defaults defaults, uint32_t id=0, Persistency persistency=nullptr, Persistent parent=nullptr, Persistent *root=nullptr)

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

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

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

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

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

	~Object (void)

const std::string &	type (void) const

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

const RangeQuantities	quantities (void)

const ConstRangeQuantities	quantities (void) const

Public Member Functions inherited from Node
	Node (Libpf::User::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

	~Node ()

int	insert (Persistency *persistency) const

int	update (Persistency *persistency) const

void	restore (Persistency *persistency)

void	remove (Persistency *persistency) const

uint32_t	rootId (void) const

uint32_t	range (void) const

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

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

Node &	addChild (std::string type, Libpf::User::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

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

double	created_at (void) const

double	updated_at (void) const

void	updated_at (double u) const

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 (void)

const std::string &	tag (void) const

const std::string &	description (void) const

std::string	fullTag (void) const

const Persistent *	parent (void) const

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 ObjectiveNleAdVertex
	ObjectiveNleAdVertex (std::string t)
	constructor More...

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

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

void	operator() (double , double , Jacobian *)
	implements the () operator by calling calculateResidualsLocal and calculateResiduals; overrides ObjectiveNleAd::operator() 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
	returns the current size of the problem More...

void	scalex (double *x)
	transforms the vector of "real" variables x by applying the scaling 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...

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	operator() (double , double , Jacobian *J)
	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)

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)

Public Attributes
std::vector< std::vector < Quantity > >	outSplit

Quantity	T
	Temperature. More...

Quantity	P
	Pressure. More...

Quantity	duty
	Duty inlet - outlet. More...

Quantity	deltaP
	Overall pressure drop. More...

std::vector< Quantity >	deltaPstream
	Pressure drop for individual streams. More...

Quantity	flowcoefficient
	Flow coefficient. More...

Quantity	deltaPMax
	maximum allowable pressure drop More...

Quantity	beta
	Fraction of deltaPMax when the pressure drop limitation logic will start acting. More...

Quantity	Tavg
	Mass-weighted average inlet temperature. More...

std::vector< Quantity >	outSplitTotal
	Split fraction for all components. More...

String	option

Integer	nOutlets
	The number of outlets. More...

Public Attributes inherited from Connectivity
Integer	nIn
	Number of connected inlet EdgeBases (non-persistent); should not be set directly: use attach instead. More...

Integer	nOut
	Number of connected outlet EdgeBases (non-persistent); should not be set directly: use attach instead. More...

Integer	maxNIn
	Maximum number of connected inlet EdgeBases. More...

Integer	maxNOut
	Maximum number of connected outlet EdgeBases. More...

String	constraints
	Used internally to persist connectivity constraints. More...

Public Attributes inherited from VertexBase
Quantity	cmdot
	Cumulative mass flow, inlet - outlet. More...

Quantity	mdotin
	inlet mass flow More...

Quantity	mdotout
	outlet mass flow More...

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

Quantity	cduty
	Cumulative enthalpy flow, inlet - outlet. More...

Public Attributes inherited from Model
Integer	nCalculations
	number of times the model has been calculated More...

StringVector	errors
	errors from the last computation More...

StringVector	warnings
	warnings from the last computation More...

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

Public Attributes inherited from ObjectiveNleInterface
int	verbosityLocal

Static Public Attributes
static const std::string	type_

Protected Member Functions
void	testconnect_ (void)
	test consistency and stream connectedness; initialize inletstreams_ and outletstreams_ More...

void	normalize_ (void)
	normalize input outSplit More...

void	calculateFlows_ (void)

void	calculateSplits_ (void)
	calculate splits from outlet flows; fill in sum of inlets in ni_ beforehand More...

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

Protected Member Functions inherited from VertexBase
void	registerSynonym (std::string alias, 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::User::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::User::Defaults &defaults, uint32_t id, Persistency *persistency, std::string tag, int min, int max, int def=-1)

std::string	retrieveString (const Libpf::User::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 ObjectiveNleAd
void	prepare_ (double x, Jacobian J)
	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 Attributes
std::vector< Value >	ni_

std::vector< Value >	xi_

std::vector< Stream * >	inletstreams_
	Vector of pointers to the inlet streams. More...

std::vector< Stream * >	outletstreams_

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

std::vector< EdgeBase * >	outlets_
	outlet EdgeBase pointer vector 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...

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

Vertex model to represent a general purpose separator with many inlets and nOutlets >= 2 outlets.

The nOutlet option (the number of outlets) must be supplied at construction time and has default value 2.
Performs an arbitrary separation as specified.
Separation yields are fixed by setting the splits for all components in the
first nOutlets - 1 streams.

For example in the case of nOutlets == 2 and NCOMPONENTS == 3 :

Q("Spl.outSplit[0][0]").set(0.25);
Q("Spl.outSplit[0][1]").set(0.95);
Q("Spl.outSplit[0][2]").set(0.05);

these same variables can also be assigned:

MAKEASSIGNMENT(Q("Sep.outSplit[0][0]"), One - splitPar, "Separation of component 1 to stream 1"); \n
MAKEASSIGNMENT(Q("Sep.outSplit[0][1]"), One - splitPar, "Separation of component 2 to stream 1"); \n
MAKEASSIGNMENT(Q("Sep.outSplit[0][2]"), One - splitPar, "Separation of component 3 to stream 1"); \n

whereas outSplit[nOutlets - 1][*] are calculated and can neither be set nor be assigned.

List of ports:

in inlet to Separator
out1, out2, ... outlet of each stream from Separator

#include <libpf/units/Separator.h>

Remarks

Warning: Requires the list of components to be populated before the construction; Thread safe:; Extendable:; Platform dependencies:

Constructor & Destructor Documentation

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

Separator::~Separator ( void )

Member Function Documentation

void Separator::calculate ( int level = 0 )

virtual

calculates the model; implementations must call setCalculated

Parameters

level used for indenting, defaults to 0

Implements Model.

void Separator::calculateFlows_ ( void )

protected

calculate outlet flows from splits; ; fill in sum of inlets in ni_ beforehand and call normalize_ outlet streams totalflow and fracs will be filled in

virtual int Separator::calculateResidualsLocal ( void )

virtual

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

Implements ObjectiveNleAdVertex.

void Separator::calculateSplits_ ( void )

protected

calculate splits from outlet flows; fill in sum of inlets in ni_ beforehand

Value Separator::energyBalance ( void ) const

virtual

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

Reimplemented from VertexBase.

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

virtual

Calculate the Model

Parameters

simultaneous	true if the Model is to be solved during a simultaneous resolution of a larger set of equations
level	used for indenting

Implements Calculatable.

void Separator::initializeNonPersistents ( void )

inlinevirtual

estimates hidden, non-persistent unknowns from the current results

Implements Model.

void Separator::normalize_ ( void )

protected

normalize input outSplit

ObjectiveNleAd* Separator::objectiveFunction ( void )

inlinevirtual

returns a pointer to the model's objective function

Implements Model.

void Separator::setup ( void )

inlinevirtual

performs initializations required immediately before solution

Implements Model.

void Separator::setup_of ( void )

virtual

setup and resize appropriately internal vectors; must be provided by implementations

Implements ObjectiveNleAdVertex.

void Separator::testconnect_ ( void )

protected

test consistency and stream connectedness; initialize inletstreams_ and outletstreams_

virtual const std::string& Separator::type ( void ) const

inlinevirtual

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

Implements Item.

Member Data Documentation

Quantity Separator::beta

Fraction of deltaPMax when the pressure drop limitation logic will start acting.

Quantity Separator::deltaP

Overall pressure drop.

Quantity Separator::deltaPMax

maximum allowable pressure drop

std::vector<Quantity> Separator::deltaPstream

Pressure drop for individual streams.

Quantity Separator::duty

Duty inlet - outlet.

Quantity Separator::flowcoefficient

Flow coefficient.

std::vector<Stream *> Separator::inletstreams_

protected

Vector of pointers to the inlet streams.

std::vector<Value> Separator::ni_

protected

Integer Separator::nOutlets

The number of outlets.

String Separator::option

Pressure option: {D,P,K,S}

D assumes the overall deltaP is fixed
P assumes the outlet pressure is fixed (default)
K assumes the flowcoefficient is fixed
S assumes deltaPstream are fixed

std::vector<Stream *> Separator::outletstreams_

protected

Vector of pointers to the outlet streams

std::vector< std::vector<Quantity> > Separator::outSplit

std::vector<Quantity> Separator::outSplitTotal

Split fraction for all components.

Quantity Separator::P

Pressure.

Quantity Separator::T

Temperature.

Quantity Separator::Tavg

Mass-weighted average inlet temperature.

const std::string Separator::type_

static

std::vector<Value> Separator::xi_

protected

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

Separator.h

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation