finesse.components.general.Variable

Overview

class finesse.components.general.Variable(name: str, value, description: str = None, units: str = '', is_geometric: bool = False, changeable_during_simulation: bool = True)

Bases: ModelElement

The variable element acts slightly different to other elements. When added to a model it creates a new finesse.parameter.Parameter in the model it has been added to. This does the same as calling :function:`finesse.model.Model.add_parameter`. This new parameter can be used like a variable for making symbolic links to or for storing some useful number about the model.

See :function:`finesse.model.Model.add_parameter` for more details.