From cd28a78e83f399854ec618a3cb25fb25b07a9eb3 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Wed, 8 Nov 2023 16:45:37 +0100
Subject: [PATCH] Document all common block elements
---
src/include/Commons.h | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/src/include/Commons.h b/src/include/Commons.h
index eef2cdaa..5db51887 100644
--- a/src/include/Commons.h
+++ b/src/include/Commons.h
@@ -88,6 +88,8 @@ public:
*
* \param ns: `int` Number of spheres.
* \param l_max: `int` Maximum order of field expansion.
+ * \param nshl: `int *` Array of number of layers in spheres.
+ * \param iog: `int *` Vector of spherical units ID numbers.
*/
C1(int ns, int l_max, int *nshl, int *iog);
@@ -193,6 +195,18 @@ protected:
//! \brief QUESTION: definition?
int lmpo;
+ /*! \brief Allocate the necessary common vectors depending on configuration.
+ *
+ * The size of the vectors and matrices defined in various common
+ * blocks, and particularly in C1, depends on many settings of the
+ * problem configuration, such as the number of spheres, the number
+ * of layers the spheres are made of, the field expansion order and
+ * others. This function collects the calculations needed to infer
+ * the necessary amount of memory for these configurable elements,
+ * thus making the class constructor more compact and easier to handle.
+ *
+ * \param c4: `C4 *` Pointer to a C4 structure.
+ */
void allocate_vectors(C4 *c4);
public:
//! \brief QUESTION: definition?
@@ -234,15 +248,7 @@ public:
/*! \brief C1_AddOns instance constructor.
*
- * \param ns: `int` Number of spheres.
- * \param nc: `int`
- * \param litpo: `int`
- * \param lmtpo: `int`
- * \param nv3j: `int`
- * \param lmpo: `int`
- * \param li: `int`
- * \param le: `int`
- * \param lm: `int`
+ * \param c4: `C4 *` Pointer to a C4 structure.
*/
C1_AddOns(C4 *c4);
@@ -272,7 +278,9 @@ public:
*/
class C9 {
protected:
+ //! \brief Number of rows in the GIS and GLS matrices
int gis_size_0;
+ //! \brief Number of rows in the SAM matrix
int sam_size_0;
public:
//! \brief QUESTION: definition?
--
GitLab