Struct SensitivityOptions 

pub struct SensitivityOptions {
    pub convention: DcConvention,
    pub solver: SensitivitySolver,
    pub drop_tolerance: f64,
    pub cg_tolerance: f64,
    pub cg_max_iterations: usize,
    pub auto_dense_threshold: usize,
}

Options for PTDF/LODF builders that expose solver choice and output pruning.

Fields

convention: DcConvention

DC branch susceptance convention.

solver: SensitivitySolver

Solver selection policy.

drop_tolerance: f64

Entries with absolute value at or below this value are omitted from the returned sparse matrices. LODF diagonal entries are structural and kept.

cg_tolerance: f64

Relative residual tolerance for the iterative solver.

cg_max_iterations: usize

Maximum conjugate gradient iterations per right hand side.

auto_dense_threshold: usize

Reduced dimension above which SensitivitySolver::Auto selects the iterative path.

Implementations

impl SensitivityOptions

pub fn selected_solver_for_reduced_dimension( &self, reduced_dimension: usize, ) -> SensitivitySolver

Return the concrete solver selected for a reduced grounded dimension, assuming a square problem. Prefer Self::selected_solver_for_shape, which also sees the branch count the dense PTDF and LODF are sized by.

pub fn selected_solver_for_shape( &self, reduced_dimension: usize, branches: usize, buses: usize, ) -> SensitivitySolver

Return the concrete solver selected for a problem shape. Auto takes the dense path while both the reduced dimension and the predicted dense footprint stay within their ceilings, so a wide case (few buses, many branches) no longer picks a path that would ask for tens of GB.

Trait Implementations

impl Clone for SensitivityOptions

fn clone(&self) -> SensitivityOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SensitivityOptions

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

Formats the value using the given formatter.

impl Default for SensitivityOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SensitivityOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SensitivityOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SensitivityOptions