CoherentEddy

class fridom.shallowwater.initial_conditions.coherent_eddy.CoherentEddy(mset: ModelSettings, pos_x: float = 0.5, pos_y: float = 0.5, width: float = 0.1, amplitude: float = 1, gauss_field: str = 'vorticity')

Bases: State

Coherent barotropic eddy with Gaussian shape.

Description

There are two versions of the coherent eddy. In the first version, the streamfunction of the eddy is given by an gaussian function:

\[\psi = A \exp\left( -\frac{(x - p_x L_x)^2 + (y - p_y L_y)^2}{(\sigma L_x)^2}\right)\]

where \(A\) is the amplitude, \((p_x, p_y)\) is the relative position of the eddy, \((\sigma L_x)\) is the width of the eddy, and \(L_x, L_y\) are the domain sizes in the x and y directions. The velocity field is given by:

\[u = \partial_y \psi, \quad v = -\partial_x \psi\]

The second version of the coherent eddy prescribes the horizontal velocity as a gaussian function:

\[\zeta = A \exp\left( -\frac{(x - p_x L_x)^2 + (y - p_y L_y)^2}{(\sigma L_x)^2}\right)\]

Then the streamfunction is computed in spectral space:

\[\hat{\psi} = \frac{\hat{\zeta}}{k_x^2 + k_y^2}\]

Parameters

msetModelSettings

The model settings.

pos_xfloat, optional (default=0.5)

The relative position of the eddy in the x-direction.

pos_yfloat, optional (default=0.5)

The relative position of the eddy in the y-direction.

widthfloat, optional (default=0.1)

The relative width of the eddy. (relative to the domain size in the x-direction)

amplitudefloat, optional (default=1)

The amplitude of the eddy. When the amplitude negative, the eddy rotates clockwise. Otherwise, it rotates counterclockwise.

gauss_fieldstr, optional (default=’vorticity’)

The field that is prescribed as a gaussian function. It can be either ‘vorticity’ or ‘streamfunction’.

__init__(mset: ModelSettings, pos_x: float = 0.5, pos_y: float = 0.5, width: float = 0.1, amplitude: float = 1, gauss_field: str = 'vorticity') → None

Methods

__init__(mset[, pos_x, pos_y, 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).
cfl	The CFL number.
ekin	Vertically integrated kinetic energy
epot	Vertically integrated kinetic energy
etot	The total energy
field_list	Return the list of fields.
grid	Return the grid of the model.
local_Ro	Local Rossby number
p	Pressure \(p = g \eta\), where \(\eta\) is the free surface elevation.
pot_vort	Scaled potential vorticity field.
rel_vort	Relative vorticity
u	Velocity in the x-direction.
v	Velocity in the y-direction.
xr	State as xarray dataset
xrs	State of sliced domain as xarray dataset