Edge model for the mass and energy balance of a generic stream semi-abstract class Contains P, T and one Phase subobject: total phase.
More...
|
| Stream (Libpf::User::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
| GENERATE_COPY_MOVE_BASE (Stream) |
|
virtual | ~Stream (void) |
|
virtual MassBalanceMode | representation (void) const =0 |
| return default flow base More...
|
|
void | setup (void) |
| performs initializations required immediately before solution More...
|
|
Stream & | operator+= (const Stream &) |
|
Stream & | operator*= (const Value &factor) |
|
Stream & | operator/= (const Value &factor) |
|
PhaseM * | findPhase (const PhaseIndex &pid) |
| find phase identified by pid or return NULL More...
|
|
int | findPhaseIndex (const PhaseIndex &pid) const |
| find index of the phase identified by pid in the phases vector or return -1 More...
|
|
void | setphase (const PhaseIndex &p) |
| Sets the actual phase, copies current Tphase in the appropriate phases[?]. More...
|
|
PhaseType | ptype (int i) const |
| return phase type of phase i More...
|
|
PhaseIndex | pid (int i) const |
| return phase id of phase i More...
|
|
int | nphases (void) const |
| return number of phases More...
|
|
int | numberOfPhases (PhaseType pt) const |
| return number of phases of 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 (FlashMode fm=FlashMode::Null) |
|
virtual void | estimateFlash (void) |
|
virtual void | updateFlash (void) |
|
void | calculate (int level=0) |
|
void | initializeNonPersistents (void) |
| estimates hidden, non-persistent unknowns from the current results More...
|
|
void | go (Calculatable::SolutionMode solutionMode, int level) |
|
void | prepare_residuals (void) |
| 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) |
|
void | estimateEos (const Value &Pres, const Value &Temp) |
| estimate eos roots-related unknowns More...
|
|
void | calculateX (const MassBalanceMode &mb) |
|
void | calculateXnoFlash (const MassBalanceMode &mb) |
|
const Value & | calculateTotalP (const Value &rho) const |
|
const Value & | calculateTotalRho (void) const |
| calculates total molar density for all phases in kmol/m3 More...
|
|
const Value & | calculateTotalH (void) const |
| calculates molar enthalpy for all phases in J/kmol based on current values of the hidden unknowns More...
|
|
const Value & | calculateTotalS (void) const |
| 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) |
|
| EdgeBase (Libpf::User::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
Category | category (void) const |
| return model Category More...
|
|
virtual std::string | svgColor (void) const |
|
virtual double | svgWidth (void) const |
|
| 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...
|
|
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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| Diagnostic (void) |
|
void | setVerbosity (int verbosity) |
| sets the verbosity level for this instance More...
|
|
int | verbosity (void) const |
|
| Precedence (void) |
|
| ~Precedence (void) |
|
void | initLock (void) |
| invoke while in parallel section More...
|
|
void | set (void) |
|
void | unSet (void) |
|
void | destroy (void) |
|
| FlashBase (void) |
|
void | setIdeal (bool i) |
|
bool | isIdeal (void) |
|
virtual SolverNleInterface * | solver (void)=0 |
|
virtual int | niter (void) const =0 |
| return Flash iterations More...
|
|
virtual void | estimate (const Value &Pres, const Value &Temp)=0 |
|
const Value & | Temperature (void) const |
|
const Value & | Pressure (void) const |
|
virtual const Value & | Fraction (PhaseIndex p) const =0 |
|
virtual Vector | X (PhaseIndex p) const =0 |
|
virtual const Value & | Sumx (PhaseIndex p) const =0 |
|
virtual bool | converged (void) const =0 |
| returns true if the flash has been solved successfully, More...
|
|
|
void | addVariables (void) |
|
PhaseM * | addPhase (std::string type, std::string tag, std::string description, int index, Persistency *persistency) |
|
void | postconstruct_ (int cid) |
|
virtual void | precompute_isIdeal (void) |
|
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) |
|
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...
|
|
int | offset (void) const |
|
virtual void | prepare_Flash_residuals (void)=0 |
|
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 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 |
|
Edge model for the mass and energy balance of a generic stream semi-abstract class Contains P, T and one Phase subobject: total phase.
#include <libpf/streams/Stream.h>
- Warning
- Requires the list of components to be populated before the construction
-
Thread safe:
-
Extendable:
-
Platform dependencies: