diff --git a/include/PenningTrap.hpp b/include/PenningTrap.hpp index 9a78784..c6f142b 100644 --- a/include/PenningTrap.hpp +++ b/include/PenningTrap.hpp @@ -18,6 +18,7 @@ #include "Particle.hpp" #include "constants.hpp" #include "typedefs.hpp" +#include "utils.hpp" #pragma omp declare reduction(+ : vec_3d : omp_out += omp_in) \ initializer(omp_priv = omp_orig) @@ -62,7 +63,7 @@ private: * * @param i Index i for \f$k_{r,i,j}\f$ * @param j Index j for \f$k_{r,i,j}\f$ - * @param dt the step length (delta time) + * @param dt The step length (delta time) * * @return vec_3d * */ @@ -192,6 +193,8 @@ public: * @param steps The amount of steps for the whole simulation * @param method The method to use when moving forward a timestep * @param particle_interaction Turn particle interactions on/off + * + * @return simulation_t * */ simulation_t simulate(double time, unsigned int steps, std::string method = "rk4", diff --git a/include/typedefs.hpp b/include/typedefs.hpp index f0ceca2..de732f6 100644 --- a/include/typedefs.hpp +++ b/include/typedefs.hpp @@ -15,8 +15,8 @@ #ifndef __TYPEDEFS__ #define __TYPEDEFS__ -#include #include +#include /** @brief Typedef for the column of the result vector from simulating * particles. diff --git a/include/utils.hpp b/include/utils.hpp index c9c9485..c8469c9 100644 --- a/include/utils.hpp +++ b/include/utils.hpp @@ -19,6 +19,7 @@ #include #include #include +#include #include /** @def DEBUG(msg) @@ -46,7 +47,7 @@ __LINE__, msg) /** @def __METHOD_NAME__ - * @brief Get the name of the current method/function. + * @brief Get the name of the current method/function without the return type. * */ #define __METHOD_NAME__ methodName(__PRETTY_FUNCTION__) @@ -110,7 +111,7 @@ void m_assert(bool expr, * * @return bool * */ -bool arma_vector_close_to(arma::vec &a, arma::vec &b, double tol=1e-8); +bool close_to(arma::vec &a, arma::vec &b, double tol=1e-8); /** @brief Takes in the __PRETTY_FUNCTION__ string and removes the return type. @@ -141,7 +142,7 @@ static inline std::string methodName(const std::string& pretty_function) * @param path The path to be created * @param mode The mode/permissions for all the new directories * - * @return bool + * @return bool Success/Fail * */ bool mkpath(std::string path, int mode = 0777);