set_variable_props

StokesFlow.set_variable_props(variable_props, mode='merge')

This method is useful for setting variable_props to the settings dictionary of the target object. Variable_props and their dependent properties get updated iteratively.

Parameters
  • variable_props (str, or List(str)) – A single string or list of strings to be added as variable_props

  • mode (str, optional) –

    Controls how the variable_props are applied. The default value is ‘merge’. Options are:

    mode

    meaning

    ’merge’

    Adds supplied variable_props to already existing list (if any), and prevents duplicates

    ’overwrite’

    Deletes all exisitng variable_props and then adds the specified new ones