Skip to main content

HelmholtzConfig

Struct HelmholtzConfig 

pub struct HelmholtzConfig {
    pub dims: [usize; 3],
    pub spacing_m: [f64; 3],
    pub omega_rad_s: f64,
    pub phase_speed_m_s: f64,
    pub attenuation_np_m: f64,
    pub stencil: HelmholtzStencil,
    pub boundary: HelmholtzBoundary,
}
Expand description

Configuration for the 3D Helmholtz operator $(\nabla^2 + k^2)\hat{p} = -\hat{s}$.

Fields§

§dims: [usize; 3]

Grid dimensions (nx, ny, nz).

§spacing_m: [f64; 3]

Grid spacing (dx, dy, dz) in metres.

§omega_rad_s: f64

Angular frequency $\omega = 2\pi f$ in $\text{rad}\cdot\text{s}^{-1}$ ($\omega \ge 0$).

§phase_speed_m_s: f64

Phase speed $c(\omega) > 0$ in $\text{m}\cdot\text{s}^{-1}$.

§attenuation_np_m: f64

Attenuation coefficient $\alpha(\omega) \ge 0$ in $\text{Np}\cdot\text{m}^{-1}$.

§stencil: HelmholtzStencil

Stencil discretization kind.

§boundary: HelmholtzBoundary

Boundary condition kind.

Implementations§

§

impl HelmholtzConfig

pub fn validate(&self) -> Result<Complex64, NumericalError>

Validate grid dimensions, spacing, and physical wavenumber parameters.

pub fn wavenumber(&self) -> Complex64

Complex wavenumber $k = \frac{\omega}{c(\omega)} + i\alpha(\omega)$ in $\text{m}^{-1}$.

pub fn wavenumber_squared(&self) -> Complex64

Squared complex wavenumber $k^2$.

pub const fn node_count(&self) -> usize

Total grid node count nx * ny * nz.

Trait Implementations§

§

impl Clone for HelmholtzConfig

§

fn clone(&self) -> HelmholtzConfig

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
§

impl Copy for HelmholtzConfig

§

impl Debug for HelmholtzConfig

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for HelmholtzConfig

§

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

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

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for HelmholtzConfig

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
§

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

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.

§

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,