Skip to main content

ScenarioBuilder

Struct ScenarioBuilder 

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

Reusable physical context and limits for named scenario construction.

Implementations§

Source§

impl ScenarioBuilder

Source

pub fn new( frequency: Hertz, medium: ScalarMedium, singularity_radius: PositiveMetres, limits: ScenarioLimits, ) -> Self

Constructs a builder from checked physical values and explicit limits.

Source

pub fn two_point( self, first: Point3M, second: Point3M, amplitude_per_source: FieldAmplitude, relative_phase: Radians, ) -> Result<NamedScenario, ScenarioError>

Builds two equal-amplitude ideal isotropic point sources.

Source

pub fn counter_propagating_planes( self, centre: Point3M, axis: UnitVector3, source_separation: PositiveMetres, amplitude_per_source: FieldAmplitude, relative_phase: Radians, ) -> Result<NamedScenario, ScenarioError>

Builds equal plane waves directed into a slab around centre.

Source

pub fn phased_array( self, centre: Point3M, element_axis: UnitVector3, elements: usize, spacing: PositiveMetres, total_amplitude: FieldAmplitude, first_phase: Radians, progressive_phase: Radians, policy: AperturePolicy, ) -> Result<NamedScenario, ScenarioError>

Builds a centred line array of ideal point elements.

Source

pub fn discrete_aperture( self, centre: Point3M, u_axis: UnitVector3, v_axis: UnitVector3, rows: usize, columns: usize, spacing_u: PositiveMetres, spacing_v: PositiveMetres, total_amplitude: FieldAmplitude, phase: Radians, policy: AperturePolicy, ) -> Result<NamedScenario, ScenarioError>

Builds a centred rectangular aperture of equal ideal point elements.

Trait Implementations§

Source§

impl Clone for ScenarioBuilder

Source§

fn clone(&self) -> ScenarioBuilder

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 Copy for ScenarioBuilder

Source§

impl Debug for ScenarioBuilder

Source§

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

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

impl PartialEq for ScenarioBuilder

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScenarioBuilder

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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