case

Physical parameters and forcings.

This module comes down to Case class. This class can be obtained by the prefix tunax.case. or directly by tunax..

class Case(rho0=1024.0, grav=9.81, cp=3985.0, alpha=0.0002, beta=0.0008, t_rho_ref=0.0, s_rho_ref=35.0, vkarmn=0.384, fcor=0.0, ustr_sfc=0.0, ustr_btm=0.0, vstr_sfc=0.0, vstr_btm=0.0, tflx_sfc=0.0, tflx_btm=0.0, sflx_sfc=0.0, sflx_btm=0.0, rflx_sfc_max=0.0)[source]

Physical parameters and forcings.

This class contains all the physical constants, and the constant forcings that definine an experience for the model.

Parameters:

rho0 (float, default=1024.) – cf. attribute.
grav (float, default=9.81) – cf. attribute.
cp (float, default=3985.) – cf. attribute.
alpha (float, default=2e-4) – cf. attribute.
beta (float, default=8e-4) – cf. attribute.
t_rho_ref (float, default=0.) – cf. attribute.
s_rho_ref (float, default=35.) – cf. attribute.
vkarmn (float, default=0.384) – cf. attribute.
fcor (float, default=0.) – cf. attribute.
ustr_sfc (float, default=0.) – cf. attribute.
ustr_btm (float, default=0.) – cf. attribute.
vstr_sfc (float, default=0.) – cf. attribute.
vstr_btm (float, default=0.) – cf. attribute.
tflx_sfc (float, default=0.) – cf. attribute.
tflx_btm (float, default=0.) – cf. attribute.
sflx_sfc (float, default=0.) – cf. attribute.
sflx_btm (float, default=0.) – cf. attribute.
rflx_sfc_max (float, default=0.) – cf. attribute.

rho0

Default density of saltwater \([\text{kg} \cdot \text{m}^{-3}]\).

Type:: float, default=1024.

grav

Gravity acceleration \([\text{m} \cdot \text{s}^{-2}]\).

Type:: float, default=9.81

cp

Specific heat capacity of saltwater \([\text{J} \cdot \text{kg}^{-1} \cdot \text{K}^{-1}]\).

Type:: float, default=3985.

alpha

Thermal expansion coefficient \([\text{K}^{-1}]\).

Type:: float, default=2e-4

beta

Salinity expansion coefficient \([\text{psu}^{-1}]\).

Type:: float, default=8e-4

t_rho_ref

Reference temperature for the density computation \([° \text C]\).

Type:: float, default=0.

s_rho_ref

Reference salinity for the density computation \([\text{psu}]\).

Type:: float, default=35.

vkarmn

Von Kármán constant \([\text{dimensionless}]\).

Type:: float, default=0.384

fcor

Coriolis frequency at the water column \([\text{rad} \cdot \text{s}^{-1}]\).

Type:: float, default=0.

ustr_sfc

Zonal wind stress \([\text{m}^{2} \cdot \text{s}^{-2}]\).

Type:: float, default=0.

ustr_btm

Zonal current stress at the bottom \([\text{m}^{2} \cdot \text{s}^{-2}]\).

Type:: float, default=0.

vstr_sfc

Meridional wind stress \([\text{m}^{2} \cdot \text{s}^{-2}]\).

Type:: float, default=0.

vstr_btm

Meridional current stress at the bottom \([\text{m}^{2} \cdot \text{s}^{-2}]\).

Type:: float, default=0.

tflx_sfc

Non-penetrative heat flux at the surface \([\text{K} \cdot \text{m} \cdot \text{s}^{-1}]\).

Type:: float, default=0.

tflx_btm

Non-penetrative heat flux at the bottom \([\text{K} \cdot \text{m} \cdot \text{s}^{-1}]\).

Type:: float, default=0.

sflx_sfc

Fresh water flux at the surface \([\text{psu} \cdot \text{m} \cdot \text{s}^{-1}]\).

Type:: float, default=0.

sflx_btm

Fresh water flux at the bottom \([\text{psu} \cdot \text{m} \cdot \text{s}^{-1}]\).

Type:: float, default=0.

rflx_sfc_max

Maximum solar radiation flux at the surface \([\text{K} \cdot \text{m} \cdot \text{s}^{-1}]\).

Type:: float, default=0.

set_lat(lat)[source]

Set the Coriolis frequency from the latitude.

Parameters:: lat (float) – Latitude of the water column \([°]\).
Returns:: case – The self object with the the new value of fcor.
Return type:: Case

set_u_wind(u_wind)[source]

Set the zonal wind stress with the zonal wind speed.

Parameters:: u_wind (float) – Zonal wind speed \([\text m \cdot \text s ^{-1}]\).
Returns:: case – The self object with the new value of ustr_sfc.
Return type:: Case

set_u_cur(u_cur)[source]

Set the zonal current stress with the zonal current.

Parameters:: u_cur (float) – Zonal current speed \([\text m \cdot \text s ^{-1}]\).
Returns:: case – The self object with the new value of ustr_btm.
Return type:: Case

set_v_wind(v_wind)[source]

Set the meridional wind stress with the meridional wind.

Parameters:: v_wind (float) – Meridional wind speed \([\text m \cdot \text s ^{-1}]\).
Returns:: case – The self object with the new value of vstr_sfc.
Return type:: Case

set_v_cur(v_cur)[source]

Set the meridional current stress with the meridional current.

Parameters:: v_cur (float) – Meridional current speed \([\text m \cdot \text s ^{-1}]\).
Returns:: case – The self object with the new value of vstr_btm.
Return type:: Case

set_tpw_sfc(tpw_sfc)[source]

Set the heat flux at surface from the heat power.

Parameters:: tpw_sfc (float) – Non-penetrative heat power at the surface \([\text W \cdot \text m ^{-2}]\).
Returns:: case – The self object with the new value of tflx_sfc.
Return type:: Case

set_tpw_btm(tpw_btm)[source]

Set the heat flux at bottom from the heat power.

Parameters:: tpw_btm (float) – Non-penetrative heat power at the bottom \([\text W \cdot \text m ^{-2}]\).
Returns:: case – The self object with the new value of tflx_btm.
Return type:: Case

set_rpw_sfc_max(rpw_sfc_max)[source]

Set the maximum solar radiation from the solar power

Parameters:: rpw_sfc_max (float) – Maximum solar radiation power at the surface (penetrative) \([\text W \cdot \text m ^{-2}]\).
Returns:: case – The self object with the new value of rflx_sfc_max.
Return type:: Case