Skip to content

Refusals

The specific reasons a request, a revision, a solve or a project is refused, named inside an API error, a validation check or a failed run. How to read an explanation, and how to ask for one (openflowsheet explain <code>, the explain operation), is on Messages.

ASSESSMENT_OBJECTIVE_UNSCALED: Assessment objective unscaled

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: assessment objective unscaled.

ASSESSMENT_OUTPUT_UNAVAILABLE: Assessment output unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: assessment output unavailable.

ASSESSMENT_OUTPUT_UNKNOWN: Assessment output unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: assessment output unknown.

ASSESSMENT_PARAMETER_DECISION: Assessment parameter decision

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: assessment parameter decision.

ASSESSMENT_PARAMETER_STRUCTURAL: Assessment parameter structural

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: assessment parameter structural.

ASSESSMENT_REGIME_INADMISSIBLE: Assessment regime inadmissible

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: assessment regime inadmissible.

BARE_MODULE_FACTOR_MISSING: Bare module factor missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: bare module factor missing.

BOUNDS_UNDECLARED: Bounds undeclared

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: bounds undeclared.

CORRELATION_OUT_OF_RANGE: Correlation out of range

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: correlation out of range.

DECISION_INCONSISTENT_WITH_ELIMINATED_ROWS: Decision inconsistent with eliminated rows

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: decision inconsistent with eliminated rows.

DECISION_NOT_CONTINUOUS: A decision that is not one continuous parameter

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: A decision of the optimisation request does not set exactly one flowsheet parameter of its own across its bounds, so it cannot be varied continuously.

DECISION_UNIT_NOT_INTERNAL: Decision bounds not in the SI unit of their quantity

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: The bounds of a decision in the optimisation request are not given in the SI unit of its specification's quantity, the only unit the request accepts for them.

ESCALATION_SERIES_MISSING: Escalation series missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: escalation series missing.

EXCHANGE_RATE_UNAVAILABLE: Exchange rate unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: exchange rate unavailable.

HESSIAN_UNAVAILABLE: Hessian unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: hessian unavailable.

IDENTITY_MISMATCH: Identity mismatch

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: identity mismatch.

INCONSISTENT_WITH_ELIMINATED_ROWS: Inconsistent with eliminated rows

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: inconsistent with eliminated rows.

INDEX_YEAR_UNAVAILABLE: Index year unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: index year unavailable.

NLP_SOLVER_UNAVAILABLE: Nlp solver unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: nlp solver unavailable.

NO_CORRELATION: No correlation

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: no correlation.

OPTIMIZATION_ROUTE_UNAVAILABLE: A revision not on the route optimisation needs

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: This version optimises only a revision that solves on the revision_eo route, as one system of equations; this revision solves on another route, which the message names.

PARAMETER_NOT_DIFFERENTIABLE: Parameter not differentiable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter not differentiable.

PHASE_BOUNDARY: Phase boundary

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase boundary.

PROJECTION_DOF: Projection dof

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection dof.

PROJECTION_IMPLICIT_EF_INPUT: Projection implicit ef input

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection implicit ef input.

PROJECTION_NONSMOOTH: Projection nonsmooth

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection nonsmooth.

PROJECTION_OMITTED_ROW_UNCERTIFIED: Projection omitted row uncertified

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection omitted row uncertified.

PROJECTION_SCALES_UNAVAILABLE: Projection scales unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection scales unavailable.

PROJECTION_STRUCTURE: Projection structure

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection structure.

PROJECTION_ZERO_FLOW: Projection zero flow

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection zero flow.

REGIME_MARGIN_UNDEFINED: A start at which a unit's distance from a phase change is undefined

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: At this start the optimiser cannot measure how far a unit is from changing phase, so it cannot hold that unit in its phase and cannot use this start.

REGIME_MARGIN_UNSUPPORTED: Regime margin unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: regime margin unsupported.

REGULARITY_INCONCLUSIVE: Regularity inconclusive

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: regularity inconclusive.

REVISION_MISMATCH: An optimisation request written for another revision

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: The optimisation request names, by its SHA-256, a revision other than the one being optimised.

REVISION_UNBOUND: A revision that cannot be set up for optimisation

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: The revision could not be set up as a flowsheet to solve, so it cannot be optimised; the code in parentheses names the reason.

ROOT_NOT_CONVERGED: Root not converged

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: root not converged.

ROOT_NOT_VERIFIED: Root not verified

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: root not verified.

SIMULATION_NOT_READY: Simulation not ready

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: simulation not ready.

START_NOT_CERTIFIED: Start not certified

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: start not certified.

START_OUTSIDE_BOUNDS: Start outside bounds

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: start outside bounds.

TOO_MANY_STARTS: A start count outside 1 to 32

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: The optimisation request asks for no start or for more than 32; a request has 1 to 32 starts in all, counting the revision's own values, the explicit starts and the Halton points.

TRSP_SOLVER_UNAUDITED: Trsp solver unaudited

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: trsp solver unaudited.

TRUST_REGION_FRAMEWORK_UNAVAILABLE: Trust region framework unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: trust region framework unavailable.

TRUST_REGION_FRAMEWORK_UNPINNED: Trust region framework unpinned

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: trust region framework unpinned.

TWIN_MISMATCH: Twin mismatch

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: twin mismatch.

UNKNOWN_DECISION: Unknown decision

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: unknown decision.

UNKNOWN_PARAMETER: Unknown parameter

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: unknown parameter.

UNKNOWN_VARIABLE: Unknown variable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: unknown variable.

acceptance_item_unattributed: Acceptance item unattributed

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: acceptance item unattributed.

acceptance_undefined: Acceptance undefined

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: acceptance undefined.

active_set_cycling: Active set cycling

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: active set cycling.

ambient_pressure_invalid: An ambient pressure that cannot be declared

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The ambient pressure was not declared: its <part> is not accepted (<value> <unit>).
  • Why: The ambient pressure is the absolute pressure gauge readings are measured from, so it must be a finite pressure above zero, written in an absolute unit: Pa, kPa, MPa, bar, atm or psi. A gauge unit (barg, psig) cannot declare it, and other spellings (bara, mmHg) are not accepted. Nothing is assumed in its place, and the project file is left as it was.
  • Do: Declare it again with a finite value above zero in one of Pa, kPa, MPa, bar, atm or psi, for example --pressure 1.01325 --unit bar.
  • Parameters: part (text), value (text, optional), unit (text, optional)
  • See also: ambient_pressure_undeclared

Example:

The ambient pressure was not declared: the value -1.0 is not a finite pressure above zero in bar.
  Why:     The ambient pressure is the absolute pressure gauge readings are measured from, so it must be a finite pressure above zero, written in an absolute unit: Pa, kPa, MPa, bar, atm or psi. A gauge unit (barg, psig) cannot declare it, and other spellings (bara, mmHg) are not accepted. Nothing is assumed in its place, and the project file is left as it was.
  Do:      Declare it again with a finite value above zero in one of Pa, kPa, MPa, bar, atm or psi, for example --pressure 1.01325 --unit bar.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    ambient_pressure_invalid (openflowsheet explain ambient_pressure_invalid)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#ambient_pressure_invalid

Example:

The ambient pressure was not declared: the unit barg is not an absolute pressure unit it can be written in.
  Why:     The ambient pressure is the absolute pressure gauge readings are measured from, so it must be a finite pressure above zero, written in an absolute unit: Pa, kPa, MPa, bar, atm or psi. A gauge unit (barg, psig) cannot declare it, and other spellings (bara, mmHg) are not accepted. Nothing is assumed in its place, and the project file is left as it was.
  Do:      Declare it again with a finite value above zero in one of Pa, kPa, MPa, bar, atm or psi, for example --pressure 1.01325 --unit bar.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    ambient_pressure_invalid (openflowsheet explain ambient_pressure_invalid)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#ambient_pressure_invalid

ambient_pressure_undeclared: A gauge display unit in a project without an ambient pressure

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Pressures cannot be shown as gauge pressures in <unit>: the project has no declared ambient pressure.
  • Where: the request member display_units
  • Why: A gauge pressure is the absolute pressure minus the ambient pressure of the site. OpenFlowsheet never assumes an ambient pressure (not even one standard atmosphere): it uses the one the project declares, and this project declares none.
  • Do: Ask the project's operator to declare it with openflowsheet project ambient --project DIR --pressure VALUE --unit UNIT, or show pressures in an absolute unit such as bar.
  • Parameters: kind (text), unit (text, optional)
  • See also: ambient_pressure_invalid, display_units_invalid

Example:

Pressures cannot be shown as gauge pressures in barg: the project has no declared ambient pressure.
  Why:     A gauge pressure is the absolute pressure minus the ambient pressure of the site. OpenFlowsheet never assumes an ambient pressure (not even one standard atmosphere): it uses the one the project declares, and this project declares none.
  Do:      Ask the project's operator to declare it with openflowsheet project ambient --project DIR --pressure VALUE --unit UNIT, or show pressures in an absolute unit such as bar.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    ambient_pressure_undeclared (openflowsheet explain ambient_pressure_undeclared)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#ambient_pressure_undeclared

basis_mismatch: Basis mismatch

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: basis mismatch.

basis_premises_unmet: Basis premises unmet

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: basis premises unmet.

basis_unavailable: Basis unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: basis unavailable.

block_energy_refused: Block energy refused

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: block energy refused.

carried_split_inconsistent: Carried split inconsistent

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: carried split inconsistent.

carried_split_missing: Carried split missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: carried split missing.

certificate_unmapped: Certificate unmapped

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: certificate unmapped.

checkpoint_incompatible: Checkpoint incompatible

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: checkpoint incompatible.

closure_route: Closure route

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: closure route.

closure_type_unknown: Closure type unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: closure type unknown.

component_unknown: Component unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: component unknown.

components_unsupported: Components unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: components unsupported.

connection_kind_unsupported: Connection kind unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: connection kind unsupported.

continuation_level: Continuation level

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: continuation level.

declaration_mismatch: Declaration mismatch

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: declaration mismatch.

directory_not_empty: The directory holds files that are not a project

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Directory <directory> is not empty and does not hold a project; a project needs a new or empty directory.
  • Why: OpenFlowsheet will not mix a project with other files, and exist_ok=True opens only an existing project.
  • Do: Choose a new directory name, or empty this directory first.
  • Parameters: directory (directory)

Example:

Directory 'notes' is not empty and does not hold a project; a project needs a new or empty directory.
  Why:     OpenFlowsheet will not mix a project with other files, and exist_ok=True opens only an existing project.
  Do:      Choose a new directory name, or empty this directory first.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    directory_not_empty (openflowsheet explain directory_not_empty)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#directory_not_empty

display_unit_unsupported: A display unit this version does not offer for the kind

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: Values of kind <kind> cannot be shown in <unit>: the unit is not one this version offers for that kind.
  • Where: the request member display_units
  • Why: Each quantity kind is shown in its SI unit or in one of a fixed list of units, each spelled exactly as in the input table: degC, not °C or celsius; bar or barg, not bara. Some kinds, such as molar heat capacity, have no display units besides SI in this version.
  • Do: Use one of the units the units guide lists for <kind>, spelled exactly, or the kind's SI unit to show it unconverted.
  • Parameters: kind (text), unit (text, optional)
  • Not supported:
  • See also: display_units_invalid

Example:

Values of kind temperature cannot be shown in celsius: the unit is not one this version offers for that kind.
  Why:     Each quantity kind is shown in its SI unit or in one of a fixed list of units, each spelled exactly as in the input table: degC, not °C or celsius; bar or barg, not bara. Some kinds, such as molar heat capacity, have no display units besides SI in this version.
  Do:      Use one of the units the units guide lists for temperature, spelled exactly, or the kind's SI unit to show it unconverted.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    display_unit_unsupported (openflowsheet explain display_unit_unsupported)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#display_unit_unsupported

Example:

Values of kind molar_heat_capacity cannot be shown in kJ/(mol K): the unit is not one this version offers for that kind.
  Why:     Each quantity kind is shown in its SI unit or in one of a fixed list of units, each spelled exactly as in the input table: degC, not °C or celsius; bar or barg, not bara. Some kinds, such as molar heat capacity, have no display units besides SI in this version.
  Do:      Use one of the units the units guide lists for molar_heat_capacity, spelled exactly, or the kind's SI unit to show it unconverted.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    display_unit_unsupported (openflowsheet explain display_unit_unsupported)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#display_unit_unsupported

display_units_invalid: A display units preference that cannot be read

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The display units preference was not read: item <index> (<item>) is not a preset or a kind=unit pair it accepts.
  • Where: the request member display_units
  • Why: display_units is a comma-separated list read left to right. The first item may be a preset (si or eng); every other item is kind=unit, where kind is a quantity kind such as temperature or molar_flow, named at most once. An unknown kind, a missing '=' or unit, a preset after the first item, or a kind named twice is refused, and nothing is converted.
  • Do: Write display_units as an optional preset followed by kind=unit items, for example eng,temperature=degF; the units guide lists the kinds and their units.
  • Parameters: index (number), item (text, optional)
  • See also: display_unit_unsupported, ambient_pressure_undeclared

Example:

The display units preference was not read: item 0 (temp=degC) is not a preset or a kind=unit pair it accepts.
  Why:     display_units is a comma-separated list read left to right. The first item may be a preset (si or eng); every other item is kind=unit, where kind is a quantity kind such as temperature or molar_flow, named at most once. An unknown kind, a missing '=' or unit, a preset after the first item, or a kind named twice is refused, and nothing is converted.
  Do:      Write display_units as an optional preset followed by kind=unit items, for example eng,temperature=degF; the units guide lists the kinds and their units.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    display_units_invalid (openflowsheet explain display_units_invalid)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#display_units_invalid

Example:

The display units preference was not read: item 1.000 (eng) is not a preset or a kind=unit pair it accepts.
  Why:     display_units is a comma-separated list read left to right. The first item may be a preset (si or eng); every other item is kind=unit, where kind is a quantity kind such as temperature or molar_flow, named at most once. An unknown kind, a missing '=' or unit, a preset after the first item, or a kind named twice is refused, and nothing is converted.
  Do:      Write display_units as an optional preset followed by kind=unit items, for example eng,temperature=degF; the units guide lists the kinds and their units.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    display_units_invalid (openflowsheet explain display_units_invalid)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#display_units_invalid

dormancy_form_configuration_unknown: Dormancy form configuration unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: dormancy form configuration unknown.

dormancy_form_disagrees: Dormancy form disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: dormancy form disagrees.

efficiency_outside_interval: Efficiency outside interval

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: efficiency outside interval.

endpoint_missing: Endpoint missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: endpoint missing.

energy_balance_undefined: The energy balance of this unit model is not checked

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: The energy balance of unit <unit> (<model>) is not given: the solution's certificate holds no energy check for it.
  • Where: unit <unit>
  • Why: The stream table reports a unit's energy balance only where the certificate of the solution holds an energy check for that unit. Units of this model carry none (an external or coupled unit, for example), so the unit's duty, work and stream enthalpy flows are reported, but its balance is not.
  • Do: Use a unit model whose energy balance is checked if you need this balance; the stream values around <unit> are unaffected.
  • Parameters: unit (unit), model (text)
  • Not supported: missing capability: an energy balance check for this unit's model
  • See also: stream_enthalpy_absent

Example:

The energy balance of unit 'X1' (external.coupled) is not given: the solution's certificate holds no energy check for it.
  Why:     The stream table reports a unit's energy balance only where the certificate of the solution holds an energy check for that unit. Units of this model carry none (an external or coupled unit, for example), so the unit's duty, work and stream enthalpy flows are reported, but its balance is not.
  Do:      Use a unit model whose energy balance is checked if you need this balance; the stream values around 'X1' are unaffected.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    energy_balance_undefined (openflowsheet explain energy_balance_undefined)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#energy_balance_undefined

energy_reads_undeclared: Energy reads undeclared

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: energy reads undeclared.

exchanger_specification: Exchanger specification

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: exchanger specification.

external_refused: External refused

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: external refused.

external_results_reevaluated: External results reevaluated

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: external results reevaluated.

external_results_replayed_from_record: External results replayed from record

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: external results replayed from record.

external_runner_unavailable: External runner unavailable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: external runner unavailable.

failure_bundle_unmapped: Failure bundle unmapped

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: failure bundle unmapped.

flash_failed: The phase split of a stream could not be computed

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

  • Summary: The phase split of stream <stream> at its temperature and pressure could not be computed (status <status>).
  • Where: stream <stream>
  • Why: For a stream whose phases are neither declared nor carried by the solution, the stream table finds them with an equilibrium flash at the stored temperature and pressure. That flash did not succeed, so the phases of <stream> and the values per phase are not given; its flows, temperature and pressure are.
  • Do: Check that the temperature and pressure of <stream> lie in the range the property basis covers. A phase declared for the stream lets the table evaluate it without a flash.
  • Parameters: stream (stream), status (text, optional)
  • See also: stream_enthalpy_absent

Example:

The phase split of stream 'S3' at its temperature and pressure could not be computed (status failed).
  Why:     For a stream whose phases are neither declared nor carried by the solution, the stream table finds them with an equilibrium flash at the stored temperature and pressure. That flash did not succeed, so the phases of 'S3' and the values per phase are not given; its flows, temperature and pressure are.
  Do:      Check that the temperature and pressure of 'S3' lie in the range the property basis covers. A phase declared for the stream lets the table evaluate it without a flash.
  Kind:    Numerical failure: the solver did not find the solution; your flowsheet may be correct.
  Code:    flash_failed (openflowsheet explain flash_failed)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#flash_failed

homotopy_stalled: Homotopy stalled

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: homotopy stalled.

id_duplicate: Id duplicate

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: id duplicate.

id_unsupported: Id unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: id unsupported.

inadmissible_endpoint: Inadmissible endpoint

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: inadmissible endpoint.

inadmissible_inlet: Inadmissible inlet

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: inadmissible inlet.

inadmissible_phase: Inadmissible phase

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: inadmissible phase.

infeasible_spec: A column specification outside what the column can deliver

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: a column specification asks for more than the column can deliver at these conditions (for example more product than the feed holds).

initial_state_incomplete: Initial state incomplete

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: initial state incomplete.

initialization_failed: Initialization failed

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: initialization failed.

initializer_failed: The first pass over the flowsheet stopped at a unit

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

  • Summary: The first pass over the flowsheet could not compute every unit (it stopped at <unit>).
  • Why: Before iterating, OpenFlowsheet computes every unit once, in flow order; this pass stopped.
  • Do: Read the cause; if none is given, supply an initial guess for the recycle streams.
  • Parameters: unit (element)

Example:

The first pass over the flowsheet could not compute every unit (it stopped at 'T').
  Why:     Before iterating, OpenFlowsheet computes every unit once, in flow order; this pass stopped.
  Do:      Read the cause; if none is given, supply an initial guess for the recycle streams.
  Kind:    Numerical failure: the solver did not find the solution; your flowsheet may be correct.
  Code:    initializer_failed (openflowsheet explain initializer_failed)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#initializer_failed

instance_missing: Instance missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: instance missing.

instances_missing: Instances missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: instances missing.

invalid_spec: Invalid spec

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: invalid spec.

inverse_specification_not_reached: Inverse specification not reached

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: inverse specification not reached.

isentropic_state_single_phase: A machine whose ideal outlet is single-phase, unlike its declared outlet

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: The machine <unit> needs a case this version does not support: its ideal (isentropic) outlet state is single-phase, not the phase declared for its outlet.
  • Why: This version computes a machine's ideal outlet in the phase declared for the real outlet. Here the outlet is declared wet ("vapor_liquid") but the ideal outlet lies outside the two-phase region, or, where the fluid has no two-phase region at the outlet pressure, the ideal outlet is of another phase than the one declared. This is a limitation of the software, not an error in your flowsheet.
  • Do: Declare the outlet with the phase its ideal state has (for example vapour when the ideal state is superheated) if the real outlet has that phase too; otherwise change the operating conditions until the ideal and the real outlet are in the same phase.
  • Parameters: unit (unit, optional)
  • Not supported: missing capability: an ideal (isentropic) outlet of another phase than the declared outlet
  • See also: isentropic_state_two_phase, phase_regime_mismatch

Example:

The solve stopped before its first iteration: unit 'T' could not compute its outlets from the starting values.
  Cause:   The machine 'T' needs a case this version does not support: its ideal (isentropic) outlet state is single-phase, not the phase declared for its outlet.
  Why:     This version computes a machine's ideal outlet in the phase declared for the real outlet. Here the outlet is declared wet ("vapor_liquid") but the ideal outlet lies outside the two-phase region, or, where the fluid has no two-phase region at the outlet pressure, the ideal outlet is of another phase than the one declared. This is a limitation of the software, not an error in your flowsheet.
  Do:      Declare the outlet with the phase its ideal state has (for example vapour when the ideal state is superheated) if the real outlet has that phase too; otherwise change the operating conditions until the ideal and the real outlet are in the same phase.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    isentropic_state_single_phase, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain isentropic_state_single_phase)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#isentropic_state_single_phase

Example:

The machine needs a case this version does not support: its ideal (isentropic) outlet state is single-phase, not the phase declared for its outlet.
  Why:     This version computes a machine's ideal outlet in the phase declared for the real outlet. Here the outlet is declared wet ("vapor_liquid") but the ideal outlet lies outside the two-phase region, or, where the fluid has no two-phase region at the outlet pressure, the ideal outlet is of another phase than the one declared. This is a limitation of the software, not an error in your flowsheet.
  Do:      Declare the outlet with the phase its ideal state has (for example vapour when the ideal state is superheated) if the real outlet has that phase too; otherwise change the operating conditions until the ideal and the real outlet are in the same phase.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    isentropic_state_single_phase (openflowsheet explain isentropic_state_single_phase)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#isentropic_state_single_phase

isentropic_state_two_phase: A turbine whose ideal outlet would be wet while its outlet is declared vapour

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: Unit <unit> needs a case this version does not support: its outlet <outlet> is declared vapour, but its ideal (isentropic) outlet state would be wet.
  • Why: This version computes a turbine's ideal outlet in the phase declared for the real outlet. Here the ideal outlet entropy <s_star> is below the saturated-vapour entropy <s_saturated> at <pressure>, so the ideal state is two-phase. This is a limitation of the software (L-TH-4), not an error in your flowsheet.
  • Do: Re-declare the outlet <outlet> as wet ("vapor_liquid") if it can be wet at your conditions. If that is refused as a phase mismatch, change the operating conditions (for example the turbine inlet temperature or outlet pressure) until the ideal and the real outlet are in the same phase. Support for this case is planned (the std.turbine model).
  • Parameters: unit (unit), outlet (stream, optional), phase (enum, optional), s_star (quantity, optional), s_saturated (quantity, optional), pressure (quantity, optional)
  • Not supported: limitation L-TH-4 (its row in the support matrix); missing capability: a vapour turbine outlet with a two-phase isentropic reference
  • See also: phase_regime_mismatch, L-TH-4

Example:

The solve stopped before its first iteration: unit 'T' could not compute its outlets from the starting values.
  Cause:   Unit 'T' needs a case this version does not support: its outlet 'S4' is declared vapour, but its ideal (isentropic) outlet state would be wet.
  Why:     This version computes a turbine's ideal outlet in the phase declared for the real outlet. Here the ideal outlet entropy 140.2 J/(mol*K) is below the saturated-vapour entropy 146.3 J/(mol*K) at 10000 Pa, so the ideal state is two-phase. This is a limitation of the software (L-TH-4), not an error in your flowsheet.
  Do:      Re-declare the outlet 'S4' as wet ("vapor_liquid") if it can be wet at your conditions. If that is refused as a phase mismatch, change the operating conditions (for example the turbine inlet temperature or outlet pressure) until the ideal and the real outlet are in the same phase. Support for this case is planned (the std.turbine model).
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    isentropic_state_two_phase, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain isentropic_state_two_phase)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#isentropic_state_two_phase

kernel_disagrees: Kernel disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: kernel disagrees.

kernel_refused: Kernel refused

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: kernel refused.

legacy_route_not_admitted: Legacy route not admitted

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: legacy route not admitted.

lifted_split_definition_disagrees: Lifted split definition disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split definition disagrees.

lifted_split_equilibrium_disagrees: Lifted split equilibrium disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split equilibrium disagrees.

lifted_split_key_collision: Lifted split key collision

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split key collision.

lifted_split_rows_disagree: Lifted split rows disagree

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split rows disagree.

lifted_split_unregistered: Lifted split unregistered

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split unregistered.

lifted_split_variables_absent: Lifted split variables absent

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split variables absent.

lifted_split_without_rows: Lifted split without rows

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: lifted split without rows.

missing_initial_guess: Missing initial guess

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: missing initial guess.

model_unsupported: No model with this id is available

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: No model with the id "<model>" is available in this version.
  • Why: Each unit names the model that computes it. This version computes only the models it lists, and a unit's model id must match one of them exactly, prefix included (for example thermal.heater).
  • Do: Compare the unit's model id with the available models (the list_models operation, or openflowsheet api list_models): correct its spelling, or choose a listed model that does what the unit needs.
  • Parameters: model (text)
  • Not supported: missing capability: a unit model with this id
  • See also: revision_not_ready

Example:

No model with the id "thermal.boiler" is available in this version.
  Why:     Each unit names the model that computes it. This version computes only the models it lists, and a unit's model id must match one of them exactly, prefix included (for example thermal.heater).
  Do:      Compare the unit's model id with the available models (the list_models operation, or openflowsheet api list_models): correct its spelling, or choose a listed model that does what the unit needs.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    model_unsupported (openflowsheet explain model_unsupported)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#model_unsupported

model_variant_mismatch: Model variant mismatch

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: model variant mismatch.

multiple_steady_states_possible: Multiple steady states possible

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: multiple steady states possible.

near_critical: Near critical

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: near critical.

nlp_solver_unavailable: Optimisation without the audited NLP solver

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: This installation cannot optimise: the audited NLP solver is not available here.
  • Why: Optimisation solves with Ipopt, reached through Pyomo and cyipopt, in the versions whose licences and binaries were audited: the nlp extra's audited environment on Linux x86-64. Without it this version refuses to optimise rather than run an unaudited solver.
  • Do: To optimise, use the audited nlp environment on Linux x86-64 (user guide, section "The nlp extra"); to check the revision for a solve, validate it with the task "simulation".
  • Not supported: limitation L-OPT-1 (its row in the support matrix); missing capability: optimisation outside the audited nlp environment on Linux x86-64
  • See also: unsupported

Example:

