Jet

class fridom.nonhydro.initial_conditions.jet.Jet(mset: ModelSettings, jet_strength=1, jet_width=0.16, pert_strength=0.05, pert_wavenum=5, geo_proj=True)

Bases: State

A 3D jet with horizontal and vertical shear.

Description

Superposition of a zonal jet and a geostrophic perturbation. Following the setup of Chouksey et al. 2022. For very large jet_strengths, convective instabilities can occur.

Parameters

msetModelSettings

The model settings.

jet_strengthfloat

The strength of the zonal jets.

jet_widthfloat

The width of the zonal jets.

pert_strengthfloat

The strength of the perturbation.

pert_wavenumint

The wavenumber of the perturbation.

geo_projbool

Whether to project the initial condition to the geostrophic subspace.

Examples

import fridom.nonhydro as nh
# Set up the model settings
fac = 7
grid = nh.grid.cartesian.Grid(
    N=(2**fac, 2**fac, 2**(fac-3)), 
    L=(4, 4, 1), 
    periodic_bounds=(True, True, True))
mset = nh.ModelSettings(grid=grid, f0=1, N2=1.0, dsqr=0.2**2, Ro=0.1)
mset.time_stepper.dt = 2**(-fac) * 2
mset.setup()
# Create the initial conditions
model = nh.Model(mset)
model.z = nh.initial_conditions.Jet(
    mset, jet_strength=2, jet_width=0.16, 
    pert_strength=0.1, pert_wavenum=2)
model.run(runlen=50.0)

__init__(mset: ModelSettings, jet_strength=1, jet_width=0.16, pert_strength=0.05, pert_wavenum=5, geo_proj=True)

Methods

__init__(mset[, jet_strength, jet_width, ...])
dot(other)	Calculate the dot product of the state with another state.
fft([padding])	Calculate the Fourier transform of the state.
from_netcdf(mset, path)	Read the state from a NetCDF file.
has_nan()	Check if the state contains NaN values.
ifft([padding])	Calculate the inverse Fourier transform of the state.
norm_l2()	Calculate the L2 norm of the state.
norm_of_diff(other)	The norm of the difference between two states.
project(p_vec, q_vec)	Project the state on a (spectral) vector.
sync()	Synchronize the state.
to_netcdf(path)	Write the state to a NetCDF file.

Attributes

arr_dict	Return the dictionary of arrays (not FieldVariables).
b	Buoyancy
cfl	The CFL number.
ekin	The kinetic energy
epot	The potential energy
etot	The total energy
field_list	Return the list of fields.
grid	Return the grid of the model.
linear_pot_vort	Linearized potential vorticity
local_Ro	Local Rossby number
pot_vort	Scaled potential vorticity field.
rel_vort	The relative vorticity
rel_vort_x	X-component of the relative vorticity
rel_vort_y	Y-component of the relative vorticity
rel_vort_z	Z-component of the relative vorticity (Horizontal Vorticity)
u	Velocity in the x-direction.
v	Velocity in the y-direction.
w	Velocity in the z-direction.
xr	State as xarray dataset
xrs	State of sliced domain as xarray dataset