finesse.model.Model.retrace

property Model.retrace

Whether the model will be retraced during a simulation.

Note that if this is true, which is the default behaviour, then retracing is determined automatically based on whether any parameter is changing which would require a retrace. The paths that get retraced are also determined automatically, such that only trace trees which are changing get retraced. See Tracing the beam for more details.

If retracing is switched off, then the initial modal basis state of the model is used - i.e. beam parameters will not change during the simulation, regardless of whether a dependent model parameter is being scanned or not.

Warning

Without re-computing a proper base of Gaussian beam parameters virtual mode mismatches can be introduced which can lead to wrong results.

Getter

Returns a flag indicating whether retracing is on or off.

Setter

Set the retracing to on or off; it is on by default.