set_save_fields#

SetupMaxwell.set_save_fields(enable=True, range_type='Custom', subrange_type='LinearStep', start=0, stop=100000, count=1, units='ns')#

Enable the save fields option in the setup.

Parameters:

enablebool, optional

Whether to enable the save fields option. The default value is True.

range_typestr, optional

Range type. The available options are "Custom" to set a custom range type or "Every N Steps" to set the steps within the range. The default value is Custom.

subrange_typestr, optional

In case of a custom range type the subrange_type defines the subrange type. The available options are "LinearStep", "LinearCount" and "SinglePoints". The default option is "LinearStep".

startfloat, optional

Range or steps starting point. The default value is 0.

stopfloat, optional

Range or steps starting point. The default value is 100000.

countfloat, optional

Range count or step. The default value is 1.

unitsstr, optional

Time units. The default is “ns”.

Returns:

bool

True if successful, False if it fails.