StreamBaseSimple Class Reference

#include <StreamSimple.h>

Inheritance diagram for StreamBaseSimple:

Public Member Functions

 StreamBaseSimple (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr)
 
Libpf::Utility::MassBalanceMode representation (void) const override
 return default flow base More...
 
void updateFlash (void) override
 override stream and calculate the phase split More...
 
- Public Member Functions inherited from Stream
 Stream (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr)
 
 GENERATE_COPY_MOVE_BASE (Stream)
 
virtual ~Stream (void)
 
 QUANTITY (T, "Temperature", 298.15, "K")
 
 QUANTITY (P, "Pressure", 101325, "Pa")
 
 INTEGER (NITER_NLEFlash, "Number of iterations for Flash", -1)
 
 STRING (flowoption, "Feed stream flow configuration", "Nx")
 
 STRING (flashoption, "Feed stream Flash configuration", "PT")
 
virtual Libpf::Utility::MassBalanceMode representation (void) const =0
 return default flow base More...
 
void setup (void) override
 performs initializations required immediately before solution More...
 
Streamoperator+= (const Stream &)
 
Streamoperator*= (const Value &factor)
 
Streamoperator/= (const Value &factor)
 
Phase::MassfindPhase (const Libpf::Utility::PhaseIndex &pid)
 find phase identified by pid or return the nullptr More...
 
int findPhaseIndex (const Libpf::Utility::PhaseIndex &pid) const
 find index of the phase identified by pid in the phases vector or return -1 More...
 
void setphase (const Libpf::Utility::PhaseIndex &p)
 Sets the actual phase, copies current Tphase in the appropriate phases[?]. More...
 
Libpf::Utility::PhaseType phaseType (int i) const
 return phase type of phase i More...
 
Libpf::Utility::PhaseIndex phaseIndex (int i) const
 return phase id of phase i More...
 
int nphases (void) const
 return number of phases More...
 
int numberOfPhases (Libpf::Utility::PhaseType pt) const
 return number of phases of Libpf::Utility::PhaseType pt More...
 
void scale (const Value &factor=One)
 multiply the Stream extensive properties by factor More...
 
void setEquimolar ()
 
void setEquimass ()
 
void setPure (int i)
 
void setImpure (int i, double eps)
 
void setEquimolarNoKey (int i)
 
void setEquimassNoKey (int i)
 
void setSymmetrical (double eps)
 
void setAsymmetrical (bool increasing, double eps)
 
void clearComposition (void)
 
virtual void setFlash (Libpf::Utility::FlashMode fm=Libpf::Utility::FlashMode::Null)
 
virtual void estimateFlash (void)
 
virtual void updateFlash (void)
 
void calculate (int level=0) override
 
void initializeNonPersistents (void) override
 initialize Flash unknowns More...
 
void go (Calculatable::SolutionMode solutionMode, int level) override
 
void prepare_residuals (void) override
 call only if there is no iterative algorithm than changes the phases' compositions (such as FlashVl::x_ and y_ More...
 
int calculateResidualsEos (std::vector< Value > &y, uint32_t offset) override
 
void estimateEos (const Value &Pres, const Value &Temp) override
 estimate eos roots-related unknowns More...
 
void calculateX (const Libpf::Utility::MassBalanceMode &mb)
 
void calculateXnoFlash (const Libpf::Utility::MassBalanceMode &mb)
 
const ValuecalculateTotalP (const Value &rho) const override
 
const ValuecalculateTotalRho (void) const override
 calculates total molar density for all phases in kmol/m3 More...
 
const ValuecalculateTotalH (void) const override
 calculates molar enthalpy for all phases in J/kmol based on current values of the hidden unknowns More...
 
const ValuecalculateTotalS (void) const override
 calculates molar entropy for all phases in J/kmol/K based on current values of the hidden unknowns More...
 
Value dhvl (const Value &T) const
 molar heat of vaporization as linear molar fraction based average of the pure routes.heats of vaporization More...
 
void setMaximumIterations (int m)
 
const std::vector< Phase::Mass * > & phases (void) const override
 
const Valuephase_fraction (Phase::Mass *phase) const override
 
- Public Member Functions inherited from EdgeBase
 EdgeBase (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr)
 
 STRING (fromTAG, "Tag of source Vertex", "source")
 
 STRING (toTAG, "Tag of destination Vertex", "sink")
 
 STRING (fromPort, "Tag of port description for source", "out")
 
 STRING (toPort, "Tag of port description for destination", "in")
 
 STRING (cutsource, "TAG of source of cut stream", "")
 
 STRING (cutdest, "TAG of dest of cut stream", "")
 
