StreamSimple< NV, NL, NS > Class Template Reference
#include <StreamSimple.h>
Inheritance diagram for StreamSimple< NV, NL, NS >:
Public Member Functions | |
StreamSimple (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) | |
GENERATE_COPY_MOVE (StreamSimple) | |
GENERATE_COPY_MOVE_DERIVED (StreamSimple, Stream) | |
~StreamSimple (void) | |
const std::string & | type (void) const override |
ObjectiveNleAd * | objectiveFunction (void) override |
returns a pointer to the model's objective function More... | |
int | calculateResidualsEquilibrium (std::vector< Value > &, uint32_t) override |
implement FlashBase virtual More... | |
Public Member Functions inherited from StreamBaseSimple | |
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... | |
Stream & | operator+= (const Stream &) |
Stream & | operator*= (const Value &factor) |
Stream & | operator/= (const Value &factor) |
Phase::Mass * | findPhase (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 Value & | calculateTotalP (const Value &rho) const override |
const Value & | calculateTotalRho (void) const override |
calculates total molar density for all phases in kmol/m3 More... | |
const Value & | calculateTotalH (void) const override |
calculates molar enthalpy for all phases in J/kmol based on current values of the hidden unknowns More... | |
const Value & | calculateTotalS (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 Value & | phase_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 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 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 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 (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 Value & | Sumx (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 Value & | phase_fraction (Phase::Mass *phase) const =0 |
Public Member Functions inherited from Flash | |
Flash (void) | |
int | niter (void) const override |
return Flash iterations More... | |
void | prepare_Flash_residuals (void) override |
Value | calculateResidualsPressure (void) |
virtual Value | calculateResidualsFlashMode (void) |
virtual void | clip_ (void) |
int | calculateResiduals (std::vector< Value > &y, uint32_t offset) override |
void | estimate (const Value &Pres, const Value &Temp) override |
const Value & | Fraction (Libpf::Utility::PhaseIndex p, bool clip) const override |
during Flash iterations use this function to get the actual estimate of the fraction of phase p More... | |
Vector | X (Libpf::Utility::PhaseIndex p) const override |
const Value & | Sumx (Libpf::Utility::PhaseIndex p) const override |
void | estimateEquilibrium (const Value &Pres, const Value &Temp) override |
estimate equilibrium-related unknowns More... | |
SolverNleInterface * | solver (void) override |
bool | converged (void) const override |
returns true if the flash has been solved successfully, 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... | |
Static Public Attributes | |
static const std::string | type_ |
Additional Inherited Members | |
Public Types inherited from Calculatable | |
enum | SolutionMode { Null = 0 , sequential , simultaneous , singlePassSimultaneous } |
Public Attributes inherited from Stream | |
Phase::Mass * | Tphase |
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... | |
Public Attributes inherited from ObjectiveNleInterface | |
int | verbosityLocal |
Protected Member Functions inherited from Stream | |
void | addVariables (void) |
Phase::Mass * | addPhase (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... | |
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 |
Protected Member Functions inherited from FlashBase | |
virtual | ~FlashBase ()=default |
virtual const Value & | calculateTotalP (const Value &rho) const =0 |
virtual const Value & | calculateTotalRho (void) const =0 |
calculates total molar density for all phases in kmol/m3 More... | |
virtual const Value & | calculateTotalH (void) const =0 |
calculates molar enthalpy for all phases in J/kmol based on current values of the hidden unknowns More... | |
virtual const Value & | calculateTotalS (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 Member Functions inherited from Flash | |
void | setFlash_ (const Libpf::Utility::FlashMode &fm, const Value &x, const Value &y, bool strict=true) override |
Set the stream's state variables and the Flash. More... | |
int | solveFlash (bool simultaneous, bool skip) override |
std::string | message (int code) override |
void | setup_ (std::vector< Value * > pbeta_, std::vector< const double * > pbetamin_, std::vector< const double * > pbetamax_) override |
void | calculateInertSolids (const std::vector< Quantity > &totalx, std::vector< Quantity > &inertx, MutableVector fluidx, Value &inertfraction, Value &fluidfraction) |
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 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 | |
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 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... | |
Protected Attributes inherited from Flash | |
Value | sumx_ |
sum of molar fractions, or liquid phase molar fractions for multiphase derived classes More... | |
std::vector< Quantity > * | remotex_ |
SolverNle | NLEFlash_ |
Newton solver for the Flash. 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... | |
Static Protected Attributes inherited from Stream | |
static double | minFlow_ |
Detailed Description
template<int NV, int NL, int NS>
class StreamSimple< NV, NL, NS >
class StreamSimple< NV, NL, NS >
stream with 0 or 1 vapor, 0 or 1 or 2 or 3 liquids, 0 to 9 solid phases all of type PhaseSimple
Supported StreamSimple template:
- StreamSimple<0, 1, 0> also named as StreamSimpleLiquid
- StreamSimple<0, 0, 1> also named as StreamSimpleSolid
- StreamSimple<1, 0, 0> also named as StreamSimpleVapor
- StreamSimple<0, 1, 1> also named as StreamSimpleLiquidSolid
- StreamSimple<1, 1, 1> also named as StreamSimpleLiquidSolidVapor
#include <libpf/streams/StreamSimple.h>
- Remarks
- Warning
- Requires the list of components to be populated before the construction
- Support only mass balances
- See also
- StreamBaseSimple
- Warning
- Thread safe:
- Extendable:
- Platform dependencies:
Constructor & Destructor Documentation
◆ StreamSimple()
template<int NV, int NL, int NS>
StreamSimple< NV, NL, NS >::StreamSimple | ( | Libpf::Persistency::Defaults | defaults, |
uint32_t | id = 0 , |
||
Persistency * | persistency = nullptr , |
||
Persistent * | parent = nullptr , |
||
Persistent * | root = nullptr |
||
) |
◆ ~StreamSimple()
template<int NV, int NL, int NS>
StreamSimple< NV, NL, NS >::~StreamSimple | ( | void | ) |
Member Function Documentation
◆ calculateResidualsEquilibrium()
template<int NV, int NL, int NS>
|
overridevirtual |
◆ GENERATE_COPY_MOVE()
template<int NV, int NL, int NS>
StreamSimple< NV, NL, NS >::GENERATE_COPY_MOVE | ( | StreamSimple< NV, NL, NS > | ) |
◆ GENERATE_COPY_MOVE_DERIVED()
template<int NV, int NL, int NS>
StreamSimple< NV, NL, NS >::GENERATE_COPY_MOVE_DERIVED | ( | StreamSimple< NV, NL, NS > | , |
Stream | |||
) |
◆ objectiveFunction()
template<int NV, int NL, int NS>
|
overridevirtual |
returns a pointer to the model's objective function
Implements Model.
◆ type()
template<int NV, int NL, int NS>
|
overridevirtual |
Member Data Documentation
◆ type_
template<int NV, int NL, int NS>
|
static |
The documentation for this class was generated from the following file: