Skip to content

SteadyState.static_evaluate()

Documentation TODO

This page is a work in progress.

fullflow.SteadyState.static_evaluate

Evaluate the network without performing a nonlinear solve.

static_evaluate() propagates component states and evaluates derived quantities using the currently assigned values of all States.

No iteration variables are modified and no residual equations are solved.

This mode is useful for:

  • explicit calculations
  • property lookups
  • model validation
  • diagnostic checks
  • post-processing solved networks

Parameters

Name Type Description
modelstr, optional

Model to evaluate. If omitted, all registered Models use their currently active option.

evaluate_all_model_optionsbool, optional

If True, evaluates every option in the selected Model and returns successful results.

filenamestr, optional

Output file used to save results.

return_type{"dict", "dataframe"}, optional

Format of returned solution data.

verbosebool, optional

Print evaluation diagnostics.

print_solutionbool, optional

Print exported network values.

state_max_passesint, optional

Maximum number of state-settling passes.

state_tolerancefloat, optional

Convergence tolerance for derived-state propagation.

Returns

Name Type Description
solutiondict or pandas.DataFrame

Exported network results.