star-phor-input

commit 603d9bc5ff49bcdb0e0b819088d2a279be0e6f29
parent 9b3e3f96d582de39e6e838f32f43cca37618efb2
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date:   Tue, 13 Jan 2026 16:30:20 +0100

Remove deprecated 'ka' from star-phor-input

Ka, a simple double, has been deprecated since the introduction of
prop_rads in star-phor. This commit removes obsolete member variables
and functions related to 'ka'.

Diffstat:
M
doc/star-phor-input.scd
 | 
10
+---------
M
src/sphin.h
 | 
5
-----
M
src/sphin_volume.h
 | 
1
-
M
src/test_sphin_load_volume.c
 | 
16
+---------------

4 files changed, 2 insertions(+), 30 deletions(-)
diff --git a/doc/star-phor-input.scd b/doc/star-phor-input.scd
@@ -83,8 +83,7 @@ The file format describing a photoreactive system is as follows:
 
 <volume>                ::= 'volume:' <name>
                               [<volume-props> ...]
-<volume-props>          ::= <ka>
-                          | <geometry>
+<volume-props>          ::= <geometry>
                           | <sensor>
 			  | <prop-rad>
 
@@ -107,13 +106,6 @@ The file format describing a photoreactive system is as follows:
 <sensor>                ::= 'sensor:'
                               'response_function:' real
 
-<ka>                    ::= 'ka:' real <ka-unit> % ka > 0
-<ka-unit>               ::= 'cm^-1'
-                          | '1/cm'
-                          | 'mm^-1'
-                          | '1/mm'
-                          | 'm^-1'
-                          | '1/m'
 
 <prop-rad>		::= 'prop_rad:' <name> <prop-rad-type>
 				<concentration>
diff --git a/src/sphin.h b/src/sphin.h
@@ -322,11 +322,6 @@ sphin_volume_compute_total_size
     double* total_size);
 
 SPHIN_API res_T
-sphin_volume_get_ka
-  (struct sphin_volume* volume,
-   double* ka);
-
-SPHIN_API res_T
 sphin_volume_get_sensor
 (struct sphin_volume* volume,
  struct sphin_sensor_volume** sensor_volume); /* May be NULL <=> no sensor */
diff --git a/src/sphin_volume.h b/src/sphin_volume.h
@@ -38,7 +38,6 @@ struct txtrdr;
 
 struct sphin_volume {
   struct str name;
-  double ka; /* DEPRECATED */
   struct sphin_refractive_index* refractive_index;
   struct sphin_sensor_volume* sensor_volume;
   struct darray_sphin_prop_rad_ptr prop_rads;
diff --git a/src/test_sphin_load_volume.c b/src/test_sphin_load_volume.c
@@ -115,12 +115,11 @@ test_volume_api
   struct sphin_spectral_property* spec_prop = NULL;
   size_t nvolumes;
   size_t nprop_rad;
-  double ka, response_function;
+  double response_function;
   FILE* fp = NULL;
   CHK(fp = fopen(path, "w+"));
   fprintf(fp, "#Mot Clé   Nom\n");
   fprintf(fp, "volume: \"reaction volume\"\n");
-  fprintf(fp, "\tka: 2.11 m^-1\n");
   fprintf(fp, "\tprop_rad: \"name\" SCATTERER\n");
   fprintf(fp, "\t\tconcentration: 1.935 mol/m^3\n");
   fprintf(fp, "\t\tcross_sections:\n");
@@ -136,9 +135,7 @@ test_volume_api
   fprintf(fp, " # A line with a comment\n");
   fprintf(fp, " \n");
   fprintf(fp, "volume: \"my reaction volume\"\n");
-  fprintf(fp, "\tka: 1e-1 cm^-1\n");
   fprintf(fp, "volume: \"my last volume\"\n");
-  fprintf(fp, "\tka: 1.935 mm^-1\n");
   fclose(fp);
 
   CHK(sphin_load(sphin, path, &config) == RES_OK);
@@ -159,11 +156,6 @@ test_volume_api
   CHK(sphin_volume_get_name(NULL, &name) == RES_BAD_ARG);
   CHK(sphin_volume_get_name(volume, &name) == RES_OK);
   CHK(strcmp(name, "reaction volume") == 0);
-  CHK(sphin_volume_get_ka(NULL, NULL) == RES_BAD_ARG);
-  CHK(sphin_volume_get_ka(NULL, &ka) == RES_BAD_ARG);
-  CHK(sphin_volume_get_ka(volume, NULL) == RES_BAD_ARG);
-  CHK(sphin_volume_get_ka(volume, &ka) == RES_OK);
-  CHK(eq_eps(ka, 2.11, 1e-15));
   CHK(sphin_volume_get_prop_rad_count(NULL, NULL) == RES_BAD_ARG);
   CHK(sphin_volume_get_prop_rad_count(volume, NULL) == RES_BAD_ARG);
   CHK(sphin_volume_get_prop_rad_count(NULL, &nprop_rad) == RES_BAD_ARG);
@@ -203,16 +195,12 @@ test_volume_api
 
   /* Test volume 1 */
   CHK(sphin_config_get_volume(config, 1, &volume) == RES_OK);
-  CHK(sphin_volume_get_ka(volume, &ka) == RES_OK);
-  CHK(eq_eps(ka, 10, 1e-15));
   CHK(sphin_volume_get_sensor(volume, &sensor_volume) == RES_OK);
   CHK(sphin_volume_get_refractive_index(volume, &refr_ind) == RES_OK);
   CHK(refr_ind == NULL);
 
   /* Test volume 2 */
   CHK(sphin_config_get_volume(config, 2, &volume) == RES_OK);
-  CHK(sphin_volume_get_ka(volume, &ka) == RES_OK);
-  CHK(eq_eps(ka, 1935, 1e-15));
   CHK(sphin_config_get_volume(config, 1, &volume) == RES_OK);
 
   CHK(sphin_volume_ref_get(volume) == RES_OK);
@@ -232,7 +220,6 @@ test_volume_api_bad_geometry
   CHK(fp = fopen(path, "w+"));
   fprintf(fp, "#Mot Clé   Nom\n");
   fprintf(fp, " volume\t: \"reaction volume\"\n");
-  fprintf(fp, "\tka: 1 cm^-1\n");
   fprintf(fp, "\tgeometry: BACK test_2.stl\n");
   fprintf(fp, "\tsensor: \"my sensor\"\n");
   fprintf(fp, "\t\tresponse_function: 1\n");
@@ -252,7 +239,6 @@ test_volume_api_bad_sensor
   CHK(fp = fopen(path, "w+"));
   fprintf(fp, "#Mot Clé   Nom\n");
   fprintf(fp, " volume\t: \"reaction volume\"\n");
-  fprintf(fp, "\tka: 1 cm^-1\n");
   fprintf(fp, "\tgeometry: BACK test_2.stl\n");
   fprintf(fp, "\tsensor: \"blabla\"\n"); /* Sensor cannot have a name */
   fprintf(fp, "\t\tresponse_function: 1\n");