Add divergence of total buoyancy flag

Author: hiromatsui

doc/CALYPSO.pdf

@@ -361,8 +361,16 @@ \subsection{\tt phys\_values\_ctl}
 \tt rot\_inertia & Curl of inertia &  $ -\nabla \times \left(\bvec{\omega} \times \bvec{u}\right) $ \\
 \tt rot\_Lorentz\_force & Curl of Lorentz force &  $ \nabla \times \left(\bvec{J} \times \bvec{B}\right) $ \\
 \tt rot\_Coriolis\_force & Curl of Coriolis force &  $ -2 \Omega \nabla \times \left(\hat{z} \times \bvec{u} \right) $ \\
-\tt rot\_buoyancy                   & Curl of thermal buoyancy &  $ - \nabla \times \left(\alpha_{T} T \bvec{g}\right)  $ \\
+\tt rot\_thermal\_buoyancy &   Curl of thermal buoyancy &  $ - \nabla \times \left(\alpha_{T} T \bvec{g}\right)  $ \\
 \tt rot\_composite\_buoyancy & Curl of compositional buoyancy &  $ - \nabla \times \left(\alpha_{C} C\bvec{g}\right)  $\\
+\tt rot\_buoyancy & Curl of total buoyancy &  $ - \nabla \times \left[\left(\alpha_{T} T + \alpha_{C} C \right) \bvec{g}\right]  $ \\
+\hline
+\tt div\_inertia & Divergence of inertia &  $ -\nabla \cdot \left(\bvec{\omega} \times \bvec{u}\right) $ \\
+\tt div\_Lorentz\_force & Divergence of Lorentz force &  $ \nabla \cdot \left(\bvec{J} \times \bvec{B}\right) $ \\
+\tt div\_Coriolis\_force & Divergence of Coriolis force &  $ -2 \Omega \nabla \cdot \left(\hat{z} \times \bvec{u} \right) $ \\
+\tt div\_thermal\_buoyancy & Divergence of thermal buoyancy &  $ - \nabla \cdot \left(\alpha_{T} T \bvec{g}\right)  $ \\
+\tt div\_composite\_buoyancy & Divergence of compositional buoyancy &  $ - \nabla \cdot \left(\alpha_{C} C \bvec{g}\right)  $\\
+\tt div\_buoyancy & Divergence of total buoyancy &  $ - \nabla \cdot \left[ \left(\alpha_{T} T + \alpha_{C} C \right) \bvec{g}\right]  $ \\
 \hline
 \tt Lorentz\_work & Work of Lorentz force
  & $\bvec{u}\cdot \left( \bvec{J} \times \bvec{B} \right) $ \\ 
@@ -574,8 +582,9 @@ \subsection{\tt forces\_define}
  Label & Field name & Equation \\ \hline
 \verb|Coriolis| & Coriolis force & $-2\Omega \hat{z} \times \bvec{u} $ \\
 \verb|Lorentz| & Lorentz force &  $\bvec{J} \times \bvec{B} $ \\
-\verb|gravity| & Thermal buoyancy & $-\alpha_{T} T \bvec{g}$ \\
+\verb|Thermal_buoyancy| & Thermal buoyancy & $-\alpha_{T} T \bvec{g}$ \\
 \verb|Compositional_buoyancy| & Compositional buoyancy  & $-\alpha_{C} C \bvec{g}$\\ \hline
+\verb|gravity| & Thermal buoyancy {\color{red} (Deprecated)} & $-\alpha_{T} T \bvec{g}$ \\
 \verb|Composite_gravity| & Compositional buoyancy {\color{red} (Deprecated)} & $-\alpha_{C} C \bvec{g}$\\ \hline
 \end{tabular}
 \end{center}

doc/tex_src/controls_CALYPSO.tex

@@ -64,10 +64,10 @@ begin MHD_control
         nod_value_ctl  Lorentz_force            Viz_On   Monitor_On
         nod_value_ctl  inertia                 Viz_On   Monitor_On
 !
-        nod_value_ctl  rot_Coriolis_force            Viz_On   Monitor_On
-        nod_value_ctl  rot_Lorentz_force            Viz_On   Monitor_On
-        nod_value_ctl  rot_inertia            Viz_On   Monitor_On
-        nod_value_ctl  rot_buoyancy            Viz_On   Monitor_On
+        nod_value_ctl  rot_Coriolis_force      Viz_On   Monitor_On
+        nod_value_ctl  rot_Lorentz_force       Viz_On   Monitor_On
+        nod_value_ctl  rot_inertia             Viz_On   Monitor_On
+        nod_value_ctl  rot_thermal_buoyancy    Viz_On   Monitor_On
       end array nod_value_ctl
     end phys_values_ctl
 !

