Feature: vertical wind velocity diagnostic (#16)

This commit includes * Wind diagnostic * Update of the documentation with the vertical velocity fields diagnostic * Added a new notebook to show the vertical wind velocity
Climdyn · Dec 11, 2022 · 35e42e9 · 35e42e9
1 parent fa6c67e
commit 35e42e9
Show file tree

Hide file tree

Showing 9 changed files with 1,304 additions and 17 deletions.
diff --git a/documentation/source/files/technical/tensors.rst b/documentation/source/files/technical/tensors.rst
@@ -7,3 +7,7 @@ Module holding the model's tendencies tensor encoding each of their additive ter
 .. automodule:: qgs.tensors.qgtensor
     :show-inheritance:
     :members:
+
+.. automodule:: qgs.tensors.atmo_thermo_tensor
+    :show-inheritance:
+    :members:
diff --git a/documentation/source/files/user_guide.rst b/documentation/source/files/user_guide.rst
@@ -510,9 +510,10 @@ Note that it is also possible to use other ordinary differential equations integ
     * :class:`.MiddleAtmosphericUWindDiagnostic`: Diagnostic giving the middle atmospheric U wind fields :math:`- \partial_y \psi_{\rm a}`.
     * :class:`.UpperLayerAtmosphericVWindDiagnostic`: Diagnostic giving the upper layer atmospheric V wind fields :math:`\partial_x \psi^1_{\rm a}`.
     * :class:`.UpperLayerAtmosphericUWindDiagnostic`: Diagnostic giving the upper layer atmospheric U wind fields :math:`- \partial_y \psi^1_{\rm a}`.
-    * :class:`.LowerLayerAtmosphericWindIntensityDiagnostic`: Diagnostic giving the lower layer atmospheric wind intensity fields.
-    * :class:`.MiddleAtmosphericWindIntensityDiagnostic`: Diagnostic giving the middle atmospheric wind intensity fields.
-    * :class:`.UpperLayerAtmosphericWindIntensityDiagnostic`: Diagnostic giving the upper layer atmospheric wind intensity fields.
+    * :class:`.LowerLayerAtmosphericWindIntensityDiagnostic`: Diagnostic giving the lower layer atmospheric horizontal wind intensity fields.
+    * :class:`.MiddleAtmosphericWindIntensityDiagnostic`: Diagnostic giving the middle atmospheric horizontal wind intensity fields.
+    * :class:`.UpperLayerAtmosphericWindIntensityDiagnostic`: Diagnostic giving the upper layer atmospheric horizontal wind intensity fields.
+    * :class:`.MiddleLayerVerticalVelocity`: Diagnostic giving the middle atmospheric layer vertical wind intensity fields.
     * :class:`.MiddleAtmosphericEddyHeatFluxDiagnostic`: Diagnostic giving the middle atmospheric eddy heat flux field.
     * :class:`.MiddleAtmosphericEddyHeatFluxProfileDiagnostic`: Diagnostic giving the middle atmospheric eddy heat flux zonally averaged profile.
 

diff --git a/notebooks/diagnostics/eddy_heat_flux.ipynb b/notebooks/diagnostics/eddy_heat_flux.ipynb
@@ -401,16 +401,12 @@
     "                 diagnostic_kwargs={'show_time': False, 'background': background},\n",
     "                 plot_kwargs={'ms': 0.2})\n",
     "\n",
-    "# m.add_diagnostic(vwind)#,\n",
-    "                 #diagnostic_kwargs={'style': 'contour', 'contour_labels': False},\n",
-    "                 #plot_kwargs={'colors': 'k'})\n",
-    "        \n",
     "m.add_diagnostic(eddy, plot_kwargs={'cmap':plt.get_cmap('magma')})\n",
     "m.add_diagnostic(eddyp, plot_kwargs={'figsize':(10,8)})\n",
     "\n",
     "m.add_diagnostic(temp)\n",
     "                 \n",
-    "m.set_data(reference_time, reference_traj)"
+    "m.set_data(reference_time[:2000], reference_traj[:,:2000])"
    ]
   },
   {