stardis

commit ffee051832c19b3e74017735efb7999127a759ab
parent 115bad87c6620c836b7b1540ed4aabc7c91b466b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Sun, 14 Apr 2024 16:43:31 +0200

Update programmable properties header

Notify us that the stardis_reference_temperature function is mandatory
for a solid_fluid programmable connection. In fact, there was no
functional problem in forgetting this, since the function profile is
declared elsewhere in the same file. However, this declaration is
duplicated in each section listing the functions expected by a
programmable structure in order to document the functions that the user
must implement to provide such a valid programmable structure.

Diffstat:
M
src/stardis-prog-properties.h.in
 | 
11
+++++++++++

1 file changed, 11 insertions(+), 0 deletions(-)
diff --git a/src/stardis-prog-properties.h.in b/src/stardis-prog-properties.h.in
@@ -591,6 +591,17 @@ STARDIS_API double
 stardis_max_convection_coefficient
   (void* data);
 
+/* Returns the reference temperature at a given fragment.
+ * This temperature is used as a reference to linearize radiative transfer
+ * in Picard computations.
+ * This functions is called every time a path of the computation reaches
+ * this boundary.
+ * data is the pointer returned by stardis_create_data for this boundary. */
+STARDIS_API double
+stardis_reference_temperature
+  (const struct stardis_interface_fragment* frag,
+   void* data);
+
 /* Computes the expected temperature range for this connection.
  * This functions is called once when initializing the computation.
  * data is the pointer returned by stardis_create_data for this connection.