4. API Reference

4.1. Power Flow Method

gridopt.power_flow.new_method(name)[source]

Creates a power flow or optimal power flow method.

Parameters:
name : {'DCPF', 'DCOPF', 'ACPF', 'ACOPF'}
class gridopt.power_flow.method.PFmethod[source]

Power flow method class.

create_problem(self, net)[source]

Creates optimization problem.

Parameters:
net : Network
Returns:
prob : Problem
get_info_printer(self)[source]

Gets function for printing information about method progress.

Returns:
printer : Function
get_parameters(self)[source]

Gets method parameters.

Returns:
params : dict
get_results(self)[source]

Gets dictionary with results.

Returns:
results : dict
set_network_snapshot(self, net)[source]

Sets network snapshot.

Parameters:
net : Network
set_parameters(self, params=None, strparams=None)[source]

Sets method parameters.

Parameters:
params : dict

Name-value pairs

strparams: dict

Name-value pairs where value is a string
set_problem(self, p)[source]

Sets problem.

Parameters:
p : Problem
set_problem_time(self, t)[source]

Sets problem construction time in seconds.

Parameters:
t : float
set_results(self, results)[source]

Sets method results.

Parameters:
results : dict
set_solver_dual_variables(self, d)[source]

Sets solver dual variables.

Parameters:
d : list
set_solver_iterations(self, k)[source]

Sets solver iterations.

Parameters:
k : int
set_solver_message(self, msg)[source]

Sets solver message.

Parameters:
msg : string
set_solver_name(self, name)[source]

Sets solver name.

Parameters:
name : string
set_solver_primal_variables(self, x)[source]

Sets solver primal variables.

Parameters:
x : vector
set_solver_status(self, status)[source]

Sets solver status.

Parameters:
status : string
set_solver_time(self, t)[source]

Sets solver time in seconds.

Parameters:
t : float
solve(self, net)[source]

Solves power flow problem.

Parameters:
net : Network
update_network(self, net)[source]

Updates network with results.

Parameters:
net : Network
class gridopt.power_flow.dc_pf.DCPF[source]

DC power flow method.

class gridopt.power_flow.dc_opf.DCOPF[source]

DC optimal power flow method.

class gridopt.power_flow.ac_pf.ACPF[source]

AC power flow method.

class gridopt.power_flow.ac_opf.ACOPF[source]

AC optimal power flow method.

4.1.1. Error Exceptions

class gridopt.power_flow.method_error.PFmethodError[source]
class gridopt.power_flow.method_error.PFmethodError_NoProblem[source]
class gridopt.power_flow.method_error.PFmethodError_BadProblem[source]
class gridopt.power_flow.method_error.PFmethodError_BadFlowLimits[source]
class gridopt.power_flow.method_error.PFmethodError_BadVarLimits[source]
class gridopt.power_flow.method_error.PFmethodError_BadParams(keys)[source]
class gridopt.power_flow.method_error.PFmethodError_BadOptSolver(param='')[source]
class gridopt.power_flow.method_error.PFmethodError_ParamNotBool[source]
class gridopt.power_flow.method_error.PFmethodError_SolverError(msg)[source]