Skip to main content

SplitStep

Struct SplitStep 

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

The Steps of one span in double precision.

Implementations§

Source§

impl SplitStep

Source

pub fn new(medium: &Medium, steps: Steps, n: usize, fs: f64) -> SplitStep

The steps through medium for a block of n samples at fs (no plan for an empty block: the steps then leave it empty).

Source

pub fn steps(&self) -> Steps

The steps.

Source

pub fn run(&self, e: &mut [C64])

Propagate e (√W, time domain) through the steps, in place.

§Panics

If e has another length than the block of SplitStep::new.

Source

pub fn run_dual(&self, x: &mut [C64], y: &mut [C64])

The steps for the Manakov equation: both polarisations (√W, time domain, equal lengths) in place, with the nonlinear phase $\frac{8}{9} \gamma (|A_{x}|^{2} + |A_{y}|^{2}) h_{\mathrm{NL}}$ at the middle of every step (the back-propagation of a dual-polarisation link).

§Panics

If the polarisations have different lengths, or another length than the block of SplitStep::new.

Source

pub fn run_with_gain(&self, e: &mut [C64], gain: FieldGain<'_>)

SplitStep::run with a distributed gain: before the nonlinear phase and after it, every half step also multiplies the spectrum by gain(z_0, z_1, g), the gain of the field at every frequency (FFT order) from $z_{0}$ to $z_{1}$ (km, from the start of the steps). The medium then carries no attenuation: gain holds the loss as well (the power profile of a Raman-pumped span, comnum_channel::optical::raman). As in SplitStep::run, the field stays in the frequency domain from the end of a step to the start of the next: two FFTs per step.

§Panics

If e has another length than the block of SplitStep::new.

Trait Implementations§

Source§

impl Clone for SplitStep

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 SplitStep

Source§

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

Formats the value using the given formatter. 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> 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 = !

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.