commit 762b74c43afb38fc32b82c826ea1a83aaa795468
parent b15a85413723595d38ca8b3c86c81fcc8b982e26
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Wed, 30 Mar 2022 15:46:09 +0200
Improve comments for programmable properties' API
Diffstat:
1 file changed, 46 insertions(+), 46 deletions(-)
diff --git a/src/stardis-prog-properties.h.in b/src/stardis-prog-properties.h.in
@@ -90,20 +90,20 @@ stardis_create_library_data
* A STARDIS_FAILURE result ends the program.
* This function is called after descriptions creation, before simulation
* starts.
- * Data is the pointer returned by stardis_create_library_data for this
+ * lib_data is the pointer returned by stardis_create_library_data for this
* library. */
enum stardis_return_status
stardis_finalize_library_data
- (void* data);
+ (void* lib_data);
/* Release the data created by stardis_create_library_data.
* This function is called after the simulation finished and after releasing
* descriptions data.
- * Data is the pointer returned by stardis_create_library_data for this
+ * lib_data is the pointer returned by stardis_create_library_data for this
* library. */
extern void
stardis_release_library_data
- (void* data);
+ (void* lib_data);
/******************************************************************************/
/* Mandatory functions for any programmed description regardless of its type. */
@@ -113,40 +113,40 @@ stardis_release_library_data
* A NULL result is interpreted as an error and ends the program.
* This function is called every time a description using this library is
* processed.
- * Data is the pointer returned by stardis_create_library_data for the library
- * or NULL if stardis_create_library_data is not defined.
- * Args is the end of the description line that was following the PROG_PARAM
+ * lib_data is the pointer returned by stardis_create_library_data for the
+ * library or NULL if stardis_create_library_data is not defined.
+ * args is the end of the description line that was following the PROG_PARAM
* keyword (if any). */
extern void*
stardis_create_data
(const struct stardis_description_create_context *ctx,
- void* data,
+ void* lib_data,
char* args);
/* Release the data created by stardis_create_data.
* This function is called after the simulation finished.
- * Data is the pointer returned by stardis_create_data for the description. */
+ * data is the pointer returned by stardis_create_data for the description. */
extern void
stardis_release_data
(void* data);
/* Get the copyright notice.
* A NULL result is interpreted as an error and ends the program.
- * Data is the pointer returned by stardis_create_data for the description. */
+ * data is the pointer returned by stardis_create_data for the description. */
const char*
get_copyright_notice
(void* data);
/* Get single-line (name and link?) version of the license.
* A NULL result is interpreted as an error and ends the program.
- * Data is the pointer returned by stardis_create_data for the description. */
+ * data is the pointer returned by stardis_create_data for the description. */
const char*
get_license_short
(void* data);
/* Get full license text.
* A NULL result is interpreted as an error and ends the program.
- * Data is the pointer returned by stardis_create_data for the description. */
+ * data is the pointer returned by stardis_create_data for the description. */
const char*
get_license_text
(void* data);
@@ -164,7 +164,7 @@ get_license_text
/* Returns the calorific capacity at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this solid.
- * Data is the pointer returned by stardis_create_data for this solid. */
+ * data is the pointer returned by stardis_create_data for this solid. */
extern double
stardis_calorific_capacity
(const struct stardis_vertex* vtx,
@@ -173,7 +173,7 @@ stardis_calorific_capacity
/* Returns the volumic mass at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this solid.
- * Data is the pointer returned by stardis_create_data for this solid. */
+ * data is the pointer returned by stardis_create_data for this solid. */
extern double
stardis_volumic_mass
(const struct stardis_vertex* vtx,
@@ -182,7 +182,7 @@ stardis_volumic_mass
/* Returns the conductivity at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this solid.
- * Data is the pointer returned by stardis_create_data for this solid. */
+ * data is the pointer returned by stardis_create_data for this solid. */
extern double
stardis_conductivity
(const struct stardis_vertex* vtx,
@@ -191,7 +191,7 @@ stardis_conductivity
/* Returns the delta numerical parameter at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this solid.
- * Data is the pointer returned by stardis_create_data for this solid. */
+ * data is the pointer returned by stardis_create_data for this solid. */
extern double
stardis_delta_solid
(const struct stardis_vertex* vtx,
@@ -200,7 +200,7 @@ stardis_delta_solid
/* Returns the volumic power at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this solid.
- * Data is the pointer returned by stardis_create_data for this solid. */
+ * data is the pointer returned by stardis_create_data for this solid. */
extern double
stardis_volumic_power
(const struct stardis_vertex* vtx,
@@ -210,7 +210,7 @@ stardis_volumic_power
* If the temperature is not known/imposed the expected return value is -1.
* This functions is called at every vertex of every path of the computation
* crossing this solid.
- * Data is the pointer returned by stardis_create_data for this solid. */
+ * data is the pointer returned by stardis_create_data for this solid. */
extern double
stardis_medium_temperature
(const struct stardis_vertex* vtx,
@@ -218,7 +218,7 @@ stardis_medium_temperature
/* Computes the expected temperature range for this solid.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this solid.
+ * data is the pointer returned by stardis_create_data for this solid.
* Returns its modified range argument. */
extern double*
stardis_t_range
@@ -232,7 +232,7 @@ stardis_t_range
/* Returns the calorific capacity at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this fluid.
- * Data is the pointer returned by stardis_create_data for this fluid. */
+ * data is the pointer returned by stardis_create_data for this fluid. */
extern double
stardis_calorific_capacity
(const struct stardis_vertex* vtx,
@@ -241,7 +241,7 @@ stardis_calorific_capacity
/* Returns the volumic mass at a given vertex.
* This functions is called at every vertex of every path of the computation
* crossing this fluid.
- * Data is the pointer returned by stardis_create_data for this fluid. */
+ * data is the pointer returned by stardis_create_data for this fluid. */
extern double
stardis_volumic_mass
(const struct stardis_vertex* vtx,
@@ -251,7 +251,7 @@ stardis_volumic_mass
* If the temperature is not known/imposed the expected return value is -1.
* This functions is called at every vertex of every path of the computation
* crossing this fluid.
- * Data is the pointer returned by stardis_create_data for this fluid. */
+ * data is the pointer returned by stardis_create_data for this fluid. */
extern double
stardis_medium_temperature
(const struct stardis_vertex* vtx,
@@ -259,7 +259,7 @@ stardis_medium_temperature
/* Computes the expected temperature range for this fluid.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this fluid.
+ * data is the pointer returned by stardis_create_data for this fluid.
* Returns its modified range argument. */
extern double*
stardis_t_range
@@ -273,7 +273,7 @@ stardis_t_range
/* Returns the boundary temperature at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_boundary_temperature
(const struct stardis_interface_fragment* frag,
@@ -282,7 +282,7 @@ stardis_boundary_temperature
/* Returns the emissivity at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_emissivity
(const struct stardis_interface_fragment* frag,
@@ -291,7 +291,7 @@ stardis_emissivity
/* Returns the specular fraction at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_specular_fraction
(const struct stardis_interface_fragment* frag,
@@ -300,7 +300,7 @@ stardis_specular_fraction
/* Returns the convection coefficient at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_convection_coefficient
(const struct stardis_interface_fragment* frag,
@@ -311,7 +311,7 @@ stardis_convection_coefficient
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_reference_temperature
(const struct stardis_interface_fragment* frag,
@@ -319,14 +319,14 @@ stardis_reference_temperature
/* Returns the upper bound of the convection coefficient accross this boundary.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this boundary. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_max_convection_coefficient
(void* data);
/* Computes the expected temperature range for this boundary.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this boundary.
+ * data is the pointer returned by stardis_create_data for this boundary.
* Returns its modified range argument. */
extern double*
stardis_t_range
@@ -340,7 +340,7 @@ stardis_t_range
/* Returns the emissivity at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_emissivity
(const struct stardis_interface_fragment* frag,
@@ -349,7 +349,7 @@ stardis_emissivity
/* Returns the specular fraction at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_specular_fraction
(const struct stardis_interface_fragment* frag,
@@ -358,7 +358,7 @@ stardis_specular_fraction
/* Returns the convection coefficient at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_convection_coefficient
(const struct stardis_interface_fragment* frag,
@@ -369,7 +369,7 @@ stardis_convection_coefficient
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_reference_temperature
(const struct stardis_interface_fragment* frag,
@@ -380,7 +380,7 @@ stardis_reference_temperature
* solid.
* This functions is called at every vertex of every path of the computation
* crossing this fluid.
- * Data is the pointer returned by stardis_create_data for this boundary. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_medium_temperature
(const struct stardis_vertex* vtx,
@@ -388,14 +388,14 @@ stardis_medium_temperature
/* Returns the upper bound of the convection coefficient accross this boundary.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this boundary. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_max_convection_coefficient
(void* data);
/* Computes the expected temperature range for this boundary.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this boundary.
+ * data is the pointer returned by stardis_create_data for this boundary.
* Returns its modified range argument. */
extern double*
stardis_t_range
@@ -409,7 +409,7 @@ stardis_t_range
/* Returns the boundary temperature at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_boundary_temperature
(const struct stardis_interface_fragment* frag,
@@ -417,7 +417,7 @@ stardis_boundary_temperature
/* Computes the expected temperature range for this boundary.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this boundary.
+ * data is the pointer returned by stardis_create_data for this boundary.
* Returns its modified range argument. */
extern double*
stardis_t_range
@@ -431,7 +431,7 @@ stardis_t_range
/* Returns the flux at the boundary at a given fragment.
* 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. */
+ * data is the pointer returned by stardis_create_data for this boundary. */
extern double
stardis_boundary_flux
(const struct stardis_interface_fragment* frag,
@@ -444,7 +444,7 @@ stardis_boundary_flux
/* Returns the thermal contact resistance at a given fragment.
* This functions is called every time a path of the computation reaches
* this connection.
- * Data is the pointer returned by stardis_create_data for this connection. */
+ * data is the pointer returned by stardis_create_data for this connection. */
extern double
stardis_thermal_contact_resistance
(const struct stardis_interface_fragment* frag,
@@ -457,7 +457,7 @@ stardis_thermal_contact_resistance
/* Returns the emissivity at a given fragment.
* This functions is called every time a path of the computation reaches
* this connection.
- * Data is the pointer returned by stardis_create_data for this connection. */
+ * data is the pointer returned by stardis_create_data for this connection. */
extern double
stardis_emissivity
(const struct stardis_interface_fragment* frag,
@@ -466,7 +466,7 @@ stardis_emissivity
/* Returns the specular fraction at a given fragment.
* This functions is called every time a path of the computation reaches
* this connection.
- * Data is the pointer returned by stardis_create_data for this connection. */
+ * data is the pointer returned by stardis_create_data for this connection. */
extern double
stardis_specular_fraction
(const struct stardis_interface_fragment* frag,
@@ -475,7 +475,7 @@ stardis_specular_fraction
/* Returns the convection coefficient at a given fragment.
* This functions is called every time a path of the computation reaches
* this connection.
- * Data is the pointer returned by stardis_create_data for this connection. */
+ * data is the pointer returned by stardis_create_data for this connection. */
extern double
stardis_convection_coefficient
(const struct stardis_interface_fragment* frag,
@@ -483,14 +483,14 @@ stardis_convection_coefficient
/* Returns the upper bound of the convection coefficient accross this connection.
* This functions is called once when initializing the computation.
- * Data is the pointer returned by stardis_create_data for this connection. */
+ * data is the pointer returned by stardis_create_data for this connection. */
extern double
stardis_max_convection_coefficient
(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.
+ * data is the pointer returned by stardis_create_data for this connection.
* Returns its modified range argument. */
extern double*
stardis_t_range