This installation cannot optimise: the audited NLP solver is not available here.
  Why:     Optimisation solves with Ipopt, reached through Pyomo and cyipopt, in the versions whose licences and binaries were audited: the nlp extra's audited environment on Linux x86-64. Without it this version refuses to optimise rather than run an unaudited solver.
  Do:      To optimise, use the audited nlp environment on Linux x86-64 (user guide, section "The nlp extra"); to check the revision for a solve, validate it with the task "simulation".
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    nlp_solver_unavailable, in unsupported (openflowsheet explain nlp_solver_unavailable)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#nlp_solver_unavailable

no_saturation: No saturation

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: no saturation.

not_a_directory: The path is a file, not a directory

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: <directory> is a file, not a directory; a project needs a new or empty directory.
  • Why: A project is a directory that holds its database and its files, so it cannot be made at the path of an existing file.
  • Do: Choose another path for the project, or move or rename the file.
  • Parameters: directory (directory)
  • See also: project_exists, directory_not_empty

Example:

'plant.txt' is a file, not a directory; a project needs a new or empty directory.
  Why:     A project is a directory that holds its database and its files, so it cannot be made at the path of an existing file.
  Do:      Choose another path for the project, or move or rename the file.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    not_a_directory (openflowsheet explain not_a_directory)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#not_a_directory

not_a_project: The directory does not hold a project

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Directory <directory> is not a project: it holds no project database.
  • Why: Opening a project reads the database (project.sqlite3) that creating the project wrote into its directory. This directory has none: it was never made a project, or it is not the directory you meant.
  • Do: Check the path: give the directory the project was created in, or create a new project here.
  • Parameters: directory (directory)
  • See also: project_exists

Example:

Directory 'plant' is not a project: it holds no project database.
  Why:     Opening a project reads the database (project.sqlite3) that creating the project wrote into its directory. This directory has none: it was never made a project, or it is not the directory you meant.
  Do:      Check the path: give the directory the project was created in, or create a new project here.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    not_a_project (openflowsheet explain not_a_project)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#not_a_project

not_converged: Not converged

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: not converged.

opening_not_settled: Opening not settled

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: opening not settled.

out_of_domain: A state outside the range of the property method

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: A property calculation for unit <unit> was asked for a state outside the range its property method covers.
  • Why: A property method is valid only over a stated range of temperature and pressure, and outside it OpenFlowsheet stops instead of extrapolating. The method reported: <detail>. For example, water's IAPWS-95 method in this version covers 273.16 K to 1273.15 K and 100 Pa to 100 MPa.
  • Do: Check the temperatures and pressures specified for the streams that reach <unit>, for example a feed below the freezing point, and bring them inside the property method's range; the limitations page lists the range of each method.
  • Parameters: unit (unit, optional), detail (text, optional), what (text, optional), value (quantity, optional), low (quantity, optional), high (quantity, optional)
  • See also: initializer_failed

Example:

The solve stopped before its first iteration: unit 'P' could not compute its outlets from the starting values.
  Cause:   A property calculation for unit 'P' was asked for a state outside the range its property method covers.
  Why:     A property method is valid only over a stated range of temperature and pressure, and outside it OpenFlowsheet stops instead of extrapolating. Here the temperature 200.0 K is outside the method's range of 273.2 K to 1273 K.
  Do:      Check the temperatures and pressures specified for the streams that reach 'P', for example a feed below the freezing point, and bring them inside the property method's range; the limitations page lists the range of each method.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    out_of_domain, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain out_of_domain)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#out_of_domain

Example:

The solve stopped: no step along its search direction reduced the error.
  Cause:   A property calculation for unit 'B' was asked for a state outside the range its property method covers.
  Why:     A property method is valid only over a stated range of temperature and pressure, and outside it OpenFlowsheet stops instead of extrapolating. For example, water's IAPWS-95 method in this version covers 273.16 K to 1273.15 K and 100 Pa to 100 MPa.
  Do:      The solver reached a state outside the property method's range at unit 'B' while iterating; the specified states may all be inside it. Give initial guesses closer to the expected solution, or check the specifications that drive the solve towards that state; the limitations page lists the range of each method.
  Kind:    Numerical failure: the solver did not find the solution; your flowsheet may be correct.
  Code:    out_of_domain, in LINE_SEARCH_FAILED (openflowsheet explain out_of_domain)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#out_of_domain

parameter_kind_unsupported: Parameter kind unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter kind unsupported.

parameter_missing: Parameter missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter missing.

parameter_quantity_invalid: Parameter quantity invalid

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter quantity invalid.

parameter_unit_unsupported: Parameter unit unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter unit unsupported.

parameter_unreadable: Parameter unreadable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter unreadable.

parameter_unsupported: Parameter unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter unsupported.

parameter_value_unsupported: Parameter value unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: parameter value unsupported.

ph_outside_domain: Ph outside domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: ph outside domain.

phase_boundary_on_path: Phase boundary on path

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase boundary on path.

phase_capability_missing: Phase capability missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase capability missing.

phase_capability_unsupported: Phase capability unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase capability unsupported.

phase_contract_unsupported: Phase contract unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase contract unsupported.

phase_disappeared: Phase disappeared

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase disappeared.

phase_not_stable: Phase not stable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase not stable.

phase_regime_mismatch: Declared phase does not match the computed state

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Stream <stream> is not in its declared phase: it is declared <declared>, but at these conditions it is <landed>.
  • Where: stream <stream>, an outlet of unit <unit> (<unit_model>)
  • Why: Each stream carries a declared phase, and a unit computes its outlet only in that phase.
  • Do: Change the phase declared for <stream> to the one that matches the computed state.
  • Parameters: stream (stream), unit (unit, optional), declared (enum, optional), landed (enum, optional), vapour_fraction (number, optional), property (enum, optional), value (quantity, optional), saturated_liquid (quantity, optional), saturated_vapour (quantity, optional), pressure (quantity, optional)
  • See also: isentropic_state_two_phase, L-TH-3

Example:

The solve stopped before its first iteration: unit 'T' could not compute its outlets from the starting values.
  Cause:   Stream 'S4' is not in its declared phase: it is declared wet (vapour + liquid), but at these conditions it is vapour.
  Why:     At 10000 Pa the enthalpy of 'S4' is 47330 J/mol, above the saturated-vapour value 46570 J/mol, so the stream is vapour, not wet (vapour + liquid).
  Do:      Declare 'S4' as vapour. If you expected wet (vapour + liquid), check the specifications that set the conditions upstream of 'S4'.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    phase_regime_mismatch, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain phase_regime_mismatch)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#phase_regime_mismatch

phase_update: Phase update

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase update.

phase_wall: Phase wall

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: phase wall.

pin_conflict: Pin conflict

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: pin conflict.

pin_missing: Pin missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: pin missing.

plan_refused: Plan refused

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: plan refused.

policy_unsupported_on_route: Policy unsupported on route

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: policy unsupported on route.