Libpf::Utility::Category category (void) const override
 return model Category More...
 
virtual std::string svgColor (void) const
 
virtual double svgWidth (void) 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 ObjectiveNleAdobjectiveFunction (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...
 
Nodeoperator= (const Node &) override
 copy assignment operator More...
 
Nodeoperator= (Node &&other) override
 move assignment More...
 
 ~Object (void)
 
const std::string & type (void) const override
 
Objectat (const std::string &fullRelativeTag)
 
const Objectat (const std::string &fullRelativeTag) const
 
Objectat (const std::string &fullRelativeTag, int index)
 
const ValueQ (const std::string &tag) const
 
const ValueQ (const std::string &tag, int index) const
 
const ValueQ (const std::string &tag, int row, int column) const
 
ValueQ (const std::string &tag)
 
ValueQ (const std::string &tag, int index)
 
ValueQ (const std::string &tag, int row, int column)
 
const ValueQ (const std::string &tag, std::string componentName) const
 
ValueQ (const std::string &tag, std::string componentName)
 
const ValueQ (const std::string &tag, int index, std::string componentName) const
 
ValueQ (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< Nodeclone (void) const
 
virtual Nodeoperator= (const Node &other)
 copy assignment operator copies all elements but root which is set to nullptr More...
 
virtual Nodeoperator= (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...
 
NodeaddChild (std::string type, uint32_t id, Persistency *persistency)
 
NodeaddChild (std::string type, Libpf::Persistency::Defaults defaults)
 
NodeaddChild (const Node &child)
 
NodeaddChild (std::unique_ptr< Node > child)
 
std::unique_ptr< Nodeprune (const std::string &tag)
 
const Nodechild (const std::string &tag) const
 
Nodeat (const std::string &fullRelativeTag)
 
const Nodeat (const std::string &fullRelativeTag) const
 
uint32_t descendants (void) const
 
Persistentroot (void) const
 
void renameChild (const std::string &oldName, const std::string &newName)
 
bool existsChild (std::string tag) const
 
bool exists (uint32_t id)
 
Nodesearch (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...
 
Persistentoperator= (const Persistent &)
 copy assignment More...
 
 Persistent (Persistent &&other)
 move constructor More...
 
Persistentoperator= (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...
 
Itemoperator= (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...
 
Itemoperator= (Item &&other)
 move assignment operator More...
 
virtual ~Item ()
 
const std::string & tag () const
 
const std::string & description () const
 
std::string fullTag () const
 
const Persistentparent () 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 Precedence
 Precedence (void)
 
 ~Precedence (void)
 
void initLock (void)
 invoke while in parallel section More...
 
void set (void)
 
void unSet (void)
 
void destroy (void)
 
virtual void go (SolutionMode solutionMode, int level)=0
 
- Public Member Functions inherited from FlashBase
 FlashBase (void)
 
void setIdeal (bool i)
 
bool isIdeal (void)
 
virtual SolverNleInterfacesolver (void)=0
 
virtual int niter (void) const =0
 return Flash iterations More...
 
virtual void estimate (const Value &Pres, const Value &Temp)=0
 
const ValueTemperature (void) const
 
const ValuePressure (void) const
 
virtual const ValueFraction (Libpf::Utility::PhaseIndex p, bool clip=false) const =0
 during Flash iterations use this function to get the actual estimate of the fraction of phase p More...
 
virtual Vector X (Libpf::Utility::PhaseIndex p) const =0
 
virtual const ValueSumx (Libpf::Utility::PhaseIndex p) const =0
 
virtual bool converged (void) const =0
 returns true if the flash has been solved successfully, More...
 
virtual const std::vector< Phase::Mass * > & phases (void) const =0
 
virtual const Valuephase_fraction (Phase::Mass *phase) const =0
 

Additional Inherited Members

- Public Types inherited from Calculatable
enum  SolutionMode { Null = 0 , sequential , simultaneous , singlePassSimultaneous }
 
- Public Attributes inherited from Stream
Phase::MassTphase
 
std::vector< Phase::Mass * > phases_
 vector of phases to hold internal values for the phase fractions and molar compositions More...
 
- Public Attributes inherited from Precedence
int weight
 for backTrack_ and findCycles More...
 
- Protected Member Functions inherited from Stream
void addVariables (void)
 
Phase::MassaddPhase (std::string type, std::string tag, std::string description, unsigned int index, Persistency *persistency)
 
void postconstruct_ (int cid)
 
virtual void precompute_isIdeal (void)
 
- 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...
 
Objectoperator= (const Object &)
 copy assignment operator More...
 
Objectoperator= (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
 
- Protected Member Functions inherited from FlashBase
virtual ~FlashBase ()=default
 
virtual const ValuecalculateTotalP (const Value &rho) const =0
 
virtual const ValuecalculateTotalRho (void) const =0
 calculates total molar density for all phases in kmol/m3 More...
 
virtual const ValuecalculateTotalH (void) const =0
 calculates molar enthalpy for all phases in J/kmol based on current values of the hidden unknowns More...
 
virtual const ValuecalculateTotalS (void) const =0
 calculates molar entropy for all phases in J/kmol/K based on current values of the hidden unknowns More...
 
virtual void prepare_residuals (void)=0
 
virtual void prepare_Flash_residuals (void)=0
 
virtual int calculateResidualsEos (std::vector< Value > &y, uint32_t offset)=0
 
virtual void estimateEos (const Value &Pres, const Value &Temp)=0
 estimate eos roots-related unknowns More...
 
virtual int calculateResidualsEquilibrium (std::vector< Value > &y, uint32_t offset)=0
 
virtual void estimateEquilibrium (const Value &Pres, const Value &Temp)=0
 estimate equilibrium-related unknowns More...
 
virtual void setFlash_ (const Libpf::Utility::FlashMode &fm, const Value &x, const Value &y, bool strict=true)=0
 Set the stream's state variables and the Flash. More...
 
virtual int solveFlash (bool simultaneous, bool skip)=0
 
virtual std::string message (int code)=0
 
virtual void setup_ (std::vector< Value * > pbeta_, std::vector< const double * > pbetamin_, std::vector< const double * > pbetamax_)=0
 
- Protected Member Functions inherited from StreamInterface
virtual ~StreamInterface ()=default
 
- Protected Attributes inherited from Stream
int vphases_
 number of vapor phases More...
 
int lphases_
 number of liquid phases More...
 
int sphases_
 number of solid phases 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
Persistentparent_
 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 FlashBase
Libpf::Utility::FlashMode fm_
 
bool zero_residuals_
 used to skip Flash residuals calculations if stream is empty More...
 
Value T_
 Temperature, unknown. More...
 
Value P_
 Pressure, unknown. More...
 
Value Pset_
 specified pressure, Pa More...
 
Value Tset_
 specified temperature, K More...
 
Value Hset_
 specified molar enthalpy, J/kmol More...
 
Value Sset_
 specified molar entropy, J/(kmol*K) More...
 
Value rhoset_
 specified molar density, kmol/m3 More...
 
- Static Protected Attributes inherited from Stream
static double minFlow_
 

Detailed Description

sharp separations: each component ends up in a definite PhaseIndex It does only mass balances thus all other models (unit operations, reactions, ...) must define mass parameters.

It support only "Mw" ans "M" as flowoption

i.e. for a stream "S01":

Q("S01:Tphase.mdot")->set(1000.0, "kg/h");

my_cast<Stream *>(O("S01"),CURRENT_FUNCTION)->clearComposition();

Q("S01:Tphase.w", 0)->set(0.95);

Q("S01:Tphase.w", 1)->set(0.05);

Q("S01:Tphase.w", 2)->set(0.0);

i.e.: for a flashdrum "RX" with 1 reaction

O("RX:reactions", 0)->I("keycomp")->set(1);

*O("RX:reactions", 0)->Q("coeffm", "Water") = 0.0;

*O("RX:reactions", 0)->Q("coeffm", "Table Salt") = -1.0;

*O("RX:reactions", 0)->Q("coeffm", "Pepper") = 1.0;

#include <libpf/streams/StreamSimple.h>

Remarks
Warning
Requires the list of components to be populated before the construction
Support only mass balances
Thread safe:
Extendable:
Platform dependencies:

Constructor & Destructor Documentation

◆ StreamBaseSimple()

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

Member Function Documentation

◆ representation()

Libpf::Utility::MassBalanceMode StreamBaseSimple::representation ( void  ) const
inlineoverridevirtual

return default flow base

Implements Stream.

◆ updateFlash()

void StreamBaseSimple::updateFlash ( void  )
overridevirtual

override stream and calculate the phase split

Reimplemented from Stream.


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