Commit 103e75a8 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Add missing doxygen inline documentation

parent 311d62e5
Loading
Loading
Loading
Loading
+21 −11
Original line number Diff line number Diff line
@@ -39,17 +39,10 @@
#include <nvtx3/nvToolsExt.h>
#endif

//#define USE_CUBLAS 1
#ifdef USE_CUBLAS
#include <cuda_runtime.h>
#endif

//#ifdef USE_MAGMA
//#include <cuda_runtime.h>
//#endif
// define by hand for a first test
//#define USE_REFINEMENT 1

#ifndef INCLUDE_TYPES_H_
#include "../include/types.h"
#endif
@@ -102,15 +95,32 @@ using namespace std;

// I would like to put it all in a struct, but then I'd have to write a constructor for it, due to members defined as references, creating a worse nightmare than the one I'd like to simplify...

/*! \brief Main calculation loop.
 *
 *  The solution of the scattering problem for different wavelengths is an
 *  embarrasingly parallel task. This function, therefore, collects all the
 *  operations that can be independently executed by different processes,
 *  after the configuration stage and the first calculation loop have been
 *  executed.
 *
 *  \param jxi488: `int` Wavelength loop index.
 *  \param sconf: `ScattererConfiguration *` Pointer to a ScattererConfiguration object.
 *  \param gconf: `GeometryConfiguration *` Pointer to a GeometryConfiguration object.
 *  \param sa: `ScatteringAngles *` Pointer to a ScatteringAngles object.
 *  \param cid: `ClusterIterationData *` Pointer to a ClusterIterationData object.
 *  \param output: `VirtualAsciiFile *` Pointer to a VirtualAsciiFile object.
 *  \param output_path: `const string &` Path to the output directory.
 *  \param vtppoanp: `VirtualBinaryFile *` Pointer to a VirtualBinaryFile object.
 */
int cluster_jxi488_cycle(int jxi488, ScattererConfiguration *sconf, GeometryConfiguration *gconf, ScatteringAngles *sa, ClusterIterationData *cid, VirtualAsciiFile *output, const string& output_path, VirtualBinaryFile *vtppoanp);

/*! \brief C++ implementation of CLU
 *
 *  \param config_file: `string` Name of the configuration file.
 *  \param data_file: `string` Name of the input data file.
 *  \param output_path: `string` Directory to write the output files in.
 *  \param config_file: `const string &` Name of the configuration file.
 *  \param data_file: `const string &` Name of the input data file.
 *  \param output_path: `const string &` Name of the directory to write the output files in.
 *  \param mpidata: `const mixMPI *` Pointer to a mixMPI data structure.
 */

void cluster(const string& config_file, const string& data_file, const string& output_path, const mixMPI *mpidata) {
  chrono::time_point<chrono::high_resolution_clock> t_start = chrono::high_resolution_clock::now();
  chrono::duration<double> elapsed;