Add ability to set user controls in eos/kap inlists (#513)

Fixes #282

Author: rjfarmer

eos/defaults/eos.defaults

@@ -315,6 +315,18 @@
    use_other_eos_results = .false.
 
 
+! User controls
+! -------------
+! :: 
+
+
+    ! These are arrays of size(10) that can be used to pass in custom information to the eos
+    eos_ctrl(:) = 0d0
+    eos_integer_ctrl(:) = 0
+    eos_logical_ctrl(:) = .false.
+    eos_character_ctrl(:) = ''
+
+
 ! Debugging controls
 ! ------------------
 ! ::

eos/private/eos_ctrls_io.f90

@@ -137,6 +137,12 @@ module eos_ctrls_io
    logical, dimension(max_extra_inlists) :: read_extra_eos_inlist
    character (len=strlen), dimension(max_extra_inlists) :: extra_eos_inlist_name
 
+   ! User supplied inputs
+   real(dp) :: eos_ctrl(10)
+   integer :: eos_integer_ctrl(10)
+   logical :: eos_logical_ctrl(10)
+   character(len=strlen) :: eos_character_ctrl(10)
+
 
    namelist /eos/ &
       use_FreeEOS, &
@@ -252,7 +258,13 @@ module eos_ctrls_io
       X_lo, X_hi, &
       Z_lo, Z_hi, &
 
-      read_extra_eos_inlist, extra_eos_inlist_name
+      read_extra_eos_inlist, extra_eos_inlist_name,&
+
+   ! User supplied inputs
+      eos_ctrl, &
+      eos_integer_ctrl, &
+      eos_logical_ctrl, &
+      eos_character_ctrl
 
 
    contains
@@ -459,6 +471,12 @@ subroutine store_controls(rq)
       rq% use_other_eos_component = use_other_eos_component
       rq% use_other_eos_results = use_other_eos_results
 
+      ! user inputs
+      rq% eos_ctrl = eos_ctrl
+      rq% eos_integer_ctrl = eos_integer_ctrl
+      rq% eos_logical_ctrl = eos_logical_ctrl
+      rq% eos_character_ctrl = eos_character_ctrl
+
       ! debugging
       rq% dbg = dbg
       rq% logT_lo = logT_lo
@@ -596,6 +614,12 @@ subroutine set_controls_for_writing(rq)
       use_other_eos_component = rq% use_other_eos_component
       use_other_eos_results = rq% use_other_eos_results
 
+      ! user inputs
+      eos_ctrl = rq% eos_ctrl
+      eos_integer_ctrl = rq% eos_integer_ctrl
+      eos_logical_ctrl = rq% eos_logical_ctrl
+      eos_character_ctrl = rq% eos_character_ctrl
+
       ! debugging
       dbg = rq% dbg
       logT_lo = rq% logT_lo

eos/public/eos_def.f90

@@ -26,7 +26,7 @@
 
       module eos_def
 
-      use const_def, only: dp, use_mesa_temp_cache
+      use const_def, only: dp, use_mesa_temp_cache, strlen
       use chem_def, only: max_el_z
 
       implicit none
@@ -333,6 +333,13 @@ end subroutine other_eos_interface
          integer :: handle
          logical :: in_use
 
+
+         ! User supplied inputs
+         real(dp) :: eos_ctrl(10)
+         integer :: eos_integer_ctrl(10)
+         logical :: eos_logical_ctrl(10)
+         character(len=strlen) :: eos_character_ctrl(10)
+
       end type EoS_General_Info
 
 

kap/defaults/kap.defaults

@@ -446,6 +446,19 @@
 
       use_other_radiative_opacity = .false.
 
+
+! User controls
+! -------------
+! :: 
+
+
+    ! These are arrays of size(10) that can be used to pass in custom information to kap
+    kap_ctrl(:) = 0d0
+    kap_integer_ctrl(:) = 0
+    kap_logical_ctrl(:) = .false.
+    kap_character_ctrl(:) = ''
+
+
 ! Extra inlist controls
 ! ---------------------
 

kap/private/kap_ctrls_io.f90

@@ -88,7 +88,12 @@ module kap_ctrls_io
 
    logical, dimension(max_extra_inlists) :: read_extra_kap_inlist
    character (len=strlen), dimension(max_extra_inlists) :: extra_kap_inlist_name
-
+   
+   ! User supplied inputs
+   real(dp) :: kap_ctrl(10)
+   integer :: kap_integer_ctrl(10)
+   logical :: kap_logical_ctrl(10)
+   character(len=strlen) :: kap_character_ctrl(10)
 
    namelist /kap/ &
 
@@ -122,6 +127,12 @@ module kap_ctrls_io
       use_other_compton_opacity, &
       use_other_radiative_opacity, &
 
+   ! User supplied inputs
+      kap_ctrl, &
+      kap_integer_ctrl, &
+      kap_logical_ctrl, &
+      kap_character_ctrl,&
+
       read_extra_kap_inlist, extra_kap_inlist_name
 
    contains
@@ -380,6 +391,12 @@ subroutine store_controls(rq, ierr)
       rq% use_other_compton_opacity = use_other_compton_opacity
       rq% use_other_radiative_opacity = use_other_radiative_opacity
 
+      ! user inputs
+      rq% kap_ctrl = kap_ctrl
+      rq% kap_integer_ctrl = kap_integer_ctrl
+      rq% kap_logical_ctrl = kap_logical_ctrl
+      rq% kap_character_ctrl = kap_character_ctrl
+
    end subroutine store_controls
 
 
@@ -434,6 +451,12 @@ subroutine set_controls_for_writing(rq)
       use_other_compton_opacity = rq% use_other_compton_opacity
       use_other_radiative_opacity = rq% use_other_radiative_opacity
 
+      ! user inputs
+      kap_ctrl = rq% kap_ctrl
+      kap_integer_ctrl = rq% kap_integer_ctrl
+      kap_logical_ctrl = rq% kap_logical_ctrl
+      kap_character_ctrl = rq% kap_character_ctrl
+
 
    end subroutine set_controls_for_writing
 

kap/public/kap_def.f90

@@ -24,7 +24,7 @@
 ! ***********************************************************************
 
 module kap_def
-  use const_def, only: dp
+  use const_def, only: dp, strlen
 
   implicit none
 
@@ -254,6 +254,12 @@ end subroutine other_radiative_opacity_interface
       integer :: handle
       logical :: in_use
 
+      ! User supplied inputs
+      real(dp) :: kap_ctrl(10)
+      integer :: kap_integer_ctrl(10)
+      logical :: kap_logical_ctrl(10)
+      character(len=strlen) :: kap_character_ctrl(10)
+
       ! other hooks
 
       logical :: use_other_elect_cond_opacity