-
Notifications
You must be signed in to change notification settings - Fork 19
Dynamic model related APIs
Format: load_dynamic_data(file, ftype)
Description: Load dynamic data from file.
Args:
(1) file: string, source dynamic data file name.
(2) ftype: string, dynamic data format.
Rets: N/A
Example: N/A
Format: save_dynamic_data(file, ftype)
Description: Save dynamic data to file.
Args:
(1) file: string, target dynamic data file name.
(2) ftype: string, dynamic data format.
Rets: N/A
Example: N/A
Format: check_dynamic_data()
Description: Check dynamic model data. If any inappropriate data is set, report will be sent to log file.
Args: N/A
Rets: N/A
Example: N/A
Format: check_missing_models()
Description: Check missing models. If any compulsory models are missing, report will be sent to log file.
Args: N/A
Rets: N/A
Example: N/A
Format: check_least_dynamic_time_constants()
Description: Check the least dynamic time constants. Report of the first least time constants in models will be sent to log file. The dynamic simulation time step should be < one fourth of the least time constant.
Args: N/A
Rets: N/A
Example: N/A
Format: converte_hvdc_to_load(hvdc)
Description: This function is to be implemented.
Format: set_dynamic_model(data, file_type)
Description: Set dynamic model from string.
Args:
(1) data: String of model data.
(2) file_type: Model data type.
Rets: N/A
Example: N/A
Format: disable_generator_related_model(generator, model_type)
Description: Disable generator related model of specific type.
Args:
(1) generator: Generator device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets: N/A
Example: N/A
Format: enable_generator_related_model(generator, model_type)
Description: Enable generator related model of specific type.
Args:
(1) generator: Generator device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets: N/A
Example: N/A
Format: get_generator_related_model_name(generator, model_type)
Description: Get generator related model name.
Args:
(1) generator: Generator device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) String of model name.
Tips:
If model type is not supported, empty string is returned.
Example: N/A
Format: get_generator_related_model_data(generator, model_type, par_name)
Description: Get generator related model data.
Args:
(1) generator: Generator device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
Rets:
(1) Value of parameter
Tips:
If model type or parameter name is not supported, 0.0 is returned.
Example: N/A
Format: set_generator_related_model_data(generator, model_type, par_name, value)
Description: Set generator related model data.
Args:
(1) generator: Generator device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
(4) value: Value of parameter.
Rets: N/A
Tips:
If model type or parameter name is not supported, nothing will be changed.
If value is not a number, function may malfunction and package may exit with error.
Example: N/A
Format: get_generator_related_model_parameter_pair(generator, model_type)
Description: Get generator related model parameter pair.
Args:
(1) generator: Generator device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) Tuple of parameter name and value pairs. Each parameter name and value pair is in format of (string of parameter name, value of parameter).
Tips:
If model type is not supported, empty tuple is returned.
Example: N/A
Format: get_wt_generator_related_model_name(generator, model_type)
Description: Get wind turbine generator related model name.
Args:
(1) generator: Wind turbine generator device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) String of model name.
Tips:
If model type is not supported, empty string is returned.
Example: N/A
Format: get_wt_generator_related_model_data(generator, model_type, par_name)
Description: Get wind turbine generator related model data.
Args:
(1) generator: Wind turbine generator device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
Rets:
(1) Value of parameter
Tips:
If model type or parameter name is not supported, 0.0 is returned.
Example: N/A
Format: set_wt_generator_related_model_data(generator, model_type, par_name, value)
Description: Set wind turbine generator related model data.
Args:
(1) generator: Wind turbine generator device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
(4) value: Value of parameter.
Rets: N/A
Tips:
If model type or parameter name is not supported, nothing will be changed.
If value is not a number, function may malfunction and package may exit with error.
Example: N/A
Format: get_wt_generator_related_model_parameter_pair(generator, model_type)
Description: Get wind turbine generator related model parameter pair.
Args:
(1) generator: Wind turbine generator device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) Tuple of parameter name and value pairs. Each parameter name and value pair is in format of (string of parameter name, value of parameter).
Tips:
If model type is not supported, empty tuple is returned.
Example: N/A
Format: get_pv_unit_related_model_name(pv_unit, model_type)
Description: Get PV unit related model name.
Args:
(1) pv_unit: PV unit device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) String of model name.
Tips:
If model type is not supported, empty string is returned.
Example: N/A
Format: get_pv_unit_related_model_data(pv_unit, model_type, par_name)
Description: Get PV unit related model data.
Args:
(1) pv_unit: PV unit device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
Rets:
(1) Value of parameter
Tips:
If model type or parameter name is not supported, 0.0 is returned.
Example: N/A
Format: set_pv_unit_related_model_data(pv_unit, model_type, par_name, value)
Description: Set PV unit related model data.
Args:
(1) pv_unit: PV unit device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
(4) value: Value of parameter.
Rets: N/A
Tips:
If model type or parameter name is not supported, nothing will be changed.
If value is not a number, function may malfunction and package may exit with error.
Example: N/A
Format: get_pv_unit_related_model_parameter_pair(pv_unit, model_type)
Description: Get pv unit related model parameter pair.
Args:
(1) pv_unit: PV unit device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) Tuple of parameter name and value pairs. Each parameter name and value pair is in format of (string of parameter name, value of parameter).
Tips:
If model type is not supported, empty tuple is returned.
Example: N/A
Format: get_load_related_model_name(load, model_type)
Description: Get load related model name.
Args:
(1) load: Load device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) String of model name.
Tips:
If model type is not supported, empty string is returned.
Example: N/A
Format: get_load_related_model_data(load, model_type, par_name)
Description: Get load related model data.
Args:
(1) load: Load device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
Rets:
(1) Value of parameter
Tips:
If model type or parameter name is not supported, 0.0 is returned.
Example: N/A
Format: set_load_related_model_data(load, model_type, par_name, value)
Description: Set load related model data.
Args:
(1) load: Load device id in format of (bus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
(4) value: Value of parameter.
Rets: N/A
Tips:
If model type or parameter name is not supported, nothing will be changed.
If value is not a number, function may malfunction and package may exit with error.
Example: N/A
Format: get_load_related_model_parameter_pair(load, model_type)
Description: Get load related model parameter pair.
Args:
(1) load: Load device id in format of (bus, ickt).
(2) model_type: String of model type.
Rets:
(1) Tuple of parameter name and value pairs. Each parameter name and value pair is in format of (string of parameter name, value of parameter).
Tips:
If model type is not supported, empty tuple is returned.
Example: N/A
Format: get_line_related_model_name(line, model_type)
Description: Get transmission line related model name.
Args:
(1) line: Transmission line device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
Rets:
(1) String of model name.
Tips:
If model type is not supported, empty string is returned.
Example: N/A
Format: get_line_related_model_data(line, model_type, par_name)
Description: Get transmission line related model data.
Args:
(1) line: Transmission line device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
Rets:
(1) Value of parameter
Tips:
If model type or parameter name is not supported, 0.0 is returned.
Example: N/A
Format: set_line_related_model_data(line, model_type, par_name, value)
Description: Set transmission line related model data.
Args:
(1) line: Transmission line device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
(4) value: Value of parameter.
Rets: N/A
Tips:
If model type or parameter name is not supported, nothing will be changed.
If value is not a number, function may malfunction and package may exit with error.
Example: N/A
Format: get_line_related_model_parameter_pair(line, model_type)
Description: Get transmission line related model parameter pair.
Args:
(1) line: Transmission line device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
Rets:
(1) Tuple of parameter name and value pairs. Each parameter name and value pair is in format of (string of parameter name, value of parameter).
Tips:
If model type is not supported, empty tuple is returned.
Example: N/A
Format: get_hvdc_related_model_name(hvdc, model_type)
Description: Get HVDC link related model name.
Args:
(1) hvdc: HVDC link device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
Rets:
(1) String of model name.
Tips:
If model type is not supported, empty string is returned.
Example: N/A
Format: get_hvdc_related_model_data(hvdc, model_type, par_name)
Description: Get HVDC link related model data.
Args:
(1) hvdc: HVDC link device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
Rets:
(1) Value of parameter
Tips:
If model type or parameter name is not supported, 0.0 is returned.
Example: N/A
Format: set_hvdc_related_model_data(hvdc, model_type, par_name, value)
Description: Set HVDC linke related model data.
Args:
(1) hvdc: HVDC link device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
(3) par_name: String of parameter name.
(4) value: Value of parameter.
Rets: N/A
Tips:
If model type or parameter name is not supported, nothing will be changed.
If value is not a number, function may malfunction and package may exit with error.
Example: N/A
Format: get_hvdc_related_model_parameter_pair(hvdc, model_type)
Description: Get HVDC link related model parameter pair.
Args:
(1) hvdc: HVDC link device id in format of (ibus, jbus, ickt).
(2) model_type: String of model type.
Rets:
(1) Tuple of parameter name and value pairs. Each parameter name and value pair is in format of (string of parameter name, value of parameter).
Tips:
If model type is not supported, empty tuple is returned.
Example: N/A
Format: get_generator_governor_pmax(gen)
Description: Get generator pmax in MW from turbine governor model.
Args:
(1) gen: generator id in format of (ibus, ickt)
Rets:
(1) Pmax in MW
Example: N/A
Format: get_generator_governor_pmin(gen)
Description: Get generator pmin in MW from turbine governor model.
Args:
(1) gen: generator id in format of (ibus, ickt)
Rets:
(1) Pmin in MW
Example: N/A
Format: get_generator_governor_up_spinning_reserve(gen)
Description: Get up spinning reserve of generator.
Args:
(1) gen: generator id in format of (ibus, ickt)
Rets:
(1) up spinning reserve in MW
Example: N/A
Format: get_generator_governor_down_spinning_reserve(gen)
Description: Get down spinning reserve of generator.
Args:
(1) gen: generator id in format of (ibus, ickt)
Rets:
(1) down spinning reserve in MW
Example: N/A
Format: get_generator_governor_total_up_spinning_reserve_with_constraints(area=0,zone=0)
Description: Get up spinning reserve of generators in area.
Args:
(1) area: area number, default is 0
(2) zone: zone number, default is 0
Rets:
(1) total up spinning reserve in MW
Example: N/A
Format: get_generator_governor_total_down_spinning_reserve_with_constraints(area=0,zone=0)
Description: Get down spinning reserve of generators in area.
Args:
(1) area: area number, default is 0
(2) zone: zone number, default is 0
Rets:
(1) total down spinning reserve in MW
Example: N/A
Format: get_generator_governor_total_pmax_with_constraints(area=0,zone=0)
Description: Get total pmax of generators in area and zone.
Args:
(1) area: area number, default is 0
(2) zone: zone number, default is 0
Rets:
(1) total pmax in MW
Example: N/A
Format: get_generator_governor_total_pmin_with_constraints(area=0,zone=0)
Description: Get total pmin of generators in area and zone.
Args:
(1) area: area number, default is 0
(2) zone: zone number, default is 0
Rets:
(1) total pmin in MW
Example: N/A
Cite STEPS via: Changgang Li, Yue Wu, Hengxu Zhang, Hua Ye, Yutian Liu and Yilu Liu, "STEPS: A Portable Numerical Simulation Toolkit for Electrical Power System Dynamic Studies," in IEEE Transactions on Power Systems, doi: 10.1109/TPWRS.2020.3045102.