pgbinary docs (#525)

Matthias Fabry · evbauer · web-flow · commit 0d733903232d · 2023-04-28T09:17:42.000-04:00
pgbinary docs

---------

Co-authored-by: evbauer &lt;18405113+evbauer@users.noreply.github.com&gt;
diff --git a/binary/defaults/pgbinary.defaults b/binary/defaults/pgbinary.defaults
diff --git a/binary/private/pgbinary_ctrls_io.f90 b/binary/private/pgbinary_ctrls_io.f90
@@ -1331,7 +1331,7 @@ module pgbinary_ctrls_io
       Orbit_ytop, &
       Orbit_file_width, &
       Orbit_file_aspect_ratio, &
-      Orbit_txt_scale, &
+      Orbit_txt_scale_factor, &
       Orbit_show_RL, &
 
       annotation1_ci, &
@@ -2805,7 +2805,7 @@ subroutine store_pgbinary_controls(b, ierr)
       pg% Orbit_ytop = Orbit_ytop
       pg% Orbit_file_width = Orbit_file_width
       pg% Orbit_file_aspect_ratio = Orbit_file_aspect_ratio
-      pg% Orbit_txt_scale = Orbit_txt_scale
+      pg% Orbit_txt_scale_factor = Orbit_txt_scale_factor
       pg% Orbit_show_RL = Orbit_show_RL
 
       pg% annotation1_ci = annotation1_ci
diff --git a/binary/private/pgbinary_grid.f90 b/binary/private/pgbinary_grid.f90
@@ -534,7 +534,7 @@ subroutine Grid_plot(b, id, device_id, &
          case ('orbit')
             call do_orbit_plot(&
                b, id, device_id, xleft, xright, ybot, ytop, grid_subplot, b% pg% Orbit_title, &
-               Grid_txt_scale_factor(i) * b% pg% Orbit_txt_scale, ierr)
+               Grid_txt_scale_factor(i) * b% pg% Orbit_txt_scale_factor, ierr)
          case default
             ! check for "other" plot
             found_it = .false.
@@ -557,9 +557,9 @@ subroutine Grid_plot(b, id, device_id, &
                write(*, '(a)') &
                   'here are the valid names:', &
                   'Summary_History', &
-                  'Text_Summary1,..,9', &
-                  'History_Panels1,..,9', &
-                  'History_Tracks1,..,9', &
+                  'Text_Summary1..9', &
+                  'History_Panels1..9', &
+                  'History_Tracks1..9', &
                   'Star1,2'
                write(*, *)
 
diff --git a/binary/private/pgbinary_orbit.f90 b/binary/private/pgbinary_orbit.f90
@@ -47,7 +47,7 @@ subroutine Orbit_plot(id, device_id, ierr)
       call do_Orbit_plot(b, id, device_id, &
          b% pg% Orbit_xleft, b% pg% Orbit_xright, &
          b% pg% Orbit_ybot, b% pg% Orbit_ytop, .false., &
-         b% pg% Orbit_title, b% pg% Orbit_txt_scale, ierr)
+         b% pg% Orbit_title, b% pg% Orbit_txt_scale_factor, ierr)
       if (ierr /= 0) return
       call pgebuf()
    end subroutine Orbit_plot
diff --git a/binary/private/pgbinary_star.f90 b/binary/private/pgbinary_star.f90
@@ -203,7 +203,7 @@ subroutine do_star_plot(b, id, device_id, xleft, xright, &
             call plot_case(b% s1, b% star_ids(1))
             call update_pgstar_history_file(b% s1, ierr)
          else
-            write(mass, '(f12.3)') b% m(1) / Msun
+            write(mass, '(f3.2)') b% m(1) / Msun
             call pgmtxt('T', -2.0, 0.5, 0.5, 'Star 1 not simulated')
             call pgmtxt('T', -3.0, 0.5, 0.5, 'point mass of ' // trim(adjustl(mass)) // ' M\d\(2281)')
          end if
diff --git a/binary/public/pgbinary_controls.inc b/binary/public/pgbinary_controls.inc
@@ -932,7 +932,7 @@ real :: Orbit_win_width, Orbit_win_aspect_ratio, &
       Orbit_ybot, Orbit_ytop, &
       prev_Orbit_win_width, prev_Orbit_win_ratio, &
       Orbit_file_width, Orbit_file_aspect_ratio, &
-      prev_Orbit_file_width, prev_Orbit_file_ratio, Orbit_txt_scale
+      prev_Orbit_file_width, prev_Orbit_file_ratio, Orbit_txt_scale_factor
 
 integer :: annotation1_ci, annotation1_lw, annotation1_cf
 real :: annotation1_ch
diff --git a/binary/test_suite/evolve_both_stars/inlist_pgbinary b/binary/test_suite/evolve_both_stars/inlist_pgbinary
@@ -9,9 +9,14 @@ pgbinary_model_fjust = 1.4
 pgbinary_grid_title_disp = 0.2
 pgbinary_title_disp = 0.2
 
+
+Orbit_win_flag = .true.
+Orbit_win_width = 8
+
+
 Grid1_win_flag = .true.
 
-Grid1_win_width = 19.5
+Grid1_win_width = 19
 Grid1_win_aspect_ratio = 0.58
 
 Grid1_xleft = 0.0
diff --git a/docs/source/_ext/defaults2rst.py b/docs/source/_ext/defaults2rst.py
@@ -11,6 +11,7 @@
     'kap/defaults',
     'reference/binary_job',
     'reference/binary_controls',
+    'reference/pgbinary',
     'reference/star_job',
     'reference/controls',
     'reference/pgstar',
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -33,6 +33,35 @@ A new other_close_gaps hook has been added. Provided by Simon Guichandut
 Backwards-incompatible changes
 ------------------------------
 
+Module enhancement: ``pgbinary``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When running ``./binary`` models it is useful to have graphical
+output to 'see' what's going on.
+Previously, this was only possible on the ``pgstar`` level, meaning you would
+need to setup two ``pgstar`` windows if you are evolving two stars in the
+binary.
+
+Here we introduce ``pgbinary``, which acts much like ``pgstar``. You enable it
+with the ``&binary_job`` inlist with ``pgbinary_flag = .true.``. Then you
+select windows and/or files to be plotted in the ``&pgbinary`` inlist.
+Currently the following plot types can be created:
+
+* History_Track[1-9],
+* Summary_History,
+* History_Panels[1-9],
+* Text_Summary[1-9],
+* Grid[1-9],
+
+analogous to their ``pgstar`` equivalents, and two ``pgbinary``-only plots:
+
+* Star[1-2], to plot a star window through ``&pgstar`` controls, within ``pgbinary``.
+* Orbit, a visual representation of the stars' sizes to their separation
+
+Main use case is to have a single window containing both stars' ``pgstar`` info,
+through using ``Grid`` at the ``pgbinary`` level, populating it with ``Star1``
+and ``Star2``, and have each plot profile info, Kipp diagrams etc...
+
 Renamed controls for upper limits
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/docs/source/doc_archive/defaults2rst.sh b/docs/source/doc_archive/defaults2rst.sh
@@ -17,6 +17,8 @@ defaults2rst ../kap/defaults/kap.defaults source/kap/defaults.rst
 # binary
 defaults2rst ../binary/defaults/binary_job.defaults source/reference/binary_job.rst
 defaults2rst ../binary/defaults/binary_controls.defaults source/reference/binary_controls.rst
+defaults2rst ../binary/defaults/pgbinary.defaults source/reference/pgbinary.rst
+
 
 # star
 defaults2rst ../star/defaults/star_job.defaults source/reference/star_job.rst
diff --git a/docs/source/doc_archive/defaultsParser.rb b/docs/source/doc_archive/defaultsParser.rb
@@ -6,7 +6,7 @@ class DefaultsParser < Parslet::Parser
   # the format being parsed is described in 
   # $MESA_DIR/star/defaults/FORMAT
 
-  # simple rules that we'll reuse throught
+  # simple rules that we'll reuse throughout
 
   rule(:equals)     { space? >> str('=') >> space? }
 
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -24,6 +24,7 @@ Binary defaults
 
    reference/binary_job
    reference/binary_controls
+   reference/pgbinary
 
 Astero defaults
 ===============
diff --git a/docs/source/reference/pgbinary.rst b/docs/source/reference/pgbinary.rst
@@ -0,0 +1 @@
+../../../binary/defaults/pgbinary.defaults
diff --git a/star/defaults/pgstar.defaults b/star/defaults/pgstar.defaults
@@ -6252,8 +6252,8 @@
 ! ============
 
 
-      ! Text_Summary 1
-      ! --------------
+      ! Text_Summary1
+      ! -------------
 
       ! ::
 
@@ -7691,41 +7691,40 @@
     Grid9_file_width = -1
     Grid9_file_aspect_ratio = -1
 
-      ! "annotation" strings -- provide args for PGMTXT
+! Annotation
+! ==========
 
-      ! ::
+      ! "annotation" strings -- provide args for PGMTXT
 
-      !          Write text at a position specified relative to the viewport (outside
-      !          or inside).  The text is written using the current values of
-      !          attributes color-index, line-width, character-height, and
-      !          character-font.
-
-      ! ::
-
-      !           SIDE            : must include one of the characters 'B', 'L', 'T',
-      !                             or 'R' signifying the Bottom, Left, Top, or Right
-      !                             margin of the viewport. If it includes 'LV' or
-      !                             'RV', the string is written perpendicular to the
-      !                             frame rather than parallel to it.
-      !           DISP            : the displacement of the character string from the
-      !                             specified edge of the viewport, measured outwards
-      !                             from the viewport in units of the character
-      !                             height. Use a negative value to write inside the
-      !                             viewport, a positive value to write outside.
-      !           COORD           : the location of the character string along the
-      !                             specified edge of the viewport, as a fraction of
-      !                             the length of the edge.
-      !           FJUST           : controls justification of the string parallel to
-      !                             the specified edge of the viewport. If
-      !                             FJUST = 0.0, the left-hand end of the string will
-      !                             be placed at COORD; if JUST = 0.5, the center of
-      !                             the string will be placed at COORD; if JUST = 1.0,
-      !                             the right-hand end of the string will be placed at
-      !                             at COORD. Other values between 0 and 1 give inter-
-      !                             mediate placing, but they are not very useful.
-      !           TEXT           :  the text string to be plotted. Trailing spaces are
-      !                             ignored when justifying the string, but leading
-      !                             spaces are significant.
+      ! Write text at a position specified relative to the viewport (outside
+      ! or inside).  The text is written using the current values of
+      ! attributes color-index, line-width, character-height, and
+      ! character-font.
+
+      ! + SIDE :
+      !   must include one of the characters 'B', 'L', 'T',
+      !   or 'R' signifying the Bottom, Left, Top, or Right
+      !   margin of the viewport. If it includes 'LV' or
+      !   'RV', the string is written perpendicular to the
+      !   frame rather than parallel to it.
+      ! + DISP :
+      !   the displacement of the character string from the
+      !   specified edge of the viewport, measured outwards
+      !   from the viewport in units of the character
+      !   height. Use a negative value to write inside the
+      !   viewport, a positive value to write outside.
+      ! + COORD :
+      !   the location of the character string along the
+      !   specified edge of the viewport, as a fraction of
+      !   the length of the edge.
+      ! + FJUST :
+      !   controls justification of the string parallel to
+      !   the specified edge of the viewport. If
+      !   FJUST = 0.0, the left-hand end of the string will
+      !   be placed at COORD; if JUST = 0.5, the center of
+      !   the string will be placed at COORD; if JUST = 1.0,
+      !   the right-hand end of the string will be placed at
+      !   at COORD.
 
       ! ::
 
