pwrs.core.rundcpf#

pwrs.core.rundcpf.rundcpf(casedata: str | MatpowerCase | Mapping[str, object] = 'case9', mpopt_value: MatpowerConfig | Mapping[str, object] | None = None, fname: str = '', solvedcase: str = '', *, nargout: None | Literal[1] = None) → PowerFlowResult[source]#

Run a DC power flow.

This is a thin wrapper around runpf() that forces the model to "DC" before dispatching.

Parameters:

casedata (dict or str, optional) – MATPOWER case dict or case-file name. Defaults to "case9".
mpopt_value (dict, optional) – MATPOWER options dict to override defaults.
fname (str, optional) – File name to which pretty-printed output is appended.
solvedcase (str, optional) – File name where the solved case is saved in MATPOWER case format.
nargout (int, optional) – Number of outputs to emulate from the MATLAB interface.

Returns:

Same structured return forms as runpf(), but with model="DC".

Return type:

PowerFlowResult or tuple

pwrs.core.rundcpf.rundcpf_with_success(casedata='case9', mpopt_value=None, fname='', solvedcase='')[source]#

Run a DC power flow and return (result, success).

Parameters:

casedata (str | MatpowerCase | Mapping[str, object])
mpopt_value (MatpowerConfig | Mapping[str, object] | None)
fname (str)
solvedcase (str)

Return type:

tuple[PowerFlowResult, bool]

pwrs.core.rundcpf.rundcpf_expanded(casedata='case9', mpopt_value=None, fname='', solvedcase='')[source]#

Run a DC power flow and return the named expanded result.

Parameters:

casedata (str | MatpowerCase | Mapping[str, object])
mpopt_value (MatpowerConfig | Mapping[str, object] | None)
fname (str)
solvedcase (str)

Return type:

PowerFlowExpandedResult