Struct VoltageSource 

#[non_exhaustive]
pub struct VoltageSource {
    pub name: String,
    pub bus: String,
    pub terminal_map: Vec<String>,
    pub v_magnitude: Vec<f64>,
    pub v_angle: Vec<f64>,
    pub reference_terminal: Option<String>,
    pub energy_cost_rate: Option<Vec<f64>>,
    pub extras: BTreeMap<String, Value>,
}

An ideal source prescribing terminal voltages relative to earth or one explicit terminal on the same bus. A reference terminal is a conductor, not an implicit grounding instruction.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

bus: String

terminal_map: Vec<String>

v_magnitude: Vec<f64>

Volts per terminal, relative to reference_terminal or earth.

v_angle: Vec<f64>

Radians per terminal, with the same reference as v_magnitude.

reference_terminal: Option<String>

None preserves the historical earth-referenced source semantics. Some names a declared terminal on bus; its voltage remains unknown unless the rest of the circuit fixes it. Each phase current has an equal opposite contribution at this reference terminal.

energy_cost_rate: Option<Vec<f64>>

Energy cost rate in $/kWh, one entry per phase in terminal-map order.

extras: BTreeMap<String, Value>

Implementations

impl VoltageSource

pub fn new( name: impl Into<String>, bus: impl Into<String>, terminal_map: Vec<String>, v_magnitude: Vec<f64>, v_angle: Vec<f64>, ) -> VoltageSource

pub fn with_reference_terminal( self, terminal: impl Into<String>, ) -> VoltageSource

Trait Implementations

impl Clone for VoltageSource

fn clone(&self) -> VoltageSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoltageSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VoltageSource

fn deserialize<D>( deserializer: D, ) -> Result<VoltageSource, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for VoltageSource

Available on crate feature schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for VoltageSource

fn eq(&self, other: &VoltageSource) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for VoltageSource

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VoltageSource