fluidsim.solvers.sw1l.state

State for the SW1L solver (fluidsim.solvers.sw1l.state)

class fluidsim.solvers.sw1l.state.StateSW1L(sim, oper=None)

Bases: StatePseudoSpectral

State for the solver sw1l.

Contains the variables corresponding to the state and handles the access to other fields for the solver SW1L.

static _complete_info_solver(info_solver)

Complete the ParamContainer info_solver.

This is a static method!

compute(key, SAVE_IN_DICT=True, RAISE_ERROR=True)

Compute and return a variable.

statespect_from_statephys()

Compute the state in Fourier space.

statephys_from_statespect(state_spect=None, state_phys=None)

Compute the state in physical space.

return_statephys_from_statespect(state_spect=None)

Return the state in physical space as a new object separate from self.state_phys.

init_statespect_from(**kwargs)

Initializes state_spect using arrays provided as keyword arguments.

init_from_etafft(eta_fft)

Initialize from \(\hat \eta\) and set velocities to zero.

init_from_uxuyetafft(ux_fft, uy_fft, eta_fft)

Self explanatory.

init_from_rotuxuyfft(rot, ux_fft, uy_fft)

Initializes from velocities and discards vorticity.

init_from_rotfft(rot_fft)

Initializes with rotational velocities computed from vorticity.

init_from_qfft(q_fft)

Initialize from potential vorticity.

init_from_afft(a_fft)

Initialize from ageostrophic variable.

init_from_qafft(q_fft, a_fft)

Initialize from potential vorticity and ageostrophic variables.

init_from_uxuyfft(ux_fft, uy_fft)

Initialize from velocities and adjust surface displacement by solving a Poisson equation, assuming no mean flow.

Classes

StateSW1L(sim[, oper])

State for the solver sw1l.