commit e2bfe20c9081df1224560a7ede479955e45df4ed
parent 110112776ed3607d6025c863dc53b4e15a7b2607
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 17 Jan 2024 11:16:36 +0100
Correct or adjust 2 comments
The commentary on the API function sdis_scene_get_source didn't make it
clear whether it was the returned value or the submitted variable that
could be NULL. Next, a comment in the rwalk_context structure referred
to the compute_temperature function, which has been renamed in
sample_coupled_path.
Diffstat:
2 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/src/sdis.h b/src/sdis.h
@@ -1173,7 +1173,7 @@ sdis_scene_get_device
SDIS_API res_T
sdis_scene_get_source
(struct sdis_scene* scn,
- struct sdis_source** src); /* May be NULL <=> no source */
+ struct sdis_source** src); /* The returned pointer can be NULL <=> no source */
/*******************************************************************************
* An estimator stores the state of a simulation
diff --git a/src/sdis_Xd_begin.h b/src/sdis_Xd_begin.h
@@ -34,11 +34,10 @@ struct rwalk_context {
double That2; /* That^2 */
double That3; /* That^3 */
- /* Maximum branchings i.e. the maximum number of times
- * XD(compute_temperature) can be called. It controls the number of
- * ramifications of the heat path and currently is correlated to the Picard
- * order used to estimate the radiative temperature. max_branchings ==
- * picard_order-1 */
+ /* Maximum branchings i.e. the maximum number of times XD(sample_coupled_path)
+ * can be called. It controls the number of ramifications of the heat path and
+ * currently is correlated to the Picard order used to estimate the radiative
+ * temperature. max_branchings == picard_order-1 */
size_t max_branchings;
/* Number of heat path branchings */
