add_eddy_current_sweep#
- SetupMaxwell.add_eddy_current_sweep(range_type='LinearStep', start=0.1, end=100, count=0.1, units='Hz', clear=True, save_all_fields=True)[source]#
Create a Maxwell Eddy Current Sweep.
- Parameters:
- range_type
str
Type of the subrange. Options are
"LinearCount"
,"LinearStep"
,"LogScale"
and"SinglePoints"
.- start
float
Starting frequency.
- end
float
,optional
Stopping frequency. Required for
range_type="LinearCount"|"LinearStep"|"LogScale"
.- count
int
orfloat
,optional
Frequency count or frequency step. Required for
range_type="LinearCount"|"LinearStep"|"LogScale"
.- units
str
,optional
Unit of the frequency. For example,
"MHz
or"GHz"
. The default is"Hz"
.- clearbool,
optional
If set to
True
, all other subranges will be suppressed except the current one under creation. Default value isFalse
.- save_all_fieldsbool,
optional
Save fields at all frequency points to save fields for the entire set of sweep ranges. Default is
True
.
- range_type
- Returns:
- bool
True
if successful,False
if it fails.