Skip to main content

McAcOpfInstance

Struct McAcOpfInstance 

Source
pub struct McAcOpfInstance { /* private fields */ }
Expand description

The calculation types used by solver consumers. The full problem vocabulary lives in powerio_prob; these types sit at the facade root so a consumer does not need a second PowerIO dependency to name its boundary. The multiconductor AC optimal power flow instance: the shared network, the typed per phase objective, and the active terminal voltage, conductor, and per phase generator constraint selections.

Implementations§

Source§

impl McAcOpfInstance

Source

pub fn from_network( network: MulticonductorNetwork, ) -> Result<McAcOpfInstance, Error>

Build the instance with the default per phase objective and every stated limit active.

§Errors

A network with no voltage source.

Source

pub fn with_objective(self, objective: Objective) -> McAcOpfInstance

Replace the objective, consuming the instance. The shared network moves; no table is copied.

Source

pub fn with_objective_term(self, term: ObjectiveTerm) -> McAcOpfInstance

Append one objective term, consuming the instance.

Source

pub fn with_constraints( self, constraints: MulticonductorActiveConstraints, ) -> McAcOpfInstance

Replace the active constraint selections, consuming the instance.

Source

pub fn with_initial_point( self, point: OperatingPoint<MulticonductorNetwork>, ) -> McAcOpfInstance

Supply an optional solver initial point.

Source

pub fn with_network( self, network: MulticonductorNetwork, ) -> Result<McAcOpfInstance, Error>

Replace the network while preserving this instance’s objective, constraint selections, and a compatible initial point.

Source

pub fn network(&self) -> &MulticonductorNetwork

The network this instance calculates on. Borrowed; never a copy.

Source

pub const fn objective(&self) -> &Objective

The typed objective.

Source

pub const fn constraints(&self) -> &MulticonductorActiveConstraints

The active constraint selections.

Source

pub const fn initial_point( &self, ) -> Option<&OperatingPoint<MulticonductorNetwork>>

The optional solver initial point.

Source

pub fn to_mc_ac_pf(&self) -> Result<(McAcPfInstance, Vec<Diagnostic>), Error>

The multiconductor power flow instance for this problem’s network at its stated injections: the objective and constraint selections are discarded, and the discard is recorded.

§Errors

As McAcPfInstance::from_network.

Trait Implementations§

Source§

impl Clone for McAcOpfInstance

Source§

fn clone(&self) -> McAcOpfInstance

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 McAcOpfInstance

Source§

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

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

impl From<McAcOpfInstance> for PioValue

Source§

fn from(value: McAcOpfInstance) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

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

§

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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.

§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

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

§

fn vzip(self) -> V