Commit 5ff3b2f3 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Remove questions from header files inline documentation

parent 3695f63e

src/include/Commons.h

+1 −1
Original line number Diff line number Diff line
@@ -348,7 +348,7 @@ public: 
  double *ecscm;

  //! \brief J-vector components index matrix.

  int **ind3j;

  //! \brief J-vector boundary values. QUESTION: correct?

  //! \brief ANNOTATION: J-vector boundary conditions.

  double *rac3j;

  // >>> END OF SECTION NEEDED BY CLUSTER AND INCLU <<< //

src/include/Configuration.h

+8 −8
Original line number Diff line number Diff line
@@ -183,8 +183,8 @@ public: 
   * \param nsph: `int` Number of spheres to be used in calculation.

   * \param lm: `int` Maximum field angular momentum expansion order.

   * \param in_pol: `int` Incident field polarization status

   * \param npnt: `int` Number of transition points. QUESTION: correct?

   * \param npntts: `int` Transition smoothness. QUESTION: correct?

   * \param npnt: `int` ANNOTATION: Number of points for non transition layer integration.

   * \param npntts: `int` ANNOTATION: Number of points for transition layer integration.

   * \param meridional_type: `int` Type of meridional plane definition (<0

   * for incident angles, 0 if determined by incidence and observation, =1

   * accross z-axis for incidence and observation, >1 across z-axis as a
@@ -208,7 +208,7 @@ public: 
   * \param sc_ph_start: `double` Scattered field starting elevation angle.

   * \param sc_ph_step: `double` Scattered field elevation angle step.

   * \param sc_ph_end: `double` Scattered field final elevation angle.

   * \param jwtm: `int` Transition Matrix layer ID. QUESTION: correct?

   * \param jwtm: `int` Transition Matrix layer ID.

   */

  GeometryConfiguration(

			int nsph, int lm, int in_pol, int npnt, int npntts, int meridional_type,
@@ -324,11 +324,11 @@ protected: 
  int _number_of_scales;

  //! \brief Type of dielectric functions (<0 at XIP, =0 as function of XI, >0 constants).

  int _idfc;

  //! \brief External medium dielectric constant. QUESTION: correct?

  //! \brief External medium dielectric constant.

  double _exdc;

  //! \brief WP. QUESTION: better definition?

  //! \brief WP. Peak pulsation.

  double _wp;

  //! \brief Peak XI. QUESTION: correct?

  //! \brief Peak scale.

  double _xip;

  //! \brief Maximum number of layers for the particle components.

  int _max_layers;
@@ -414,10 +414,10 @@ public: 
   * \param scale_vector: `double*` The radiation-particle scale vector.

   * \param nxi: `int` The number of radiation-particle scalings.

   * \param variable_name: `string` The name of the radiation-particle scaling type.

   * \param iog_vector: `int*` Array of sphere identification numbers. QUESTION: correct?

   * \param iog_vector: `int*` Array of sphere identification numbers.

   * \param ros_vector: `double*` Sphere radius array.

   * \param nshl_vector: `int*` Array of layer numbers.

   * \param rcf_vector: `double**` Array of fractional break radii. QUESTION: correct?

   * \param rcf_vector: `double**` Array of fractional break radii.

   * \param dielectric_func_type: `int` Type of dielectric function definition (=0 for constant,

   * \>0 as function of scale parameter, <0 for functions at XIP value and XI is scale factor

   * for dimensions).

src/include/IterationData.h

+7 −7
Original line number Diff line number Diff line
@@ -63,7 +63,7 @@ public: 
  double **tqcs;

  //! \brief Components of scattering contribution to radiation torque on the cluster along k referred to polarization plane.

  dcomplex **tqcps;

  //! \brief Variation of unitary radiation vector. QUESTION: correct?

  //! \brief Variation of unitary radiation vector.

  double *duk;

  //! \brief Cluster extinction cross-section components referred to scattering plane.

  double **cextlr;
@@ -115,13 +115,13 @@ public: 
  dcomplex *am_vector;

  //! \brief Scattering coefficient matrix.

  dcomplex **am;

  //! \brief Argument of harmonic functions. QUESTION: correct?

  //! \brief ANNOTATION: Argument of harmonic functions.

  dcomplex arg;

  //! \brief Vacuum magnitude of wave vector.

  double vk;

  //! \brief Wave number.

  double wn;

  //! \brief Normalization scale. QUESTION: correct?

  //! \brief ANNOTATION: Normalization scale.

  double xip;

  //! \brief Number of scales (wavelengths) to be computed.

  int number_of_scales;
@@ -249,7 +249,7 @@ public: 
  double **tqcs;

  //! \brief Components of scattering contribution to radiation torque on the cluster along k referred to polarization plane.

  dcomplex **tqcps;

  //! \brief Variation of unitary radiation vector. QUESTION: correct?

  //! \brief Variation of unitary radiation vector.

  double *duk;

  //! \brief Cluster extinction cross-section components referred to scattering plane.

  double **cextlr;
@@ -301,13 +301,13 @@ public: 
  dcomplex *am_vector;

  //! \brief Scattering coefficient matrix.

  dcomplex **am;

  //! \brief Argument of harmonic functions. QUESTION: correct?

  //! \brief Argument of harmonic functions.

  dcomplex arg;

  //! \brief Vacuum magnitude of wave vector.

  double vk;

  //! \brief Wave number.

  double wn;

  //! \brief Normalization scale. QUESTION: correct?

  //! \brief ANNOTATION: Normalization scale.

  double xip;

  //! \brief Number of scales (wavelengths) to be computed.

  int number_of_scales;
@@ -432,7 +432,7 @@ public: 
  double vk;

  //! \brief Wave number.

  double wn;

  //! \brief Normalization scale. QUESTION: correct?

  //! \brief ANNOTATION: Normalization scale.

  double xip;

  //! \brief Number of scales (wavelengths) to be computed.

  int number_of_scales;

src/include/clu_subs.h

+5 −5
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ void apcra( 
 */

dcomplex cdtp(dcomplex z, dcomplex *vec_am, int i, int jf, int k, int nj, np_int istep);



/*! \brief C++ porting of CGEV. QUESTION: description?

/*! \brief C++ porting of CGEV. ANNOTATION: Get weight of T-matrix element.

 *

 * \param ipamo: `int`

 * \param mu: `int`
@@ -106,8 +106,8 @@ void cms(dcomplex **am, ParticleDescriptor *c1); 
/*! \brief Compute orientation-averaged scattered field intensity.

 *

 * This function computes the intensity of the scattered field for the cluster,

 * averaged on the orientations. It is invoked for IAVM=1 (geometry referred to

 * the meridional plane). QUESTION: correct?

 * averaged on the orientations. It is invoked for IAVM=1 (ANNOTATION: geometry

 * referred to the meridional plane).

 *

 * \param vk: `double` Wave number.

 * \param exri: `double` External medium refractive index.
@@ -355,9 +355,9 @@ void scr0(double vk, double exri, ParticleDescriptor *c1); 
 * an aggregate. See Sec. 4.2.1 in Borghese, Denti & Saija (2007).

 *

 * \param vk: `double` Wave number.

 * \param vkarg: `double` QUESTION: definition?

 * \param vkarg: `double` ANNOTATION: Argument of wave number.

 * \param exri: `double` External medium refractive index.

 * \param duk: `double *` QUESTION: definition?

 * \param duk: `double *` ANNOTATION: variation of unit wave vector.

 * \param c1: `ParticleDescriptor *` Pointer to a ParticleDescriptor instance.

 */

void scr2(

src/include/tfrfme.h

+34 −34
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ protected: 
  //! NLMMT = 2 * LM * (LM + 2)

  int _nlmmt;



  //! QUESTION: definition?

  //! ANNOTATION: incident amplitudes.

  dcomplex *_wk;



  /*! \brief Load a Swap1 instance from a HDF5 binary file.
@@ -95,7 +95,7 @@ public: 
  /*! \brief Calculate the necessary amount of memory to create a new instance.

   *

   * \param lm: `int` Maximum field expansion order.

   * \param nkv: `int` Number of vector coordinates. QUESTION: correct?

   * \param nkv: `int` ANNOTATION: Number of wave vectors.

   * \return size: `long` The necessary memory size in bytes.

   */

  static long get_size(int lm, int nkv);
@@ -132,23 +132,23 @@ protected: 
  int _last_matrix;

  //! Number of beam description wave numbers.

  int _nkv;

  //! QUESTION: definition?

  //! ANNOTATION: normalized aperture.

  double _apfafa;

  //! QUESTION: definition?

  //! ANNOTATION: aperture correction.

  double _pmf;

  //! QUESTION: definition?

  //! ANNOTATION: cover slip thickness.

  double _spd;

  //! QUESTION: definition?

  //! ANNOTATION: external over oil refractive index ratio.

  double _rir;

  //! QUESTION: definition?

  //! ANNOTATION: refraction factor.

  double _ftcn;

  //! QUESTION: definition?

  //! ANNOTATION: cover correction factor.

  double _fshmx;

  //! QUESTION: definition?

  //! ANNOTATION: maximum Cartesian extension of wave.

  double _vxyzmx;

  //! Cartesian displacement. QUESTION: correct?

  //! ANNOTATION: Cartesian displacement.

  double _delxyz;

  //! QUESTION: definition?

  //! ANNOTATION: maximum wave number.

  double _vknmx;

  //! Wave number grid spacing.

  double _delk;
@@ -192,31 +192,31 @@ public: 
  const int &last_matrix = _last_matrix;

  //! Read-only view on the number of beam description wave numbers.

  const int &nkv = _nkv;

  //! QUESTION: definition?

  //! ANNOTATION: wave number vector.

  double *vkv;

  //! QUESTION: definition?

  //! ANNOTATION: Vectorized VKZ matrix.

  double *vec_vkzm;

  //! QUESTION: definition?

  //! ANNOTATION: Normalized aperture.

  const double &apfafa = _apfafa;

  //! QUESTION: definition?

  //! ANNOTATION: Aperture correction.

  const double &pmf = _pmf;

  //! QUESTION: definition?

  //! ANNOTATION: Cover slip thickness.

  const double &spd = _spd;

  //! QUESTION: definition?

  //! ANNOTATION: External over oil refractive index.

  const double &rir = _rir;

  //! QUESTION: definition?

  //! ANNOTATION: Refraction factor.

  const double &ftcn = _ftcn;

  //! QUESTION: definition?

  //! ANNOTATION: Cover slip correction factor.

  const double &fshmx = _fshmx;

  //! QUESTION: definition?

  //! ANNOTATION: Maximum Cartesian extension of wave.

  const double &vxyzmx = _vxyzmx;

  //! Cartesian displacement. QUESTION: correct?

  //! ANNOTATION: Cartesian displacement.

  const double &delxyz = _delxyz;

  //! QUESTION: definition?

  //! ANNOTATION: Maximum wave number.

  const double &vknmx = _vknmx;

  //! QUESTION: definition?

  //! ANNOTATION: Wave number variation.

  const double &delk = _delk;

  //! QUESTION: definition?

  //! ANNOTATION: Squared wave number variation.

  const double &delks = _delks;

  //! NLMMT = LM * (LM + 2) * 2

  const int &nlmmt = _nlmmt;
@@ -330,11 +330,11 @@ protected: 
  double _ff;

  //! Lens transmission.

  double _tra;

  //! QUESTION: definition?

  //! ANNOTATION: Cover slip thickness.

  double _spd;

  //! QUESTION: definition?

  //! ANNOTATION: Cover slip correction factor.

  double _frsh;

  //! QUESTION: definition?

  //! ANNOTATION: Oil refractive index.

  double _exril;

  //! Vector of computed x positions

  double *xv;
@@ -380,7 +380,7 @@ public: 
  const int& lmode = _lmode;

  //! Read-only view on maximum field expansion order.

  const int& lm = _lm;

  //! QUESTION: definition?

  //! ANNOTATION: Number of wave vectors.

  const int& nkv = _nkv;

  //! Read-only view on number of computed X coordinates.

  const int& nxv = _nxv;
@@ -398,20 +398,20 @@ public: 
  const double& ff = _ff;

  //! Read-only view on lens transmission.

  const double& tra = _tra;

  //! QUESTION: definition?

  //! ANNOTATION: Cover slip thickness.

  const double& spd = _spd;

  //! QUESTION: definition?

  //! ANNOTATION: Cover slip correction.

  const double& frsh = _frsh;

  //! QUESTION: definition?

  //! ANNOTATION: Oil refractive index.

  const double& exril = _exril;

  //! QUESTION: definition?

  //! ANNOTATION: Vectorised WSUM matrix.

  dcomplex *vec_wsum;

  

  /*! \brief Trapping configuration instance constructor.

   *

   * \param lmode: `int` Order expansion mode flag.

   * \param lm: `int` Maximum field expansion order.

   * \param nkv: `int` Number of wave vector coordinates. QUESTION: correct?

   * \param nkv: `int` ANNOTATION: Number of wave vectors.

   * \param nxv: `int` Number of computed X coordinates.

   * \param nyv: `int` Number of computed Y coordinates.

   * \param nzv: `int` Number of computed Z coordinates.
@@ -437,7 +437,7 @@ public: 
  /*! \brief Calculate the necessary amount of memory to create a new instance.

   *

   * \param lm: `int` Maximum field expansion order.

   * \param nkv: `int` Number of radial vector coordinates. QUESTION: correct?

   * \param nkv: `int` ANNOTATION: Number of wave vectors.

   * \param nxv: `int` Number of computed X coordinates.

   * \param nyv: `int` Number of computed Y coordinates.

   * \param nzv: `int` Number of computed Z coordinates.