Struct DcAnalysisRequest 

pub struct DcAnalysisRequest {
    pub monitored_branch_indices: Option<Vec<usize>>,
    pub ptdf_bus_indices: Option<Vec<usize>>,
    pub lodf_outage_branch_indices: Vec<usize>,
    pub otdf_outage_branch_indices: Vec<usize>,
    pub otdf_bus_indices: Option<Vec<usize>>,
    pub n2_outage_pairs: Vec<(usize, usize)>,
    pub pf_options: DcPfOptions,
    pub sensitivity_options: Option<DcSensitivityOptions>,
}

Canonical request for a one-pass DC sensitivity workflow.

This computes DC power flow plus PTDF for a monitored branch set, and optionally includes OTDF, subset LODF, and batched N-2 sensitivities over the same monitored set.

Fields

monitored_branch_indices: Option<Vec<usize>>

Branch indices to monitor for PTDF / LODF / N-2 results.

When None, all branches in network.branches are monitored.

ptdf_bus_indices: Option<Vec<usize>>

Optional bus subset for PTDF output vectors.

When None, PTDF is returned for all buses. When Some, PTDF vectors are returned only for the requested internal bus indices in the given order.

lodf_outage_branch_indices: Vec<usize>

Explicit outage branches for subset LODF.

When empty, no LODF subset is computed.

otdf_outage_branch_indices: Vec<usize>

Explicit outage branches for subset OTDF.

When empty, no OTDF subset is computed.

otdf_bus_indices: Option<Vec<usize>>

Optional bus subset for OTDF output vectors.

When None, OTDF is returned for all buses. When Some, OTDF vectors are returned only for the requested internal bus indices in the given order.

n2_outage_pairs: Vec<(usize, usize)>

Explicit outage pairs for batched N-2 sensitivity computation.

When empty, no N-2 batch is computed.

pf_options: DcPfOptions

DC power flow options applied to the base solve.

sensitivity_options: Option<DcSensitivityOptions>

Optional sensitivity options applied to PTDF / OTDF outputs.

When None, the sensitivity workflow derives its slack policy from pf_options: headroom-slack solves use headroom-slack sensitivities, otherwise the classic single-slack sensitivity formulation is used.

Implementations

impl DcAnalysisRequest

pub fn all_branches() -> Self

Monitor all branches and compute only the base DC power flow + PTDF.

pub fn with_monitored_branches(monitored_branch_indices: &[usize]) -> Self

Monitor the requested branch set.

pub fn with_ptdf_buses(self, bus_indices: &[usize]) -> Self

Restrict PTDF output to the requested internal bus indices.

pub fn with_lodf_outages(self, outage_branch_indices: &[usize]) -> Self

Add a subset LODF request for the given outage branches.

pub fn with_otdf_outages(self, outage_branch_indices: &[usize]) -> Self

Add a subset OTDF request for the given outage branches.

pub fn with_otdf_buses(self, bus_indices: &[usize]) -> Self

Restrict OTDF output to the requested internal bus indices.

pub fn with_n2_outage_pairs(self, outage_pairs: &[(usize, usize)]) -> Self

Add a batched N-2 request for the given outage pairs.

pub fn with_pf_options(self, pf_options: DcPfOptions) -> Self

Apply DC power flow options to the base solve.

pub fn with_sensitivity_options( self, sensitivity_options: DcSensitivityOptions, ) -> Self

Apply explicit sensitivity options to PTDF / OTDF outputs.

Trait Implementations

impl Clone for DcAnalysisRequest

fn clone(&self) -> DcAnalysisRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DcAnalysisRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DcAnalysisRequest

fn default() -> DcAnalysisRequest

Returns the “default value” for a type.