Engee documentation

setup!

Page in progress.

Sets up the simulation quick restart mode.

Library

EngeeDesignOptimization

Description

Function EngeeDesignOptimization.setup! sets up the quick restart mode of the simulation model in Engee.

Syntax

Function call

  • sim_obj_new = EngeeDesignOptimization.setup!(sim_obj; fast_restart) — sets the value of the property fast_restart simulation scenario object sim_obj equal to the value of the argument fast_restart. The argument is passed as named: fast_restart=false or fast_restart=true.

Arguments

Input arguments

# sim_obj — object of the simulation scenario

+ object

Details

The simulation scenario of the model, set as an object EngeeDesignOptimization.SimulationTest.

Типы данных

EngeeDesignOptimization.SimulationTest

# fast_restart — option to enable quick restart mode

+ false (by default) | true

Details

Option to enable the quick restart simulation mode. Value true enables the quick restart mode, the value false — turns it off.

Типы данных

Bool

Output arguments

# sim_obj_new — object of the simulation scenario

+ object

Details

The object of the model simulation scenario that has the property fast_restart the value of the argument is set fast_restart.

Типы данных

EngeeDesignOptimization.SimulationTest