Skip to content

Network related APIs

Changgang Li edited this page Feb 8, 2021 · 1 revision

build_network_Y_matrix

Format: build_network_Y_matrix()
Description: Build newwork complex Y matrix for powerflow solution.
Args: N/A

Rets: N/A

Example: N/A

build_decoupled_network_B_matrix

Format: build_decoupled_network_B_matrix()
Description: Build newwork real B' and B" matrix for decoupled powerflow solution.
Args: N/A

Rets: N/A

Example: N/A

build_dc_network_B_matrix

Format: build_dc_network_B_matrix()
Description: Build newwork real B matrix for DC powerflow solution.
Args: N/A

Rets: N/A

Tips:

DC powerflow solution is not supported.

Example: N/A

build_dynamic_network_Y_matrix

Format: build_dynamic_network_Y_matrix()
Description: Build newwork complex Y matrix for dynamic simulation.
Args: N/A

Rets: N/A

Tips:

The faults and source impedance are included in the Y matrix.

Example: N/A

build_network_Z_matrix

Format: build_network_Z_matrix()
Description: Build newwork complex Z matrix.
Args: N/A

Rets: N/A

Example: N/A

save_network_Y_matrix

Format: save_network_Y_matrix(file, export_full=False)
Description: Save newwork complex Y matrix to file.
Args:

(1) file: String of target file name of sparse Y matrix. If export_full is True, then 'full_' is appended to the head of file name for full matrix.
(2) export_full: boolean. False for saving only the sparse network matrix. True for saving both sparse and full network matrix.

Rets: N/A

Example:

simulator.save_network_Y_matrix("y.csv") # save only sparse matrix to y.csv  
simulator.save_network_Y_matrix("y.csv", True) # save both sparse and full matrix to y.csv and full_y.csv respectively  

save_decoupled_network_B_matrix

Format: save_decoupled_network_B_matrix(file)
Description: Save newwork decoupled real B' and B" matrix to file.
Args:

(1) file: String of target file name.

Rets: N/A

Example: N/A

save_dc_network_B_matrix

Format: save_dc_network_B_matrix(file)
Description: Save newwork real DC B matrix to file.
Args:

(1) file: String of target file name.

Rets: N/A

Example: N/A

save_dynamic_network_Y_matrix

Format: save_dynamic_network_Y_matrix(file)
Description: Save newwork dynamic complex Y matrix to file.
Args:

(1) file: String of target file name.

Rets: N/A

Example: N/A

save_network_Z_matrix

Format: save_network_Z_matrix(file)
Description: Save newwork complex Z matrix to file.
Args:

(1) file: String of target file name.

Rets: N/A

Example: N/A

check_network_connectivity

Format: check_network_connectivity(remove_void_islands=False)
Description: Check network connectivity.
Args: N/A

Rets: N/A

Example: N/A