diff --git a/src/include/outputs.h b/src/include/outputs.h index abea6a6f891c1e318c7c7c244f196cc469a38b48..b4f9b02ed34cbb91a56cfbe9de2832e6fd28be52 100644 --- a/src/include/outputs.h +++ b/src/include/outputs.h @@ -970,6 +970,15 @@ public: // >>> END OF OUTPUT FOR INCLUSION <<< // >>> OUTPUT FOR SPHERE <<< +/*! \brief Class to collect output information for scattering from a single sphere. + * + * 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 + * `SphereOutputInfo` class is to provide a wrapper for the output + * of the spherical particle scattering solver. + */ class SphereOutputInfo { protected: //! \brief Number of incident azimuth calculations. @@ -1104,7 +1113,7 @@ public: double *vec_tqsk1; //! \brief Vector of sphere average scattering torque along incidence direction (perpendicular polarization). double *vec_tqsk2; - //| \brief Vector of total forward scattering amplitudes. + //! \brief Vector of total forward scattering amplitudes. dcomplex *vec_fsat; //! \brief Vector of total QSCHU. double *vec_qschut; diff --git a/src/inclusion/inclusion.cpp b/src/inclusion/inclusion.cpp index 86c73b469a07f4a89e9fac7b3420a62bc1119339..d7aff78d25324f36f466294a3b357b88df9774b4 100644 --- a/src/inclusion/inclusion.cpp +++ b/src/inclusion/inclusion.cpp @@ -118,7 +118,7 @@ using namespace std; * \param gconf: `GeometryConfiguration *` Pointer to a `GeometryConfiguration` object. * \param sa: `ScatteringAngles *` Pointer to a `ScatteringAngles` object. * \param cid: `InclusionIterationData *` Pointer to an `InclusionIterationData` object. - * \param oi: `InclusionOutputInfo *` Pointer to an `InclusionOutputInfo` object. + * \param output: `InclusionOutputInfo *` Pointer to an `InclusionOutputInfo` object. * \param output_path: `const string &` Path to the output directory. * \param vtppoanp: `VirtualBinaryFile *` Pointer to a `VirtualBinaryFile` object. */ @@ -675,7 +675,7 @@ void inclusion(const string& config_file, const string& data_file, const string& } #endif } - + int inclusion_jxi488_cycle(int jxi488, ScattererConfiguration *sconf, GeometryConfiguration *gconf, ScatteringAngles *sa, InclusionIterationData *cid, InclusionOutputInfo *output, const string& output_path, VirtualBinaryFile *vtppoanp) { const dcomplex cc0 = 0.0 + I * 0.0; int nxi = sconf->number_of_scales; diff --git a/src/scripts/model_maker.py b/src/scripts/model_maker.py index d7e031e99a1b732114ad7fd5edc194839ecc9412..e97d5c6187b86c0c468466210f39b358d6bbf2d6 100755 --- a/src/scripts/model_maker.py +++ b/src/scripts/model_maker.py @@ -15,10 +15,14 @@ # A copy of the GNU General Public License is distributed along with # this program in the COPYING file. If not, see: <https://www.gnu.org/licenses/>. -## @package pycompare -# \brief Script to build models from YAML configuration files +## @package model_maker +# \brief Script to build models from YAML configuration files. +# +# Script to assist in the creation of model input files starting +# from a YAML descriptor. +# +# The script requires python3. -import numpy as np import yaml from pathlib import PurePath diff --git a/src/scripts/pycompare.py b/src/scripts/pycompare.py index d8c7072f233e908517c2222c21a983ee8b460f63..01ea0144260265d0e3f6ac79d430b2dd00520229 100755 --- a/src/scripts/pycompare.py +++ b/src/scripts/pycompare.py @@ -16,7 +16,7 @@ # this program in the COPYING file. If not, see: <https://www.gnu.org/licenses/>. ## @package pycompare -# \brief Script to perform output consistency tests +# \brief Script to perform output consistency tests. # # Comparing the numeric output can be rendered hard by the amount of information # contained in a typical output file and the necessity to determine whether a