Struct shallow_water::sta2dfft::D2FFT

pub struct D2FFT {
    pub nx: usize,
    pub ny: usize,
    pub xfactors: [usize; 5],
    pub yfactors: [usize; 5],
    pub xtrig: Vec<f64>,
    pub ytrig: Vec<f64>,
}

Fields

nx: usize

ny: usize

xfactors: [usize; 5]

yfactors: [usize; 5]

xtrig: Vec<f64>

ytrig: Vec<f64>

Implementations

impl D2FFT

pub fn new(
    nx: usize,
    ny: usize,
    lx: f64,
    ly: f64,
    kx: &mut [f64],
    ky: &mut [f64]
) -> Self

This subroutine performs the initialisation work for all subsequent transform and derivative routines. It calls the initfft() routine from the supproting 1d FFT module for transforms in both x and y directions. The routine then defines the two wavenumber arrays, one in each direction.

pub fn ptospc(&self, rvar: ArrayViewMut2<'_, f64>, svar: ArrayViewMut2<'_, f64>)

Performs a physical -> spectral transform of a variable rvar(ny,nx) periodic in x and y, and returns the result (transposed) in svar(nx,ny). *** Note rvar is destroyed on return. ***

pub fn spctop(&self, svar: ArrayViewMut2<'_, f64>, rvar: ArrayViewMut2<'_, f64>)

Performs a spectral -> physical transform of a variable svar(nx,ny) periodic in x and y and returns the result (transposed) in rvar(ny,nx). *** Note svar is destroyed on return. ***

pub fn xderiv(
    &self,
    rkx: &[f64],
    var: ArrayView2<'_, f64>,
    der: ArrayViewMut2<'_, f64>
)

Computes der = d(var)/dx, spectrally, for a variable var(nx,ny) periodic in x and y. *** both var and der are spectral ***

pub fn yderiv(
    &self,
    rky: &[f64],
    var: ArrayView2<'_, f64>,
    der: ArrayViewMut2<'_, f64>
)

Computes der = d(var)/dy, spectrally, for a variable var(nx,ny) periodic in x and y. *** both var and der are spectral ***

Trait Implementations

impl Clone for D2FFT

fn clone(&self) -> D2FFT

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for D2FFT

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for D2FFT

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<D2FFT> for D2FFT

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for D2FFT

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for D2FFT