port_direction_conflict: Port direction conflict

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port direction conflict.

port_direction_unsupported: Port direction unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port direction unsupported.

port_multiplicity_unsupported: Port multiplicity unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port multiplicity unsupported.

port_not_single: Port not single

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port not single.

port_phase_ambiguous: Port phase ambiguous

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port phase ambiguous.

port_phase_unsupported: Port phase unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port phase unsupported.

port_unconnected: Port unconnected

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port unconnected.

port_unsupported: Port unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port unsupported.

port_unwired: Port unwired

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: port unwired.

pressure_fall: An outlet pressure below the inlet pressure of a machine that can only raise it

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The outlet pressure specified for unit <unit>, a <machine>, is below its inlet pressure (<p_spec> against <p_inlet>).
  • Why: A pump or a compressor does work on the fluid to raise its pressure, so its outlet pressure cannot be below its inlet pressure. Lowering the pressure takes a valve or a turbine.
  • Do: Give the <machine> <unit> an outlet pressure at or above its inlet pressure of <p_inlet>, or lower the pressure upstream of it.
  • Parameters: machine (text), p_spec (quantity, optional), p_inlet (quantity, optional), unit (unit, optional)
  • See also: pressure_rise

Example:

The solve stopped before its first iteration: unit 'P' could not compute its outlets from the starting values.
  Cause:   The outlet pressure specified for unit 'P', a pump, is below its inlet pressure (50000 Pa against 100000 Pa).
  Why:     A pump or a compressor does work on the fluid to raise its pressure, so its outlet pressure cannot be below its inlet pressure. Lowering the pressure takes a valve or a turbine.
  Do:      Give the pump 'P' an outlet pressure at or above its inlet pressure of 100000 Pa, or lower the pressure upstream of it.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    pressure_fall, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain pressure_fall)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#pressure_fall

pressure_outside_domain: Pressure outside domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: pressure outside domain.

