finesse.analysis.actions.random.Change

Overview

class finesse.analysis.actions.random.Change(change_dict=None, *, relative=False, name='change', **kwargs)

Bases: Action

Changes a model Parameter to some value during an analysis.

Parameters

change_dictdict, optional

Dictionary of parameter:value pairs to change.

relativebool, optional

Whether to increment from the parameters current value or not

namestr, optional

Name of action

**kwargs

Alternative method to specify parameter:value pairs to change

Examples

A simple change of a parameter between running two noxaxis analyses:

>>> model = finesse.script.parse("l L1 P=1")
>>> model.run('series(noxaxis(), change(L1.P=2), noxaxis())')

Or increment from the current value: >>> model.run(‘series(noxaxis(), change(L1.P=1, relative=True), noxaxis())’)

Properties

Change.change_kwargs