examples/dynamo_benchmark/dynamobench_case_1/control_snapshot

@@ -89,7 +89,7 @@ begin MHD_control
         nod_value_ctl  rot_Coriolis_force       Viz_On   Monitor_Off
         nod_value_ctl  rot_Lorentz_force        Viz_On   Monitor_Off
         nod_value_ctl  rot_inertia              Viz_On   Monitor_Off
-        nod_value_ctl  rot_buoyancy             Viz_On   Monitor_Off
+        nod_value_ctl  rot_thermal_buoyancy     Viz_On   Monitor_Off
       end array nod_value_ctl
     end phys_values_ctl
 !

examples/dynamo_benchmark/dynamobench_case_2/control_MHD

@@ -105,7 +105,7 @@ subroutine add_field_name_4_sph_mhd                               &
         if(fl_prop%flag_thermal_buoyancy) then
           call add_phys_name_ctl(thermal_buoyancy, field_ctl)
           call add_phys_name_ctl(rot_thermal_buoyancy, field_ctl)
-          call add_phys_name_ctl(div_buoyancy, field_ctl)
+          call add_phys_name_ctl(div_thermal_buoyancy, field_ctl)
         end if
 !   compositional buoyancy flag
         if(fl_prop%flag_comp_buoyancy) then

src/Fortran_libraries/MHD_src/IO/add_sph_MHD_fields_2_ctl.f90

@@ -158,10 +158,12 @@ subroutine add_field_ctl_4_div_forces(field_ctl)
       if(check_field_list_ctl(div_Lorentz_force, field_ctl))            &
      &   call add_phys_name_ctl(Lorentz_force, field_ctl)
 !
-      if(check_field_list_ctl(div_buoyancy, field_ctl))                 &
+      if(check_field_list_ctl(div_thermal_buoyancy, field_ctl))         &
         call add_phys_name_ctl(thermal_buoyancy, field_ctl)
       if(check_field_list_ctl(div_composite_buoyancy, field_ctl))       &
         call add_phys_name_ctl(composite_buoyancy, field_ctl)
+      if(check_field_list_ctl(div_buoyancy, field_ctl))                 &
+        call add_phys_name_ctl(buoyancy, field_ctl)
 !
       if(check_field_list_ctl(div_momentum_flux, field_ctl))            &
         call add_phys_name_ctl(momentum_flux, field_ctl)

src/Fortran_libraries/SERIAL_src/Fields/check_base_forces.f90

@@ -21,8 +21,9 @@
 !!   div_inertia                [div_forces%i_m_advect]
 !!   div_Coriolis_force         [div_forces%i_Coriolis]
 !!   div_Lorentz_force          [div_forces%i_lorentz]
-!!   div_buoyancy               [div_forces%i_thrm_buo]
+!!   div_thermal_buoyancy       [div_forces%i_thrm_buo]
 !!   div_composite_buoyancy     [div_forces%i_comp_buo]
+!!   div_buoyancy               [div_forces%i_buoyancy]
 !!
 !!   div_momentum_flux          [div_forces%i_m_flux]
 !!   div_maxwell_tensor         [div_forces%i_maxwell]
@@ -68,18 +69,25 @@ module m_div_force_labels
      &                math = '$ \partial_{i}'                           &
      &                    // '(e_{ijk} J_{j} B_{k})$')
 !
-!>        Field label for divergence of filtered thermal buoyancy
-!!         @f$ -\partial_{i} \alpha_{T} g_{i} T @f$
-      type(field_def), parameter :: div_buoyancy                        &
+!>        Field label for divergence of thermal buoyancy
+!!         @f$ -\partial_{i} \alpha_{T} T g_{i} @f$
+      type(field_def), parameter :: div_thermal_buoyancy                &
      &    = field_def(n_comp = n_scalar,                                &
-     &                name = 'div_buoyancy',                            &
+     &                name = 'div_thermal_buoyancy',                    &
      &                math = '$-\partial_{i} \alpha_{T} T g_{i}$')
-!>        Field label for divergence of filtered compositional buoyancy
-!!         @f$ -\partial_{i} \alpha_{C} g_{i} C @f$
+!>        Field label for divergence of compositional buoyancy
+!!         @f$ -\partial_{i} \alpha_{C} C g_{i} @f$
       type(field_def), parameter :: div_composite_buoyancy              &
      &    = field_def(n_comp = n_scalar,                                &
      &                name = 'div_composite_buoyancy',                  &
      &                math = '$-\partial_{i} \alpha_{C} C g_{i}$')