pressure_rise: An outlet pressure above the inlet pressure of a unit that can only lower it

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The outlet pressure specified for unit <unit>, a <machine>, is above its inlet pressure (<p_spec> against <p_inlet>).
  • Why: A turbine expands the fluid that passes through it, so it can only lower the pressure. Raising the pressure takes a pump or a compressor.
  • Do: Give the <machine> <unit> an outlet pressure at or below its inlet pressure of <p_inlet>, or raise the pressure upstream of it (for example a pump's outlet pressure).
  • Parameters: machine (text), unit (unit, optional), p_spec (quantity, optional), p_inlet (quantity, optional)

Example:

The solve stopped before its first iteration: unit 'T' could not compute its outlets from the starting values.
  Cause:   The outlet pressure specified for unit 'T', a turbine, is above its inlet pressure (5000000 Pa against 3000000 Pa).
  Why:     A turbine expands the fluid that passes through it, so it can only lower the pressure. Raising the pressure takes a pump or a compressor.
  Do:      Give the turbine 'T' an outlet pressure at or below its inlet pressure of 3000000 Pa, or raise the pressure upstream of it (for example a pump's outlet pressure).
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    pressure_rise, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain pressure_rise)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#pressure_rise

Example:

The solve stopped before its first iteration: unit 'V' could not compute its outlets from the starting values.
  Cause:   The outlet pressure specified for unit 'V', a valve, is above its inlet pressure (200000 Pa against 100000 Pa).
  Why:     A valve throttles the fluid that passes through it, so it can only lower the pressure. Raising the pressure takes a pump or a compressor.
  Do:      Give the valve 'V' an outlet pressure at or below its inlet pressure of 100000 Pa, or raise the pressure upstream of it (for example a pump's outlet pressure).
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    pressure_rise, in INITIALIZATION_FAILED → initializer_failed (openflowsheet explain pressure_rise)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#pressure_rise

project_exists: The directory already holds a project

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Directory <directory> is not empty: it already holds a project, and create() needs a new or empty directory.
  • Why: create() makes a new project and never reuses a directory, so a re-run cannot overwrite work silently.
  • Do: To use the existing project, open it instead.
  • Parameters: directory (directory)

Example:

Directory 'plant' is not empty: it already holds a project, and create() needs a new or empty directory.
  Why:     create() makes a new project and never reuses a directory, so a re-run cannot overwrite work silently.
  Do:      To use the existing project, open it instead.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    project_exists (openflowsheet explain project_exists)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#project_exists

project_id_mismatch: The directory holds a project with another id

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Directory <directory> holds the project '<existing>', not '<project_id>'.
  • Why: Asked to reuse an existing project, OpenFlowsheet opens it only when its id is the one requested, so a script never works on another project by mistake.
  • Do: To open the project that is there, ask for its id '<existing>' or give no id; to create '<project_id>', choose another directory.
  • Parameters: directory (directory), project_id (text), existing (text)
  • See also: project_exists

Example:

Directory 'plant' holds the project 'plant-a', not 'plant-b'.
  Why:     Asked to reuse an existing project, OpenFlowsheet opens it only when its id is the one requested, so a script never works on another project by mistake.
  Do:      To open the project that is there, ask for its id 'plant-a' or give no id; to create 'plant-b', choose another directory.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    project_id_mismatch (openflowsheet explain project_id_mismatch)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#project_id_mismatch

projection_unevaluable: Projection unevaluable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: projection unevaluable.

property_evaluation_failed: A property of one phase of a stream could not be evaluated

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

  • Summary: The property <property> of the <phase> phase of stream <stream> could not be evaluated (status <status>).
  • Where: stream <stream>
  • Why: The property basis was asked for <property> at the temperature, pressure and composition of this phase and returned no value. The quantities that need it are left empty.
  • Do: Check that the temperature and pressure of <stream> lie in the range the property basis covers; the other values of <stream> are unaffected.
  • Parameters: stream (stream), phase (text), property (text), status (text, optional)
  • See also: stream_enthalpy_absent

Example:

The property h of the LIQUID phase of stream 'S4' could not be evaluated (status out_of_range).
  Why:     The property basis was asked for h at the temperature, pressure and composition of this phase and returned no value. The quantities that need it are left empty.
  Do:      Check that the temperature and pressure of 'S4' lie in the range the property basis covers; the other values of 'S4' are unaffected.
  Kind:    Numerical failure: the solver did not find the solution; your flowsheet may be correct.
  Code:    property_evaluation_failed (openflowsheet explain property_evaluation_failed)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#property_evaluation_failed

property_not_provided: The property basis does not provide this property

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: The property basis <provider> does not provide the property <property>, so the values that need it are not given.
  • Why: The stream table reports only what the flowsheet's property basis computes. It does not put an estimate (an ideal-gas density, for example) in place of a property the basis does not offer.
  • Do: Use a property basis that provides <property> if you need these values; the other values of the table are unaffected.
  • Parameters: provider (text), property (text)
  • Not supported: missing capability: this property from the flowsheet's property basis
  • See also: stream_enthalpy_absent

Example:

The property basis wilson-ig-v2 does not provide the property v, so the values that need it are not given.
  Why:     The stream table reports only what the flowsheet's property basis computes. It does not put an estimate (an ideal-gas density, for example) in place of a property the basis does not offer.
  Do:      Use a property basis that provides v if you need these values; the other values of the table are unaffected.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    property_not_provided (openflowsheet explain property_not_provided)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#property_not_provided

provider_missing: Provider missing

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: provider missing.

provider_not_admitted: Provider not admitted

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: provider not admitted.

provider_unknown: Provider unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: provider unknown.

ptc_mapping_invalid: Ptc mapping invalid

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: ptc mapping invalid.

rate_not_finite: Rate not finite

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: rate not finite.

reactant_exhausted: Reactant exhausted

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: reactant exhausted.

reactor_not_accepted: Reactor not accepted

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: reactor not accepted.

recovery_feed_not_positive: Recovery feed not positive

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: recovery feed not positive.

redundant_specification: Redundant specification

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: redundant specification.

reference_convention_not_reaction_consistent: Reference convention not reaction consistent

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: reference convention not reaction consistent.

request_invalid: An optimisation request that breaks its schema or rules

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The optimisation request is invalid.
  • Why: Before anything is solved, an optimisation request (its decisions and their bounds, the objective, the constraints and the starts) is checked against its schema and the rules stated for its members, and this one breaks one of them. The check reported: <detail>.
  • Do: Correct the request as the check reports, and send it again.
  • Parameters: member (pointer), detail (text, optional)

Example:

The optimisation request is invalid at /decisions/0/upper.
  Why:     Before anything is solved, an optimisation request (its decisions and their bounds, the objective, the constraints and the starts) is checked against its schema and the rules stated for its members, and this one breaks one of them. The check reported: 'high' is not of type 'number'.
  Do:      Correct the member at /decisions/0/upper as the check reports, and send the request again.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    request_invalid, in invalid_request (openflowsheet explain request_invalid)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#request_invalid

Example:

The optimisation request is invalid.
  Why:     Before anything is solved, an optimisation request (its decisions and their bounds, the objective, the constraints and the starts) is checked against its schema and the rules stated for its members, and this one breaks one of them. The check reported: 'decisions' is a required property.
  Do:      Correct the request as the check reports, and send it again.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    request_invalid, in invalid_request (openflowsheet explain request_invalid)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#request_invalid

rerun_unsupported: Rerun unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: rerun unsupported.

restart_pass_rejected: Restart pass rejected

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: restart pass rejected.

revision_unreadable: Revision unreadable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: revision unreadable.

schema_invalid: Schema invalid

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: schema invalid.

single_phase_admissible: Single phase admissible

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: single phase admissible.

specification_conflict: Specification conflict

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification conflict.

specification_free_unused: Specification free unused

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification free unused.

specification_kind_unknown: Specification kind unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification kind unknown.

specification_kind_unsupported: Specification kind unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification kind unsupported.

specification_missing: A value that no specification fixes

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The revision is incomplete: no specification fixes <column> (on <object>).
  • Why: A solve needs every value its units leave free to be fixed by exactly one specification. Here <column> is left free, so the equations do not determine the state.
  • Do: Add one fixed specification for <column>, for example with target <object>; the check's message lists the kind, unit and target each choice takes.
  • Parameters: column (text), object (element, optional)
  • See also: specification_unconsumed, revision_not_ready

Example:

The revision is incomplete: no specification fixes S4.P (on 'S4').
  Why:     A solve needs every value its units leave free to be fixed by exactly one specification. Here S4.P is left free, so the equations do not determine the state.
  Do:      Add one fixed specification for S4.P, for example with target 'S4'; the check's message lists the kind, unit and target each choice takes.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    specification_missing, in revision_not_ready (openflowsheet explain specification_missing)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#specification_missing

specification_pairing_unsupported: Specification pairing unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification pairing unsupported.

specification_region_unsupported: Specification region unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification region unsupported.

specification_role_unsupported: Specification role unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification role unsupported.

specification_target_unknown: Specification target unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification target unknown.

specification_unconsumed: A specification that no unit reads

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Specification <specification> sets a value that no unit reads: unit <unit> (<model>) does not read <column>.
  • Why: Each specification must fix a value a unit's model reads. One that nothing reads would be ignored silently, so validation refuses it; it usually means one specification too many, or one on the wrong variable or object.
  • Do: Remove <specification>, or change its target to a value the unit reads (<unit> reads <reads>, among others); the check's message lists the kind, unit and target each one takes.
  • Parameters: specification (specification), unit (unit, optional), model (text, optional), column (text, optional), reads (text, optional)
  • See also: specification_missing, revision_not_ready

Example:

Specification 'pump-T' sets a value that no unit reads: unit 'P' (thermal.pump) does not read S2.T.
  Why:     Each specification must fix a value a unit's model reads. One that nothing reads would be ignored silently, so validation refuses it; it usually means one specification too many, or one on the wrong variable or object.
  Do:      Remove 'pump-T', or change its target to a value the unit reads ('P' reads outlet_pressure, among others); the check's message lists the kind, unit and target each one takes.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    specification_unconsumed, in revision_not_ready (openflowsheet explain specification_unconsumed)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#specification_unconsumed

specification_unit_unsupported: A specification's unit that its quantity kind does not take

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: Specification <specification> gives its value in a unit its quantity kind does not take: a <quantity> takes <units>.
  • Why: Validation accepts for each quantity kind only the units listed for it, spelled exactly: unit symbols are case-sensitive, so a temperature takes "degC" but not "degc".
  • Do: Correct the spelling of the unit of <specification> to one of <units>, or give the value in one of the accepted units.
  • Parameters: specification (specification), quantity (text, optional), units (text, optional)
  • See also: DIM-01, revision_not_ready

Example:

Specification 'boiler-T' gives its value in a unit its quantity kind does not take: a temperature takes K, degC, degF.
  Why:     Validation accepts for each quantity kind only the units listed for it, spelled exactly: unit symbols are case-sensitive, so a temperature takes "degC" but not "degc".
  Do:      Correct the spelling of the unit of 'boiler-T' to one of K, degC, degF, or give the value in one of the accepted units.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    specification_unit_unsupported, in revision_not_ready → DIM-01 (openflowsheet explain specification_unit_unsupported)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#specification_unit_unsupported

specification_unsupported: Specification unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification unsupported.

specification_value_unreadable: Specification value unreadable

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification value unreadable.

specification_value_unsupported: Specification value unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: specification value unsupported.

split_fraction_outside_unit_interval: Split fraction outside unit interval

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: split fraction outside unit interval.

staged_model_unread: Staged model unread

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: staged model unread.

staged_split_map_disagrees: Staged split map disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: staged split map disagrees.

staged_split_rows_disagree: Staged split rows disagree

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: staged split rows disagree.

staged_unit_has_rule: Staged unit has rule

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: staged unit has rule.

start_outside_model_domain: Start outside model domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: start outside model domain.

state_mismatch: State mismatch

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: state mismatch.

state_outside_domain: State outside domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: state outside domain.

stoichiometry_not_mass_conserving: Stoichiometry not mass conserving

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: stoichiometry not mass conserving.

surrogate_input_undefined: Surrogate input undefined

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: surrogate input undefined.

surrogate_manifest_mismatch: Surrogate manifest mismatch

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: surrogate manifest mismatch.

surrogate_not_promoted: Surrogate not promoted

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: surrogate not promoted.

surrogate_output_inadmissible: Surrogate output inadmissible

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: surrogate output inadmissible.

surrogate_outside_hard_domain: Surrogate outside hard domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: surrogate outside hard domain.

syn001_only: Syn001 only

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: syn001 only.

task_unsupported: A change checked for a task other than simulation

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

  • Summary: A change is checked for the task "simulation" only; this version cannot check it for the "<task>" task.
  • Why: Committing or previewing a change validates the new revision for the change's task. Validating for optimization needs an optimization request (decisions, objective and starts), and a change carries none, so this version refuses rather than report a revision ready for a task it has not checked.
  • Do: Commit the change with the task "simulation"; then validate the committed revision with the task "optimization" and an optimization request.
  • Parameters: task (text)
  • Not supported: missing capability: checking a change for the optimization task when it is committed or previewed
  • See also: unsupported

Example:

A change is checked for the task "simulation" only; this version cannot check it for the "optimization" task.
  Why:     Committing or previewing a change validates the new revision for the change's task. Validating for optimization needs an optimization request (decisions, objective and starts), and a change carries none, so this version refuses rather than report a revision ready for a task it has not checked.
  Do:      Commit the change with the task "simulation"; then validate the committed revision with the task "optimization" and an optimization request.
  Kind:    Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.
  Code:    task_unsupported, in unsupported (openflowsheet explain task_unsupported)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#task_unsupported

tear_path_unsupported: Tear path unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: tear path unsupported.

temperature_cross: Temperature cross

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: temperature cross.

temperature_degenerate_unlifted: Temperature degenerate unlifted

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: temperature degenerate unlifted.

temperature_outside_domain: Temperature outside domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: temperature outside domain.

terminal_refinement: Terminal refinement

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: terminal refinement.

unknown_specification: Unknown specification

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: unknown specification.

user_start_columns: User start columns

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: user start columns.

user_start_unsupported: User start unsupported

Kind: Not supported in this version: a limitation of OpenFlowsheet, not an error in your flowsheet.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: user start unsupported.

value_not_finite: A computed value is not a finite number

Kind: Numerical failure: the solver did not find the solution; your flowsheet may be correct.

  • Summary: The value <quantity> of <subject> is not a finite number, so it is not given.
  • Why: A computed value overflowed, or a quotient had no defined value; the table gives no value rather than an infinite or undefined one.
  • Do: Check the flows and conditions of <subject>: a very large or very small flow can put a value outside the range of floating-point numbers.
  • Parameters: subject (text), quantity (text)
  • See also: stream_enthalpy_absent

Example:

The value H_flow of S6 is not a finite number, so it is not given.
  Why:     A computed value overflowed, or a quotient had no defined value; the table gives no value rather than an infinite or undefined one.
  Do:      Check the flows and conditions of S6: a very large or very small flow can put a value outside the range of floating-point numbers.
  Kind:    Numerical failure: the solver did not find the solution; your flowsheet may be correct.
  Code:    value_not_finite (openflowsheet explain value_not_finite)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#value_not_finite

value_outside_model_domain: Value outside model domain

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: value outside model domain.

vapour_only_form_disagrees: Vapour only form disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: vapour only form disagrees.

warm_start_source_missing: A warm start from a job with no solution state

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The declared warm start names job <job_id>, which is not a solve job of this project with a solution state.
  • Why: A warm start declared by job id starts the solve from that job's solution state, so the job must be a solve job of this project that wrote one. Its certificate status does not matter.
  • Do: Name a solve job of this project whose run wrote a solution state, or leave the job id out of the warm start.
  • Parameters: job_id (job)

Example:

The declared warm start names job 'job-000003', which is not a solve job of this project with a solution state.
  Why:     A warm start declared by job id starts the solve from that job's solution state, so the job must be a solve job of this project that wrote one. Its certificate status does not matter.
  Do:      Name a solve job of this project whose run wrote a solution state, or leave the job id out of the warm start.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    warm_start_source_missing, in invalid_request (openflowsheet explain warm_start_source_missing)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#warm_start_source_missing

warm_start_unit_unknown: A coupling start for a unit the revision does not have

Kind: Input problem: something in the flowsheet or the request needs to change.

  • Summary: The declared warm start gives a coupling start for '<unit>', which is not a unit of this revision.
  • Why: A warm start may give, for each unit computed by an external program, starting values for what the flowsheet and that program exchange (the coupling), keyed by the unit's instance id; so each key must be a unit of the revision being solved. Whether the unit is computed by an external program in this solve is checked when the run starts; a start that fails that check is recorded as rejected, not refused.
  • Do: Key each coupling start by the instance id of a unit in this revision, or remove the key '<unit>'.
  • Parameters: unit (text)

Example:

The declared warm start gives a coupling start for 'R9', which is not a unit of this revision.
  Why:     A warm start may give, for each unit computed by an external program, starting values for what the flowsheet and that program exchange (the coupling), keyed by the unit's instance id; so each key must be a unit of the revision being solved. Whether the unit is computed by an external program in this solve is checked when the run starts; a start that fails that check is recorded as rejected, not refused.
  Do:      Key each coupling start by the instance id of a unit in this revision, or remove the key 'R9'.
  Kind:    Input problem: something in the flowsheet or the request needs to change.
  Code:    warm_start_unit_unknown, in invalid_request (openflowsheet explain warm_start_unit_unknown)
  Docs:    https://computational-chemical-engineering.github.io/openflowsheet/messages/refusals/#warm_start_unit_unknown

zero_flow_conflict: Zero flow conflict

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: zero flow conflict.

zero_flow_form_disagrees: Zero flow form disagrees

Kind: Internal error in OpenFlowsheet: please report it.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: zero flow form disagrees.

zero_flow_form_unknown: Zero flow form unknown

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: zero flow form unknown.

zero_flow_form_without_energy_row: Zero flow form without energy row

Kind: Input problem: something in the flowsheet or the request needs to change.

No plain-language explanation is written yet; the summary is the technical one.

  • Summary: Refused: zero flow form without energy row.