Skip to main content

ContinuationOptions

gridoxide_core::continuation

Struct ContinuationOptions 

Source 
pub struct ContinuationOptions {
Show 16 fields
    pub power_flow: PowerFlowOptions,
    pub direction: LoadingDirection,
    pub parametrization: Parametrization,
    pub step: f64,
    pub step_min: f64,
    pub step_max: f64,
    pub target_iterations: usize,
    pub max_steps: usize,
    pub stop: StopCriterion,
    pub locate_events: bool,
    pub event_tol: f64,
    pub event_max_iter: usize,
    pub locate_nose: bool,
    pub nose_refine_iters: usize,
    pub base_mva: f64,
    pub allow_zip: bool,

}
Expand description

What a continuation run needs to know.

Fields§

§power_flow: PowerFlowOptions

The λ = 0 base-case solve and the shared knobs — tol, max_iter, backend, init, enforce_q_limits. method must be NewtonRaphson, and control_taps is refused: a tap move is a discrete change to Y-bus values, needing its own event function and a re-stamping mid-curve, and silently freezing the taps at their base-case positions would be a wrong answer that looks right.

§direction: LoadingDirection§parametrization: Parametrization§step: f64§step_min: f64§step_max: f64§target_iterations: usize

Corrector iterations at or below which the step grows.

§max_steps: usize§stop: StopCriterion§locate_events: bool

Locate the exact λ at which each generator saturates, rather than switching at whatever λ a step happened to land on. Only meaningful with power_flow.enforce_q_limits.

§event_tol: f64§event_max_iter: usize§locate_nose: bool§nose_refine_iters: usize§base_mva: f64

Reporting only — the crate’s internals carry no system base, and Bus::u_rated is a voltage base. Used solely to turn the per-unit margin into MW.

§allow_zip: bool

Proceed despite voltage-dependent load terms the Jacobian does not differentiate. Off by default: see ContinuationError::ZipTermsUnsupported.

Trait Implementations§

Source§

impl Clone for ContinuationOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContinuationOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ContinuationOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V