|
| Decanter (Libpf::User::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
void | makeUserEquations (std::list< Assignment * >::iterator &p) |
| user will code here "specification" equation list for sequential calculation More...
|
|
virtual void | setup (void) |
| performs initializations required immediately before solution More...
|
|
virtual const std::string & | type (void) const |
|
void | pre (Calculatable::SolutionMode solutionMode, int level) |
|
void | post (Calculatable::SolutionMode solutionMode, int level) |
|
VertexBase::PortLocation | locationFromPort (std::string port) const |
|
| FlowSheet (Libpf::User::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
| ~FlowSheet (void) |
|
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) |
|
void | go (Calculatable::SolutionMode solutionMode, int level) final |
|
void | addUnit (const std::string &type, Libpf::User::Defaults defaults) |
|
void | addStream (const std::string &type, Libpf::User::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...
|
|
bool | isAssignmentActive (std::list< Assignment * >::iterator &q) const |
| 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) |
| returns a pointer to the model's objective function More...
|
|
SolverNleInterface * | solver (void) |
|
int | calculateResidualsLocal (void) |
| compute residuals and store into local vector y_; must be provided by implementations More...
|
|
void | setup_of (void) |
| set up problem size, pick up objective functions, assemble unknowns, residuals and scalers list More...
|
|
void | initializeNonPersistents (void) |
| estimates hidden, non-persistent unknowns from the current results More...
|
|
void | setup (void) |
| performs initializations required immediately before solution More...
|
|
void | check_inout (void) |
| Check flowsheet-level in- and out-flows. More...
|
|
bool | check (void) |
| Check connections in Edges and Vertexes. More...
|
|
Category | category (void) const |
| return model Category More...
|
|
void | printSvg (const char *fileName, bool tiny, bool raster, int offset) |
|
Value | massBalance (void) const |
|
Value | energyBalance (void) const |
|
void | printPluggable (void) const |
| diagnostic print More...
|
|
int | inletIdFromPort (const std::string &port) const |
|
const std::string & | inletTag (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 (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::User::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
void | translate (std::string &port) |
| translates port name from user-friendly synonyms into the canonical form, or leaves unchanged More...
|
|
virtual void | checkBalance (void) |
| call calculateBalance, then issue error/warning if required More...
|
|
Category | category (void) const |
| return model Category More...
|
|
void | printSvg (const char *fileName, bool tiny, bool raster, int offset) |
|
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::User::Defaults defaults, uint32_t id, Persistency *persistency, Persistent *parent, Persistent *root) |
|
bool | isPristine (void) const |
|
void | unSetInput (void) |
| wipes out all tags marked as inputs More...
|
|
void | reportMessages (void) |
| recursively collect status of all sub-objects and report to parent More...
|
|
void | resetErrors (void) |
|
void | setWarning (std::string s) |
| send new warning message to local queue More...
|
|
void | setError (std::string s) |
| send new error message to local queue More...
|
|
void | reportWarning (std::string s) |
| propagate warning message from sub-object to local queue More...
|
|
void | reportError (std::string s) |
| propagate error message from sub-object to local queue More...
|
|
void | setCalculated (void) |
| increments nCalculations counter and unsets pristinity More...
|
|
void | setPristineRecursive (void) |
| force next calculation to restart as if the model had never been calculated during this runtime session, also for all contained objects More...
|
|
void | setPristine (void) |
| force next calculation to restart as if the model had never been calculated during this runtime session More...
|
|
void | setRunTime (double t) |
| set the run time More...
|
|
void | stash (void) const |
|
void | applyStash (void) |
|
void | clearStash (void) const |
| clear the store cache More...
|
|
virtual int | maximumIterations (void) |
| returns default maximum iterations for main computation; defaults to 200 More...
|
|
std::ostream & | print (std::ostream &os, bool strings, bool quantities, bool integers, bool recursive) const |
|
std::ostream & | printFull (std::ostream &) const |
| print the model quantities, including derivative info, in text format to os More...
|
|
void | printHtml (const char *dir) const |
|
void | printSvgAll (const char *dir, bool tiny, bool raster, int offset, std::vector< std::string > &list) |
| Recursively output the model and all descendants in SVG format as separate id.SVG files in the directory dir. More...
|
|
virtual void | printXml (const char *dir, Model *precedingSibling, Model *followingSibling) const |
|
void | printXmlToc (std::ofstream &toc, int indent) const |
|
void | printOds (std::ofstream &ods) const |
|
| 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 |
|
| 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...
|
|
| 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, ScalingMode sm=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) |
| transforms back the vector of scaled variables x by applying the unscaling More...
|
|
int | calculateResiduals (std::vector< Value > &y, uint32_t offset) |
|
void | operator() (double *, double *, Jacobian *) |
| implements the () operator by calling calculateResidualsLocal and calculateResiduals; overrides ObjectiveNleAd::operator() More...
|
|
| ObjectiveNleAd (std::string t) |
| constructor More...
|
|
double | xmin (unsigned int i) |
| return the lower bound on unknown i More...
|
|
double | xmax (unsigned int i) |
| return the upper bound on unknown i More...
|
|
unsigned int | size (void) const |
| returns the current size of the problem More...
|
|
void | scalex (double *x) |
| transforms the vector of "real" variables x by applying the scaling More...
|
|
void | addUnknown (Value *x, Scaler scaler, const std::string &tag) |
|
void | changeUnknown (unsigned int i, Value *x, Scaler scaler, const std::string &tag) |
| change the i-th unknown More...
|
|
void | addObjectiveFunction (ObjectiveNleAd &of) |
| append the remote objective function More...
|
|
| ObjectiveNleAuto (std::string t) |
| constructor More...
|
|
bool | init (double *x) |
|
void | setValue (unsigned int i, double x) |
| copies the value for the i-th unknown from x in the Value pointed to, without altering the derivatives More...
|
|
void | copyresults (double *x) |
| copies the unknown values from the x vector into the Values pointed to More...
|
|
void | inactivate (void) |
| inactivates all unknowns More...
|
|
void | clearderivatives (void) |
| clears the derivative information for all unknowns without setting to inactive More...
|
|
void | setActive (unsigned int i) |
| activates the i-th unknown More...
|
|
void | operator() (double *, double *, Jacobian *J) |
| implements the () operator by calling calculateResiduals; derived class may override it More...
|
|
void | setx (unsigned int i, Value &x) |
| sets the i-th unknown to x More...
|
|
const Value & | unknown (unsigned int i) const |
| returns a reference to the i-th unknown More...
|
|
const std::string & | unknownTag (unsigned int i) const |
| returns a reference to the tag of the i-th unknown More...
|
|
double | xmin (unsigned int i) |
| return the lower bound on unknown i More...
|
|
double | xmax (unsigned int i) |
| return the upper bound on unknown i More...
|
|
void | print (void) const |
| lists unknowns More...
|
|
const std::string & | tagof (void) const |
| returns the tag of the instance More...
|
|
void | settagof (std::string t) |
| sets the tag of the instance More...
|
|
void | appendtagof (const std::string &t) |
| appends to the tag of the instance More...
|
|
int | zero_residuals (std::vector< Value > &y, uint32_t offset) |
|
void | addUnknown (Value *x, const std::string &tag) |
|
void | changeUnknown (unsigned int i, Value *x, const std::string &tag) |
| change the i-th unknown More...
|
|
| ObjectiveNleInterface (void) |
|
| Connectivity (Libpf::User::Defaults defaults, uint32_t id=0, Persistency *persistency=nullptr, Persistent *parent=nullptr, Persistent *root=nullptr) |
|
| ~Connectivity (void) |
|
void | attach (EdgeBase &edge, std::string &port) final |
|
void | detach (std::string port) final |
| Detaches the edge from the port with name "port". More...
|
|
bool | check (void) |
|
void | calculateBalance (void) |
| calculate cmdot, mdotin, mdotout, mdotcomps[] and cduty based on inlet/outlet streams More...
|
|
std::string | portInlet (int i) const |
|
std::string | portOutlet (int i) const |
|
bool | isInletConnected (int i) const |
|
bool | isOutletConnected (int i) const |
|
EdgeBase & | inlet (int i) |
|
EdgeBase & | outlet (int i) |
|
EdgeBase & | edgeFromPort (const std::string &port) |
|
void | printConnectivity (void) const |
| diagnostic print More...
|
|
|
enum | PortLocation { north,
south,
east,
west
} |
|
enum | SolutionMode { Null = 0,
sequential,
simultaneous,
singlePassSimultaneous
} |
|
void | setInputConnection (std::string port, std::string internalStream) |
|
void | setOutputConnection (std::string port, std::string internalStream) |
|
void | registerSynonym (std::string alias, std::string port) |
|
void | clearBalance (void) |
| used in calculateBalance, zeroes out the required variables More...
|
|
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 |
|
void | prepare_ (double *x, Jacobian *J) |
| uscales x (unknowns) values from calling function and puts them in x_ Quantities More...
|
|
void | packResults_ (double *x, double *y, Jacobian *J) |
|
| ~ObjectiveNleAd () |
|
| ~ObjectiveNleAuto () |
|
| ~ObjectiveNleInterface () |
|
void | inletRequired (int i) |
|
ObjectiveNleAd * | myof_ |
| derived classes can supply their own additional equations and set this pointer in the constructor More...
|
|
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...
|
|
std::map< std::string,
std::unique_ptr< Node > > | children_ |
| the collection of direct descendants More...
|
|
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...
|
|
int | verbosityInstance |
|
bool | set_ |
| true if setup_of has already been called More...
|
|
std::vector< Scaler > | scaler_ |
| provide scaling and unscaling More...
|
|
std::vector< Value > | residuals |
| Residuals. More...
|
|
std::vector< EdgeBase * > | inlets_ |
| inlet EdgeBase pointer vector More...
|
|
std::vector< EdgeBase * > | outlets_ |
| outlet EdgeBase pointer vector More...
|
|