From f7042b738da746cbb6ba752e01c3894b09b6f1a4 Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Wed, 3 Apr 2024 12:56:24 +0300 Subject: [PATCH] Add info about models that support BackgroundFields (#3532) * add info about models that support BackgroundFields * Update docs/src/model_setup/background_fields.md Co-authored-by: Gregory L. Wagner * resolve some deps versions --------- Co-authored-by: Gregory L. Wagner --- Manifest.toml | 24 +++++++++++------------ docs/src/model_setup/background_fields.md | 7 +++++-- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/Manifest.toml b/Manifest.toml index f4bb73cd7d..c259927dff 100644 --- a/Manifest.toml +++ b/Manifest.toml @@ -321,9 +321,9 @@ version = "1.3.1" [[deps.GnuTLS_jll]] deps = ["Artifacts", "GMP_jll", "JLLWrappers", "Libdl", "Nettle_jll", "P11Kit_jll", "Zlib_jll"] -git-tree-sha1 = "f3c0936dd685d57fa0b1eee7dbebf382b969ea63" +git-tree-sha1 = "383db7d3f900f4c1f47a8a04115b053c095e48d3" uuid = "0951126a-58fd-58f1-b5b3-b08c7c4a876d" -version = "3.8.3+0" +version = "3.8.4+0" [[deps.HDF5_jll]] deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "LazyArtifacts", "LibCURL_jll", "Libdl", "MPICH_jll", "MPIPreferences", "MPItrampoline_jll", "MicrosoftMPI_jll", "OpenMPI_jll", "OpenSSL_jll", "TOML", "Zlib_jll", "libaec_jll"] @@ -661,9 +661,9 @@ version = "4.1.6+0" [[deps.OpenSSL_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "60e3045590bd104a16fefb12836c00c0ef8c7f8c" +git-tree-sha1 = "3da7367955dcc5c54c1ba4d402ccdc09a1a3e046" uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95" -version = "3.0.13+0" +version = "3.0.13+1" [[deps.OpenSpecFun_jll]] deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Pkg"] @@ -1015,9 +1015,9 @@ uuid = "a759f4b9-e2f1-59dc-863e-4aeb61b1ea8f" version = "0.5.23" [[deps.TranscodingStreams]] -git-tree-sha1 = "14389d51751169994b2e1317d5c72f7dc4f21045" +git-tree-sha1 = "71509f04d045ec714c4748c785a59045c3736349" uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa" -version = "0.10.6" +version = "0.10.7" weakdeps = ["Random", "Test"] [deps.TranscodingStreams.extensions] @@ -1053,15 +1053,15 @@ version = "1.3.0" [[deps.XML2_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Libiconv_jll", "Zlib_jll"] -git-tree-sha1 = "07e470dabc5a6a4254ffebc29a1b3fc01464e105" +git-tree-sha1 = "532e22cf7be8462035d092ff21fada7527e2c488" uuid = "02c8fc9c-b97f-50b9-bbe4-9be30ff0a78a" -version = "2.12.5+0" +version = "2.12.6+0" [[deps.XZ_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "31c421e5516a6248dfb22c194519e37effbf1f30" +git-tree-sha1 = "ac88fb95ae6447c8dda6a5503f3bafd496ae8632" uuid = "ffd25f8a-64ca-5728-b0f7-c24cf3aae800" -version = "5.6.1+0" +version = "5.4.6+0" [[deps.Zlib_jll]] deps = ["Libdl"] @@ -1070,9 +1070,9 @@ version = "1.2.13+1" [[deps.Zstd_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "49ce682769cd5de6c72dcf1b94ed7790cd08974c" +git-tree-sha1 = "e678132f07ddb5bfa46857f0d7620fb9be675d3b" uuid = "3161d3a3-bdf6-5164-811a-617609db77b4" -version = "1.5.5+0" +version = "1.5.6+0" [[deps.libaec_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] diff --git a/docs/src/model_setup/background_fields.md b/docs/src/model_setup/background_fields.md index fd4a526866..c99dc7421e 100644 --- a/docs/src/model_setup/background_fields.md +++ b/docs/src/model_setup/background_fields.md @@ -1,8 +1,8 @@ # Background fields `BackgroundField`s are velocity and tracer fields around which the resolved -velocity and tracer fields evolve. In `Oceananigans`, only the _advective_ terms -associated with the interaction between background and resolved fields are included. +velocity and tracer fields evolve. Only the _advective_ terms associated with +the interaction between background and resolved fields are included. For example, tracer advection is described by ```math @@ -36,6 +36,9 @@ velocity field. Other possible terms associated with the Coriolis force, buoyancy, turbulence closures, and surface waves acting on background fields are neglected. +!!! compat "Model compatibility" + `BackgroundFields` are only supported by [`NonhydrostaticModel`](@ref). + ## Specifying background fields `BackgroundField`s are defined by functions of ``(x, y, z, t)`` and optional parameters. A