Introduce doxygen notation for input / output parameters (435e0312) · Commits · Giacomo Mulas / NP_TMcode

src/include/clu_subs.h

+16 −29

Original line number	Diff line number	Diff line
		@@ -141,15 +141,16 @@ void crsm1(double vk, double exri, ParticleDescriptor *c1);
		* This function computes the transfer vector going from N2 to N1, using either
		* Hankel, Bessel or Bessel from origin functions.
		*
		* \param ihi: `int` Function mode. [IN]
		* \param ipamo: `int` [IN]
		* \param nbl: `int` Block identifier. [IN]
		* \param l1: `int` First L quantum number. [IN]
		* \param m1: `int` First M quantum number. [IN]
		* \param l2: `int` Second L quantum number. [IN]
		* \param m2: `int` Second M quantum number. [IN]
		* \param c1: `ParticleDescriptor *` Pointer to a ParticleDescriptor instance. [IN]
		* \param rac3j: `double[]` J connection vector. [IN/OUT]
		* \param[in] ihi: `int` Function mode.
		* \param[in] ipamo: `int`
		* \param[in] nbl: `int` Block identifier.
		* \param[in] l1: `int` First L quantum number.
		* \param[in] m1: `int` First M quantum number.
		* \param[in] l2: `int` Second L quantum number.
		* \param[in] m2: `int` Second M quantum number.
		* \param[in] c1: `ParticleDescriptor *` Pointer to a ParticleDescriptor instance.
		* \param[in,out] rac3j: `double[]` J connection vector.
		* \return result: `dcomplex` Matrix element.
		*/
		dcomplex ghit(
		int ihi, int ipamo, int nbl, int l1, int m1, int l2, int m2, ParticleDescriptor *c1,
		@@ -266,27 +267,13 @@ void r3j000(int j2, int j3, double *rac3j);
		* This function calculates the 3j(J,J2,J3;-M2-M3,M2,M3) symbol for the Clebsch-Gordan
		* coefficients. See Appendix a.3.1 in Borghese, Denti & Saija (2007).
		*
		* \param j2: `int` Value of J2. [IN]
		* \param j3: `int` Value of J3. [IN]
		* \param m2: `int` Value of M2. [IN]
		* \param m3: `int` Value of M3. [IN]
		* \param rac3j: `double *` Vector of 3j symbols. [OUT]
		* \param[in] j2: `int` Value of J2.
		* \param[in] j3: `int` Value of J3.
		* \param[in] m2: `int` Value of M2.
		* \param[in] m3: `int` Value of M3.
		* \param[out] rac3j: `double[]` Vector of 3j symbols.
		*/
		void r3jjr(int j2, int j3, int m2, int m3, double *rac3j);

		/**
		* \brief Compute the 3j symbol for Clebsch-Gordan coefficients for JJ transitions.
		*
		* This function calculates the 3j(J,J2,J3;-M2-M3,M2,M3) symbol for the Clebsch-Gordan
		* coefficients. See Appendix a.3.1 in Borghese, Denti & Saija (2007).
		*
		* \param j2: `int` Value of J2. [IN]
		* \param j3: `int` Value of J3. [IN]
		* \param m2: `int` Value of M2. [IN]
		* \param m3: `int` Value of M3. [IN]
		* \param rac3j: `double *` Vector of 3j symbols. [OUT]
		*/
		void r3jjr_d(int j2, int j3, int m2, int m3, double *rac3j);
		void r3jjr(int j2, int j3, int m2, int m3, double rac3j[]);

		/**
		* \brief Compute the 3j symbol for Clebsch-Gordan coefficients for JM transitions.