|
| CompressionStage (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
void | setup (void) override |
| performs initializations required immediately before solution More...
|
|
const std::string & | type (void) const override |
|
void | makeUserEquations (std::list< Assignment * >::iterator &) override |
| user will code here "specification" equation list for sequential calculation More...
|
|
void | pre (Calculatable::SolutionMode solutionMode, int level) override |
|
void | post (Calculatable::SolutionMode solutionMode, int level) override |
|
| FlowSheet (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
| ~FlowSheet (void) |
|
| INTEGERVECTOR (enableAssignment, "Enable Assignment", 0, 0) |
|
| INTEGER (NITER, "Number of iterations for flowsheet cuts convergence", -1) |
|
| QUANTITY (seqTol, "Tolerance for sequential modular mode", 1e-6, "") |
|
| QUANTITY (seqErr, "Current error for sequential modular mode", 1e-6, "") |
|
void | addCut (std::string s) |
| makes the stream with tag s a cut stream, allocates a new stream with tag s+"bis" with same type as s, reconnects More...
|
|
void | removeCut (std::string s) |
| deletes the cut stream with tag s+"bis" and reconnects stream s as required More...
|
|
void | restoreCuts (void) |
| recursively restore cut streams More...
|
|
void | calculate (int level=0) override |
|
void | go (Calculatable::SolutionMode solutionMode, int level) override final |
|
virtual void | pre (Calculatable::SolutionMode solutionMode, int level)=0 |
|
virtual void | post (Calculatable::SolutionMode solutionMode, int level)=0 |
|
void | addUnit (const std::string &type, Libpf::Persistency::Defaults defaults) |
|
void | addStream (const std::string &type, Libpf::Persistency::Defaults defaults, const std::string &from, const std::string &port_from, const std::string &to, const std::string &port_to) |
| non-template variant, see #236 More...
|
|
void | makeSequentialAssembly (std::list< Assignment * >::iterator &p) |
| build equations associated with sequential mode solution (cut streams) More...
|
|
virtual void | makeUserEquations (std::list< Assignment * >::iterator &p)=0 |
| user will code here "specification" equation list for sequential calculation More...
|
|
bool | isAssignmentActive (std::list< Assignment * >::iterator &q) const override |
| will be implemented in Model-aware derived class More...
|
|
virtual int | sequential (void) |
|
void | setMinSequential (int minSequential) |
|
virtual bool | supportsSimultaneous (void) |
| returns true if flowsheet can be solved in simultaneous mode; defaults to true More...
|
|
ObjectiveNleAd * | objectiveFunction (void) override |
| returns a pointer to the model's objective function More...
|
|
SolverNleInterface * | solver (void) |
|
int | calculateResidualsLocal (void) override |
| compute residuals and store into local vector y_; must be provided by implementations More...
|
|
void | setup_of (void) override |
| set up problem size, pick up objective functions, assemble unknowns, residuals and scalers list More...
|
|
void | initializeNonPersistents (void) override |
| estimates hidden, non-persistent unknowns from the current results More...
|
|
void | setup (void) override |
| performs initializations required immediately before solution More...
|
|
void | check_inout (void) |
| Check flowsheet-level in- and out-flows. More...
|
|
bool | check (void) override |
| Check connections in Edges and Vertexes. More...
|
|
Libpf::Utility::Category | category (void) const override |
| return model Category More...
|
|
void | printSvg (const char *fileName, bool tiny, bool raster, int offset) override |
|
Value | massBalance (void) const override |
|
Value | energyBalance (void) const override |
|
void | printPluggable (void) const |
| diagnostic print More...
|
|
int | inletIdFromPort (const std::string &port) const |
|
const std::string & | inletTag (unsigned int i) const |
|
int | inletConnection (const std::string &tag) const |
|
bool | isInletConnection (const std::string &tag) const |
|
int | outletIdFromPort (const std::string &port) const |
|
const std::string & | outletTag (unsigned int i) const |
|
int | outletConnection (const std::string &tag) const |
|
bool | isOutletConnection (const std::string &tag) const |
|
bool | isDag (void) const |
| Returns true if the graph is a Directed Acyclic Graph (DAG) More...
|
|
void | printDot (const char *s, int id=0) const |
|
void | printGraph (std::ostream &os) const |
| print Vertex and Edge lists to os More...
|
|
| VertexBase (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
| QUANTITY (cmdot, "Cumulative mass flow inlet minus outlet", one, "kg/s") |
|
| QUANTITY (mdotin, "inlet mass flow", one, "kg/s") |
|
| QUANTITY (mdotout, "outlet mass flow", one, "kg/s") |
|
| QUANTITY (cduty, "Cumulative enthalpy flow inlet minus outlet", one, "W") |
|
virtual void | attach (EdgeBase &edge, std::string &port) |
|
virtual void | detach (std::string port) |
| Detaches the edge from the port with name "port". More...
|
|
virtual bool | check (void)=0 |
| Checks the connectivity for this instance of VertexBase and returns true if something is out of order. More...
|
|
void | translate (std::string &s) |
| translates port name from user-friendly synonyms into the canonical form, or leaves unchanged More...
|
|
virtual void | checkBalance (void) |
| call calculateBalance, then issue error/warning if required More...
|
|
virtual void | calculateBalance (void)=0 |
| calculate cmdot, mdotin, mdotout, mdotcomps[] and cduty based on inlet/outlet streams More...
|
|
virtual Value | massBalance (void) const |
| return should-be net mass balance of unit (inlet-outlet), defaults to zero and must be overridden if required More...
|
|
virtual Value | energyBalance (void) const |
| return should-be net energy balance of unit (inlet-outlet), defaults to zero and must be overridden if required More...
|
|
Libpf::Utility::Category | category (void) const override |
| return model Category More...
|
|
void | printSvg (const char *fileName, bool tiny, bool raster, int offset) override |
|
virtual PortLocation | locationFromPort (std::string port) const |
|
PortLocation | locationFromEdge (std::string edgeTag) const |
|
const std::string & | edgeFromPort (const std::string &port) const |
|
const std::string & | portFromEdge (const std::string &edgeTag) const |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| Diagnostic (void) |
|
void | setVerbosity (int verbosity) |
| sets the verbosity level for this instance More...
|
|
int | verbosity (void) const |
|
| Task (void) |
|
| ~Task (void) |
|
double | cost (void) const |
|
int | level (void) const |
|
int | core (void) const |
| get the core where this task is scheduled or -1 if not yet scheduled More...
|
|
double | startTime (void) const |
| return forecast start time More...
|
|
double | endTime (void) const |
| return forecast end time More...
|
|
void | setLevel (int l) |
|
void | setCore (int c) |
|
double | setStartTime (double t) |
| sets the start time and returns the end time More...
|
|
virtual void | go (SolutionMode solutionMode, int level)=0 |
|
| SequentialAssembly (void) |
| Lifecycle. More...
|
|
| ~SequentialAssembly (void) |
|
double | deltaseq (void) const |
|
int | neqs (void) const |
| returns the number of Assignments More...
|
|
void | wegsteinstep (void) |
| Substitutes RHS into *LHSP for all Assignments. More...
|
|
void | directstep (void) |
| Updates *LHSP with RHS using Wegstein accelerated direct substitution for all Assignments. More...
|
|
void | makeAssignment (std::list< Assignment * >::iterator &p, Value &lhs, Value rhs, std::string tag, std::string rhsstring, int i, Libpf::Utility::ScalingMode sm=Libpf::Utility::ScalingMode::noscaling, double xmin=0.0, double xmax=1.0, Value factor=One) |
|
void | addCut (std::string name, Stream *in, Stream *out) |
|
void | removeCut (std::string tag) |
|
Assignment * | operator<< (Assignment *ep) |
| includes a new Assignment to the corresponding collection More...
|
|
void | print (void) const |
|
void | purgeAss (void) |
| delete all equations More...
|
|
void | setDamping (double d) |
| set damping coefficient for direct substitution More...
|
|
double | damping (void) const |
| returns current value of the damping coefficient for direct substitution More...
|
|
void | setMaxChange (double c) |
| set maximum relative step change for direct substitution More...
|
|
double | maxChange (void) const |
| returns current value of maximum relative step change for direct substitution More...
|
|
| ObjectiveNleAdFlowsheet (std::string t) |
| constructor More...
|
|
| ~ObjectiveNleAdFlowsheet (void) |
|
| ObjectiveNleAdVertex (std::string t) |
| constructor More...
|
|
void | unscalex (double *x) override |
| transforms back the vector of scaled variables x by applying the unscaling More...
|
|
int | calculateResiduals (std::vector< Value > &y, uint32_t offset) override |
|
void | operator() (double *, double *, Jacobian *) override |
| implements the () operator by calling calculateResidualsLocal and calculateResiduals; overrides ObjectiveNleAd::operator() More...
|
|
virtual int | calculateResidualsLocal (void)=0 |
| compute residuals and store into local vector y_; must be provided by implementations More...
|
|
virtual void | setup_of (void)=0 |
| setup and resize appropriately internal vectors; must be provided by implementations More...
|
|
| 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...
|
|
| 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...
|
|
| 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...
|
|
| Connectivity (Libpf::Persistency::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
| ~Connectivity (void) |
|
| INTEGER (nIn, "Number of connected inlet EdgeBases", 0) |
| should not be set directly: use attach instead More...
|
|
| INTEGER (nOut, "Number of connected outlet EdgeBases", 0) |
| should not be set directly: use attach instead More...
|
|
| INTEGER (maxNIn, "Maximum number of connected inlet EdgeBases or -1 for unlimited", -1) |
|
| INTEGER (maxNOut, "Maximum number of connected outlet EdgeBases or -1 for unlimited", -1) |
|
| STRING (constraints, "Used internally to persist connectivity constraints", "") |
|
void | attach (EdgeBase &edge, std::string &port) override final |
|
void | detach (std::string port) override final |
| Detaches the edge from the port with name "port". More...
|
|
bool | check (void) override |
|
void | calculateBalance (void) override |
| calculate cmdot, mdotin, mdotout, mdotcomps[] and cduty based on inlet/outlet streams More...
|
|
std::string | portInlet (int i) const |
|
std::string | portOutlet (int i) const |
|
bool | isInletConnected (unsigned int i) const |
|
bool | isOutletConnected (unsigned int i) const |
|
EdgeBase & | inlet (unsigned int i) |
|
EdgeBase & | outlet (unsigned int i) |
|
EdgeBase & | edgeFromPort (const std::string &port) |
|
void | printConnectivity (void) const |
| diagnostic print More...
|
|