Skip to content

Commit b6c5ce8

Browse files
authored
Add JRA55 references + fix Edson stability function latex rendering in docstring (#536)
* add ETOPO * better latex rendering * add JRA55 refs
1 parent ebf8597 commit b6c5ce8

File tree

4 files changed

+62
-31
lines changed

4 files changed

+62
-31
lines changed

docs/climaocean.bib

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,23 @@ @article{nishizawa2018surface
2929
doi = {10.1029/2018MS001534},
3030
year = {2018}
3131
}
32+
33+
@article{stewart2020jra55,
34+
title={{JRA55-do-based} repeat year forcing datasets for driving ocean--sea-ice models},
35+
author={Stewart, K D and Kim, W M and Urakawa, S and Hogg, A McC and Yeager, S and Tsujino, H and Nakano, H and Kiss, A E and Danabasoglu, G},
36+
journal={Ocean Modelling},
37+
volume={147},
38+
pages={101557},
39+
year={2020},
40+
doi={10.1016/j.ocemod.2019.101557}
41+
}
42+
43+
@article{tsujino2018jra,
44+
title={JRA-55 based surface dataset for driving ocean--sea-ice models (JRA55-do)},
45+
author={Tsujino, H and Urakawa, S and Nakano, H and Small, R J and Kim, W M and Yeager, S G and Danabasoglu, G and Suzuki, T and Bamber, J L and Bentsen, M and and B{\"o}ning, C and Bozec, A and Chassignet, E and Curchitser, E and Dias, F and Durack, P J and Griffies, S M and Harada, Y and Ilicak, M and Josey, S A and Kobayashi, C and Kobayashi, S and Komuro, Y and Large, W G and Sommer, J and Marsland, S J and Masina, S and Scheinert, M and Tomita, H and ValRdivieso, M and Yamazaki, D},
46+
journal={Ocean Modelling},
47+
volume={130},
48+
pages={79--139},
49+
year={2018},
50+
doi={10.1016/j.ocemod.2018.07.002}
51+
}

src/DataWrangling/DataWrangling.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Note: if called by multiple processes via MPI, `download_dataset` should only ru
140140
Arguments
141141
=========
142142
- `metadata`: The metadata specifying the dataset to be downloaded. Available options are metadata for
143-
ECCO4, ECCO2, EN4, and JRA55 datasets.
143+
ETOPO, ECCO4, ECCO2, EN4, and JRA55 datasets.
144144
145145
!!! info "Credential setup requirements for ECCO datasets"
146146

src/DataWrangling/JRA55/JRA55_field_time_series.jl

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Adapt.adapt_structure(to, b::JRA55NetCDFBackend) = JRA55NetCDFBackend(b.start, b
8181
"""
8282
JRA55NetCDFBackend(length)
8383
84-
Represents a JRA55 FieldTimeSeries backed by JRA55 native .nc files.
84+
Represents a JRA55 FieldTimeSeries backed by JRA55 native netCDF files.
8585
"""
8686
JRA55NetCDFBackend(length, metadata::Metadata) = JRA55NetCDFBackend(1, length, metadata)
8787
JRA55NetCDFBackend(start::Integer, length::Integer) = JRA55NetCDFBackend(start, length, nothing)
@@ -235,9 +235,7 @@ new_backend(b::JRA55NetCDFBackend, start, length) = JRA55NetCDFBackend(start, le
235235
236236
Return a `FieldTimeSeries` containing atmospheric reanalysis data for `variable_name`,
237237
which describes one of the variables from the Japanese 55-year atmospheric reanalysis
238-
for driving ocean-sea ice models (JRA55-do). The JRA55-do dataset is described by:
239-
240-
> Tsujino et al. (2018). JRA-55 based surface dataset for driving ocean-sea-ice models (JRA55-do), _Ocean Modelling_, **130(1)**, 79-139
238+
for driving ocean-sea ice models (JRA55-do). The JRA55-do dataset is described by [tsujino2018jra](@citet).
241239
242240
The `variable_name`s (and their `shortname`s used in the netCDF files) available from the JRA55-do are:
243241
- `:river_freshwater_flux` ("friver")
@@ -264,9 +262,7 @@ Keyword arguments
264262
265263
!!! info "Repeat-year forcing"
266264
267-
For more information about the derivation of the repeat-year forcing dataset, see:
268-
269-
> Stewart et al. (2020). JRA55-do-based repeat year forcing datasets for driving ocean–sea-ice models, _Ocean Modelling_, **147**, 101557, https://doi.org/10.1016/j.ocemod.2019.101557.
265+
For more information about the derivation of the repeat-year forcing dataset, see [stewart2020jra55](@citet).
270266
271267
The repeat year in `RepeatYearJRA55()` corresponds to May 1st, 1990 - April 30th, 1991. However, the
272268
returned dataset has dates that range from January 1st to December 31st. This implies
@@ -292,7 +288,14 @@ Keyword arguments
292288
- `backend`: Backend for the `FieldTimeSeries`. The two options are:
293289
* `InMemory()`: the whole time series is loaded into memory.
294290
* `JRA55NetCDFBackend(total_time_instances_in_memory)`: only a subset of the time series
295-
is loaded into memory. Default: `InMemory()`.
291+
is loaded into memory. Default: `InMemory()`.
292+
293+
References
294+
==========
295+
296+
- Tsujino et al. (2018). JRA-55 based surface dataset for driving ocean-sea-ice models (JRA55-do), _Ocean Modelling_, **130(1)**, 79-139.
297+
298+
- Stewart et al. (2020). JRA55-do-based repeat year forcing datasets for driving ocean–sea-ice models, _Ocean Modelling_, **147**, 101557.
296299
"""
297300
function JRA55FieldTimeSeries(variable_name::Symbol, architecture=CPU(), FT=Float32;
298301
dataset = RepeatYearJRA55(),

src/OceanSeaIceModels/InterfaceComputations/similarity_theory_turbulent_fluxes.jl

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -304,25 +304,29 @@ These stability functions are obtained by regression to experimental data.
304304
305305
The stability parameter for stable atmospheric conditions is defined as
306306
```math
307-
dζ = min(ζmax, Aˢζ)
308-
ψₛ = - Bˢ * ζ⁺ - Cˢ * (ζ⁺ - Dˢ) * exp(- dζ) - Cˢ * Dˢ
307+
\\begin{align*}
308+
dζ &= \\min(ζ_{\\max}, A⁺ ζ) \\\\
309+
ψ⁺ &= - B⁺ ζ⁺ - C⁺ (ζ⁺ - D⁺) \\exp(- dζ) - C⁺ D⁺
310+
\\end{align*}
309311
```
310312
311313
While the stability parameter for unstable atmospheric conditions is calculated
312314
as a function of the two individual stability functions as follows
313315
314316
```math
315-
fᵤ₁ = √√(1 - Aᵘζ)
316-
ψᵤ₁ = Bᵘ / 2 ⋅ log((1 + fᵤ₁ + fᵤ₁² + fᵤ₁³) / Bᵘ) - √Bᵘ atan(fᵤ₁) - Cᵘ
317-
318-
fᵤ₂ = ∛(1 - Dᵘζ)
319-
ψᵤ₂ = Eᵘ / 2 ⋅ log((1 + fᵤ₂ + fᵤ₂²) / Eᵘ) - √Eᵘ atan( (1 + 2fᵤ₂) / √Eᵘ) + Fᵘ
320-
321-
f = ζ² / (1 + ζ²)
322-
ψᵤ = (1 - f) ψᵤ₁ + f ψᵤ₂
317+
\\begin{align*}
318+
f⁻₁ &= (1 - A⁻ζ)^{1/4} \\\\
319+
ψ⁻₁ &= (B⁻ / 2) \\log[(1 + f⁻₁ + f⁻₁² + f⁻₁³) / B⁻] - √B⁻ \\mathrm{atan}(f⁻₁) - C⁻ \\\\
320+
\\\\
321+
f⁻₂ &= ∛(1 - D⁻ζ) \\\\
322+
ψ⁻₂ &= (E⁻ / 2) \\log[(1 + f⁻₂ + f⁻₂²) / E⁻]- √E⁻ \\mathrm{atan}[(1 + 2f⁻₂) / √E⁻] + F⁻ \\\\
323+
\\\\
324+
f &= ζ² / (1 + ζ²) \\\\
325+
ψ⁻ &= (1 - f) ψ⁻₁ + f ψ⁻₂
326+
\\end{align*}
323327
```
324328
325-
The superscripts ``ˢ`` and ```` indicate if the parameter applies to the
329+
The superscripts ``+`` and ``-`` indicate if the parameter applies to the
326330
stability function for _stable_ or _unstable_ atmospheric conditions, respectively.
327331
"""
328332
@kwdef struct EdsonMomentumStabilityFunction{FT} <: AbstractStabilityFunction
@@ -385,24 +389,28 @@ These stability functions are obtained by regression to experimental data.
385389
The stability parameter for stable atmospheric conditions is defined as
386390
387391
```math
388-
dζ = min(ζmax, A⁺ζ)
389-
ψ⁺ = - (1 + B⁺ ζ) ^ C⁺ - B⁺ ( ζ - D⁺ ) * exp( - dζ) - E⁺
392+
\\begin{align*}
393+
dζ &= \\min(ζ_{\\max}, A⁺ζ) \\\\
394+
ψ⁺ &= - (1 + B⁺ ζ)^{C⁺} - B⁺ (ζ - D⁺) \\exp( - dζ) - E⁺
395+
\\end{align*}
390396
```
391397
392398
While the stability parameter for unstable atmospheric conditions is calculated
393399
as a function of the two individual stability functions as follows
394400
```math
395-
f⁻₁ = √(1 - A⁻ζ)
396-
ψ⁻₁ = B⁻ ⋅ log((1 + f⁻₁) / B⁻) + C⁻
397-
398-
f⁻₂ = ∛(1 - D⁻ζ)
399-
ψ⁻₂ = E⁻ / 2 ⋅ log((1 + f⁻₂ + f⁻₂²) / E⁻) - √E⁻ atan( (1 + 2f⁻₂) / √E⁻) + F⁻
400-
401-
f = ζ² / (1 + ζ²)
402-
ψ⁻ = (1 - f) ψ⁻₁ + f ψ⁻₂
401+
\\begin{align*}
402+
f⁻₁ &= √(1 - A⁻ζ) \\\\
403+
ψ⁻₁ &= B⁻ \\log[(1 + f⁻₁) / B⁻] + C⁻ \\\\
404+
\\\\
405+
f⁻₂ &= ∛(1 - D⁻ζ) \\\\
406+
ψ⁻₂ &= (E⁻ / 2) \\log[(1 + f⁻₂ + f⁻₂²) / E⁻] - √E⁻ \\mathrm{atan}[(1 + 2f⁻₂) / √E⁻] + F⁻ \\\\
407+
\\\\
408+
f &= ζ² / (1 + ζ²) \\\\
409+
ψ⁻ &= (1 - f) ψ⁻₁ + f ψ⁻₂
410+
\\end{align*}
403411
```
404412
405-
The superscripts ```` and ```` indicate if the parameter applies to the
413+
The superscripts ``+`` and ``-`` indicate if the parameter applies to the
406414
stability function for _stable_ or _unstable_ atmospheric conditions, respectively.
407415
"""
408416
@kwdef struct EdsonScalarStabilityFunction{FT} <: AbstractStabilityFunction

0 commit comments

Comments
 (0)