[ci skip] tweak some documentation to avoid ambiguity in what it means to 'subtract' neutrino losses

Author: warrickball

net/public/net_lib.f90

@@ -636,7 +636,7 @@ subroutine net_get( &
          real(dp), pointer, intent(in) :: reaction_Qs(:) ! (rates_reaction_id_max)
          real(dp), pointer, intent(in) :: reaction_neuQs(:) ! (rates_reaction_id_max)
 
-         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after subtract reaction neutrinos
+         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after including losses from reaction neutrinos
          real(dp), intent(out) :: d_eps_nuc_dT
          real(dp), intent(out) :: d_eps_nuc_dRho
          real(dp), intent(inout) :: d_eps_nuc_dx(:) ! (num_isos) 
@@ -895,7 +895,7 @@ subroutine net_get_symbolic_d_dxdt_dx( &
          real(dp), pointer, intent(in) :: reaction_Qs(:) ! (rates_reaction_id_max)
          real(dp), pointer, intent(in) :: reaction_neuQs(:) ! (rates_reaction_id_max)
 
-         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after subtract reaction neutrinos
+         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after including reaction neutrinos
          real(dp), intent(out) :: d_eps_nuc_dT
          real(dp), intent(out) :: d_eps_nuc_dRho
          real(dp), intent(inout) :: d_eps_nuc_dx(:) ! (num_isos) 
@@ -995,7 +995,7 @@ subroutine net_get_with_Qs( &
          real(dp), intent(in) :: weak_rate_factor
          real(dp), pointer, intent(in) :: reaction_Qs(:) ! (rates_reaction_id_max)
          real(dp), pointer, intent(in) :: reaction_neuQs(:) ! (rates_reaction_id_max)
-         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after subtract reaction neutrinos
+         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after including reaction neutrinos
          real(dp), intent(out) :: d_eps_nuc_dT
          real(dp), intent(out) :: d_eps_nuc_dRho
          real(dp), intent(inout) :: d_eps_nuc_dx(:) ! (num_isos) 

star/defaults/profile_columns.list

@@ -238,7 +238,7 @@
    !eps_nuc_minus_non_nuc_neu
    !eps_nuc_start
 
-   !eps_nuc ! ergs/g/sec from nuclear reactions (reaction neutrinos subtracted)
+   !eps_nuc ! ergs/g/sec from nuclear reactions (including losses to reaction neutrinos)
    !log_abs_eps_nuc
    !d_lnepsnuc_dlnd
    !d_epsnuc_dlnd

star/other/other_net_get.f90

@@ -70,7 +70,7 @@ subroutine null_other_net_get(  &
          real(dp), intent(in) :: weak_rate_factor
          real(dp), pointer, intent(in) :: reaction_Qs(:) ! (rates_reaction_id_max)
          real(dp), pointer, intent(in) :: reaction_neuQs(:) ! (rates_reaction_id_max)
-         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after subtract reaction neutrinos
+         real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after including losses to reaction neutrinos
          real(dp), intent(out) :: d_eps_nuc_dT
          real(dp), intent(out) :: d_eps_nuc_dRho
          real(dp), intent(inout) :: d_eps_nuc_dx(:) ! (num_isos)       

star/rsp2_utils/profile_columns.list

@@ -79,7 +79,7 @@
    ye ! average charge per baryon = proton fraction
    opacity ! opacity measured at center of zone
    log_opacity ! log10(opacity)
-   eps_nuc ! ergs/g/sec from nuclear reactions (neutrinos subtracted)
+   eps_nuc ! ergs/g/sec from nuclear reactions (including losses to reaction neutrinos)
    non_nuc_neu ! non-nuclear-reaction neutrino losses
    !nonnucneu_plas ! plasmon neutrinos (for collective reactions like gamma_plasmon => nu_e + nubar_e)
    !nonnucneu_brem ! bremsstrahlung (for reactions like e- + (z,a) => e- + (z,a) + nu + nubar)

star_data/public/star_data_def.inc

@@ -914,7 +914,7 @@
             real(dp), intent(in) :: weak_rate_factor
             real(dp), pointer, intent(in) :: reaction_Qs(:) ! (rates_reaction_id_max)
             real(dp), pointer, intent(in) :: reaction_neuQs(:) ! (rates_reaction_id_max)
-            real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning after subtract reaction neutrinos
+            real(dp), intent(out) :: eps_nuc ! ergs/g/s from burning including losses by reaction neutrinos
             real(dp), intent(out) :: d_eps_nuc_dT
             real(dp), intent(out) :: d_eps_nuc_dRho
             real(dp), intent(inout) :: d_eps_nuc_dx(:) ! (num_isos)       

star_data/public/star_data_step_work.inc

@@ -221,14 +221,14 @@
 
       real(dp), pointer :: eps_nuc(:) ! sum of reaction_eps_nuc for all reactions in net
          ! thermal ergs per gram per second from nuclear reactions
-         ! (nuclear reaction neutrinos have been subtracted)
+         ! (including losses to neutrinos produced in the reactions)
       real(dp), pointer :: eps_nuc_categories(:,:) ! (num_categories, nz)
       real(dp), pointer :: d_epsnuc_dlnd(:) ! partial wrt density
       real(dp), pointer :: d_epsnuc_dlnT(:) ! partial wrt temperature
       real(dp), pointer :: d_epsnuc_dx(:,:)  ! (species,nz)
          ! d_ex_dx(j, k) is partial of eps_nuc(k) wrt species(j)
 
-      real(dp), pointer :: eps_nuc_neu_total(:) ! erg/gm/sec as neutrinos from nuclear reactions
+      real(dp), pointer :: eps_nuc_neu_total(:) ! erg/gm/sec, (positive) energy lost to neutrinos in nuclear reactions
 
       real(dp), pointer :: dxdt_nuc(:,:) ! (species,nz)
          ! rate of change of mass fractions from nuclear reactions
@@ -253,7 +253,7 @@
       real(dp), pointer :: luminosity_by_category(:,:) ! (num_categories, nz)
 
       ! non-nuclear-reaction neutrino losses
-      real(dp), pointer :: non_nuc_neu(:)
+      real(dp), pointer :: non_nuc_neu(:) ! positive
       real(dp), pointer :: d_nonnucneu_dlnd(:)
       real(dp), pointer :: d_nonnucneu_dlnT(:)