Commit e9387891 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Fix inline documentation references

parent b43cb473

src/include/TransitionMatrix.h

+1 −1
Original line number Diff line number Diff line
@@ -172,7 +172,7 @@ class TransitionMatrix { 
   * \param lm: `int` Maximum field expansion order.

   * \param vk: `double` Wave number in scale units.

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

   * \param elems: `complex double *` Vectorized elements of the matrix.

   * \param _elems: `complex double *` Vectorized elements of the matrix.

   * \param radius: `double` Radius for the single sphere case (defaults to 0.0).

   */

  TransitionMatrix(

src/include/clu_subs.h

+6 −6
Original line number Diff line number Diff line
@@ -73,12 +73,12 @@ void apcra( 
 *

 * This function performs the complex inner product. It is used by `lucin()`.

 *

 * \param z: `complex double`

 * \param am: `complex double **`

 * \param i: `int`

 * \param jf: `int`

 * \param k: `int`

 * \param nj: `int`

 * \param z: `complex double` Starting element.

 * \param vec_am: `complex double *` Vectorized matrix.

 * \param i: `int` Index of first sub-matrix row.

 * \param jf: `int` Index of first submatrix column.

 * \param k: `int` Index of second sub-matrix row.

 * \param nj: `int` Range of first sub-matrix columns.

 * \param istep: `np_int` Size of rows in the matrix.

 */

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

src/include/outputs.h

+9 −0
Original line number Diff line number Diff line
@@ -1280,6 +1280,15 @@ public: 
// >>> END OF OUTPUT FOR SPHERE <<<



// >>> OUTPUT FOR TRAPPING <<<

/*! \brief Class to collect output information for particle trapping.

 *

 * The results of the calculation can be saved in different formats.

 * It is therefore convenient to have a proper memory structure that

 * allows for storing the results and flushing them in any of the

 * permitted formats with just one operation. The purpose of the

 * `TrappingOutputInfo` class is to provide a wrapper for the output

 * of the particle trapping solver.

 */

class TrappingOutputInfo {

protected:

  //! \brief Force / torque mode.

src/scripts/inertia.py

+1 −0
Original line number Diff line number Diff line
@@ -416,6 +416,7 @@ def get_types(config): 
## \brief Get the index of an element in an array.

#

#  \param element: Anything.

#  \param array: `array-like` Array with the same type of the element sought for.

#  \return index: `int` 0-based index of the element.

def index_of(element, array):

    index = 0

src/scripts/model_maker.py

+12 −2
Original line number Diff line number Diff line
@@ -598,8 +598,8 @@ def print_help(): 
#  radii of the particle monomers and of the equivalent mass sphere, to

#  assist in the selection of the proper starting orders.

#

#  \parameter scatterer: `dict` A dictionary for the scatterer configuration.

#  \parameter geometry: `dict` A dictionary for the geometry configuration.

#  \param scatterer: `dict` A dictionary for the scatterer configuration.

#  \param geometry: `dict` A dictionary for the geometry configuration.

def print_model_summary(scatterer, geometry):

    avgX = 0.0

    avgY = 0.0
@@ -877,6 +877,16 @@ def random_compact(scatterer, geometry, seed, max_rad): 
            sph_index += 1

    return current_n



## \brief Perform a preliminary test of the resources required by the model.

#

#  The resolution of models requires the availability of memory resources

#  that increase as a function of the model complexity. This function aims

#  at evaluating the complexity of the model and estimate whether the

#  declared system resources are sufficient to run the calculation.

#

#  \param model: `dict` Model description dictionary.

#  \param gconf: `dict` Geometry description dictionary.

#  \param sconf: `dict` Scattering description dictionary.

def test_system_resources(model, gconf, sconf):

    le = gconf['le'] if (gconf['application'] != "SPH") else 0

    li = gconf['li']