+!>        Field label for divergence of total buoyancy
+!!         @f$ -\partial_{i} (\alpha_{T} T + \alpha_{C} C) g_{i} @f$
+      type(field_def), parameter :: div_buoyancy                        &
+     &    = field_def(n_comp = n_scalar,                                &
+     &                name = 'div_buoyancy',                            &
+     &                math = '$-\partial_{i} (\alpha_{T} T '            &
+     &                    // ' \alpha_{C} C) g_{i}$')
 !
 !>        Field label for divergence of momentum flux
 !!         @f$ \partial_{j} (u_{i} u_{j}) @f$
@@ -143,6 +151,7 @@ logical function check_div_force(field_name)
      &   .or. (field_name .eq. div_Coriolis_force%name)                 &
      &   .or. (field_name .eq. div_Lorentz_force%name)                  &
      &   .or. (field_name .eq. div_buoyancy%name)                       &
+     &   .or. (field_name .eq. div_thermal_buoyancy%name)               &
      &   .or. (field_name .eq. div_composite_buoyancy%name)
 !
       end function check_div_force
@@ -190,8 +199,9 @@ subroutine set_div_force_names(array_c2i)
       call set_field_label_to_ctl(div_inertia,               array_c2i)
       call set_field_label_to_ctl(div_Coriolis_force,        array_c2i)
       call set_field_label_to_ctl(div_Lorentz_force,         array_c2i)
-      call set_field_label_to_ctl(div_buoyancy,              array_c2i)
+      call set_field_label_to_ctl(div_thermal_buoyancy,      array_c2i)
       call set_field_label_to_ctl(div_composite_buoyancy,    array_c2i)
+      call set_field_label_to_ctl(div_buoyancy,              array_c2i)
       call set_field_label_to_ctl(div_momentum_flux,         array_c2i)
       call set_field_label_to_ctl(div_maxwell_tensor,        array_c2i)
       call set_field_label_to_ctl(div_induction_tensor,      array_c2i)

src/Fortran_libraries/SERIAL_src/Fields/m_div_force_labels.f90

@@ -283,10 +283,12 @@ subroutine set_div_force_addresses                                &
         else if(field_name .eq. div_Lorentz_force%name) then
           div_forces%i_lorentz =    i_phys
 !
-        else if(field_name .eq. div_buoyancy%name) then
+        else if(field_name .eq. div_thermal_buoyancy%name) then
           div_forces%i_thrm_buo =   i_phys
         else if(field_name .eq. div_composite_buoyancy%name) then
           div_forces%i_comp_buo =   i_phys
+        else if(field_name .eq. div_buoyancy%name) then
+          div_forces%i_buoyancy =   i_phys
 !
         else if(field_name .eq. div_heat_flux%name) then
           div_forces%i_h_flux =    i_phys

src/Fortran_libraries/SERIAL_src/Fields/t_base_force_labels.f90

@@ -349,6 +349,7 @@
    "cell_type": "markdown",
    "id": "7b9e2659-51a3-4f34-a123-3b89605c194d",
    "metadata": {
+    "jp-MarkdownHeadingCollapsed": true,
     "tags": []
    },
    "source": [
@@ -397,7 +398,7 @@
     "|`[Label]` | Field name | `     `Math expression`     ` |\n",
     "|:-|:-|:-|\n",
     "|`viscous_diffusion` | Viscous diffusion | $-\\nu \\nabla \\times \\nabla \\times {\\bf u}$ |\n",
-    "|`inertia` | Inertia term |  $ -{\\bf \\omega} \\times {\\bf u} $ |\n",
+    "|`inertia` | Inertia term |  $ {\\bf \\omega} \\times {\\bf u} $ |\n",
     "|`thermal_buoyancy` | Thermal buoyancy |  $ -\\alpha_{T} T {\\bf g}  $ |\n",
     "|`composite_buoyancy` | Compositional buoyancy |  $ -\\alpha_{C} C{\\bf g}  $|\n",
     "|`buoyancy` | Total buoyancy |  $ -\\left( \\alpha_{T} T + \\alpha_{C} C \\right){\\bf g}  $ |\n",
@@ -426,7 +427,7 @@
     "tags": []
    },
    "source": [
-    "##### List of products of fields and differenciation of forces"
+    "##### List of differenciation of forces"
    ]
   },
   {
@@ -436,12 +437,37 @@
    "source": [
     "|`[Label]` | Field name | `     `Math expression`     ` |\n",
     "|:-|:-|:-|\n",
-    "|`rot_inertia` | Curl of inertia |  $- \\nabla \\times \\left({\\bf \\omega} \\times {\\bf u}\\right) $|\n",
+    "|`rot_inertia` | Curl of inertia |  $ \\nabla \\times \\left({\\bf \\omega} \\times {\\bf u}\\right) $|\n",
     "|`rot_Lorentz_force` | Curl of Lorentz force |  $ \\nabla \\times \\left({\\bf J} \\times {\\bf B}\\right) $|\n",
     "|`rot_Coriolis_force` | Curl of Coriolis force |  $ -2 \\Omega \\nabla \\times \\left(\\hat{z} \\times {\\bf u} \\right) $|\n",
     "|`rot_thermal_buoyancy` | Curl of thermal buoyancy |  $ - \\nabla \\times \\left(\\alpha_{T} T {\\bf g}\\right)  $|\n",
     "|`rot_composite_buoyancy` | Curl of compositional buoyancy |  $ - \\nabla \\times \\left(\\alpha_{C} C{\\bf g}\\right)  $|\n",
     "|`rot_buoyancy` | Curl of total buoyancy |  $ - \\nabla \\times \\left[\\left(\\alpha_{T} T + \\alpha_{C} C \\right){\\bf g}\\right]  $|\n",
+    "|`div_inertia` | Divergence of inertia |  $ \\nabla \\cdot \\left({\\bf \\omega} \\times {\\bf u}\\right) $|\n",
+    "|`div_Lorentz_force` | Divergence of Lorentz force |  $ \\nabla \\cdot \\left({\\bf J} \\times {\\bf B}\\right) $|\n",
+    "|`div_Coriolis_force` | Divergence of Coriolis force |  $ -2 \\Omega \\nabla \\cdot \\left(\\hat{z} \\times {\\bf u} \\right) $|\n",
+    "|`div_thermal_buoyancy` | Divergence of thermal buoyancy |  $ - \\nabla \\cdot \\left(\\alpha_{T} T {\\bf g}\\right)  $|\n",
+    "|`div_composite_buoyancy` | Divergence of compositional buoyancy |  $ - \\nabla \\cdot \\left(\\alpha_{C} C{\\bf g}\\right)  $|\n",
+    "|`div_buoyancy` | Divergence of total buoyancy |  $ - \\nabla \\cdot \\left[\\left(\\alpha_{T} T + \\alpha_{C} C \\right){\\bf g}\\right]  $|\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b5c583c0-c2c8-46c8-b95c-f286414cc552",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "##### List of products of fields"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e24a4b5b-0709-42b5-b275-51ba09b1f5e3",
+   "metadata": {},
+   "source": [
+    "|`[Label]` | Field name | `     `Math expression`     ` |\n",
+    "|:-|:-|:-|\n",
     "|`Lorentz_work` | Work of Lorentz force | ${\\bf u}\\cdot \\left( {\\bf J} \\times {\\bf B} \\right) $| \n",
     "|`work_against_Lorentz` | Work against Lorentz force | $- {\\bf u}\\cdot \\left( {\\bf J} \\times {\\bf B} \\right) $| \n",
     "|`buoyancy_flux` | Thermal buoyancy flux | $ -\\alpha_{T} T {\\bf g} \\cdot {\\bf u} $|\n",
@@ -456,11 +482,8 @@
   },
   {
    "cell_type": "markdown",
-   "id": "b5c583c0-c2c8-46c8-b95c-f286414cc552",
-   "metadata": {
-    "jp-MarkdownHeadingCollapsed": true,
-    "tags": []
-   },
+   "id": "1870a03b-95f3-430a-8e7b-26e33809ccda",
+   "metadata": {},
    "source": [
     "##### List of fields with equatorial symmetry"
    ]

src/Jupyter/.ipynb_checkpoints/Calypso_control_glossary-checkpoint.ipynb

@@ -349,6 +349,7 @@
    "cell_type": "markdown",
    "id": "7b9e2659-51a3-4f34-a123-3b89605c194d",
    "metadata": {
+    "jp-MarkdownHeadingCollapsed": true,
     "tags": []
    },
    "source": [
@@ -397,7 +398,7 @@
     "|`[Label]` | Field name | `     `Math expression`     ` |\n",
     "|:-|:-|:-|\n",
     "|`viscous_diffusion` | Viscous diffusion | $-\\nu \\nabla \\times \\nabla \\times {\\bf u}$ |\n",
-    "|`inertia` | Inertia term |  $ -{\\bf \\omega} \\times {\\bf u} $ |\n",
+    "|`inertia` | Inertia term |  $ {\\bf \\omega} \\times {\\bf u} $ |\n",
     "|`thermal_buoyancy` | Thermal buoyancy |  $ -\\alpha_{T} T {\\bf g}  $ |\n",
     "|`composite_buoyancy` | Compositional buoyancy |  $ -\\alpha_{C} C{\\bf g}  $|\n",
     "|`buoyancy` | Total buoyancy |  $ -\\left( \\alpha_{T} T + \\alpha_{C} C \\right){\\bf g}  $ |\n",
@@ -426,7 +427,7 @@
     "tags": []
    },
    "source": [
-    "##### List of products of fields and differenciation of forces"
+    "##### List of differenciation of forces"
    ]
   },
   {
@@ -436,12 +437,37 @@
    "source": [
     "|`[Label]` | Field name | `     `Math expression`     ` |\n",
     "|:-|:-|:-|\n",
-    "|`rot_inertia` | Curl of inertia |  $- \\nabla \\times \\left({\\bf \\omega} \\times {\\bf u}\\right) $|\n",
+    "|`rot_inertia` | Curl of inertia |  $ \\nabla \\times \\left({\\bf \\omega} \\times {\\bf u}\\right) $|\n",
     "|`rot_Lorentz_force` | Curl of Lorentz force |  $ \\nabla \\times \\left({\\bf J} \\times {\\bf B}\\right) $|\n",
     "|`rot_Coriolis_force` | Curl of Coriolis force |  $ -2 \\Omega \\nabla \\times \\left(\\hat{z} \\times {\\bf u} \\right) $|\n",
     "|`rot_thermal_buoyancy` | Curl of thermal buoyancy |  $ - \\nabla \\times \\left(\\alpha_{T} T {\\bf g}\\right)  $|\n",
     "|`rot_composite_buoyancy` | Curl of compositional buoyancy |  $ - \\nabla \\times \\left(\\alpha_{C} C{\\bf g}\\right)  $|\n",
     "|`rot_buoyancy` | Curl of total buoyancy |  $ - \\nabla \\times \\left[\\left(\\alpha_{T} T + \\alpha_{C} C \\right){\\bf g}\\right]  $|\n",
+    "|`div_inertia` | Divergence of inertia |  $ \\nabla \\cdot \\left({\\bf \\omega} \\times {\\bf u}\\right) $|\n",
+    "|`div_Lorentz_force` | Divergence of Lorentz force |  $ \\nabla \\cdot \\left({\\bf J} \\times {\\bf B}\\right) $|\n",
+    "|`div_Coriolis_force` | Divergence of Coriolis force |  $ -2 \\Omega \\nabla \\cdot \\left(\\hat{z} \\times {\\bf u} \\right) $|\n",
+    "|`div_thermal_buoyancy` | Divergence of thermal buoyancy |  $ - \\nabla \\cdot \\left(\\alpha_{T} T {\\bf g}\\right)  $|\n",
+    "|`div_composite_buoyancy` | Divergence of compositional buoyancy |  $ - \\nabla \\cdot \\left(\\alpha_{C} C{\\bf g}\\right)  $|\n",
+    "|`div_buoyancy` | Divergence of total buoyancy |  $ - \\nabla \\cdot \\left[\\left(\\alpha_{T} T + \\alpha_{C} C \\right){\\bf g}\\right]  $|\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b5c583c0-c2c8-46c8-b95c-f286414cc552",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "##### List of products of fields"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e24a4b5b-0709-42b5-b275-51ba09b1f5e3",
+   "metadata": {},
+   "source": [
+    "|`[Label]` | Field name | `     `Math expression`     ` |\n",
+    "|:-|:-|:-|\n",
     "|`Lorentz_work` | Work of Lorentz force | ${\\bf u}\\cdot \\left( {\\bf J} \\times {\\bf B} \\right) $| \n",
     "|`work_against_Lorentz` | Work against Lorentz force | $- {\\bf u}\\cdot \\left( {\\bf J} \\times {\\bf B} \\right) $| \n",
     "|`buoyancy_flux` | Thermal buoyancy flux | $ -\\alpha_{T} T {\\bf g} \\cdot {\\bf u} $|\n",
@@ -456,11 +482,8 @@
   },
   {
    "cell_type": "markdown",
-   "id": "b5c583c0-c2c8-46c8-b95c-f286414cc552",
-   "metadata": {
-    "jp-MarkdownHeadingCollapsed": true,
-    "tags": []
-   },
+   "id": "1870a03b-95f3-430a-8e7b-26e33809ccda",
+   "metadata": {},
    "source": [
     "##### List of fields with equatorial symmetry"
    ]