Add doxygen

This commit is contained in:
jun
2023-10-09 22:16:35 -03:00
parent 31a7b306e0
commit 8cd3981a1f
6 changed files with 2758 additions and 11 deletions

1
.gitignore vendored
View File

@@ -1 +1,2 @@
build/ build/
doc/

2733
doxygen.dox Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -15,7 +15,7 @@
#include <vector> #include <vector>
/** /**
* @brief Atom class * @brief Basic atom class
* *
*/ */
class Atom { class Atom {
@@ -26,8 +26,7 @@ public:
std::string name = ""; ///< Name std::string name = ""; ///< Name
Atom(double x, double y, double z, std::string name, double mass) Atom(double x, double y, double z, std::string name, double mass)
: x(x), y(y), z(z), vx(0), vy(0), vz(0), m(mass), name(name) { : x(x), y(y), z(z), vx(0), vy(0), vz(0), m(mass), name(name) {}
}
}; };
/** /**

View File

@@ -13,12 +13,20 @@
#include <cmath> #include <cmath>
/**
* @brief Potential generator base class
*
*/
class Potential { class Potential {
public: public:
virtual double potential(double r) = 0; virtual double potential(double r) = 0;
virtual double force(double r) = 0; virtual double force(double r) = 0;
}; };
/**
* @brief Lennard Jones potential generator
*
*/
class LennardJones : public Potential { class LennardJones : public Potential {
public: public:
double potential(double r) override { double potential(double r) override {

View File

@@ -17,6 +17,10 @@
#include "Atom.hpp" #include "Atom.hpp"
#include "Potentials.hpp" #include "Potentials.hpp"
/**
* @brief System class that aggregates functions and data related to the system
*
*/
class System { class System {
private: private:
std::vector<Atom> atoms; ///< Atoms in the system std::vector<Atom> atoms; ///< Atoms in the system
@@ -57,9 +61,7 @@ private:
void buildGrid(); void buildGrid();
public: public:
explicit System(double timeDelta, explicit System(double timeDelta, double rcut, Potential *potential,
double rcut,
Potential *potential,
std::size_t tableResolution = 1000); std::size_t tableResolution = 1000);
void step(); void step();

View File

@@ -13,6 +13,10 @@
#include <boost/mpi.hpp> #include <boost/mpi.hpp>
/**
* @brief MPI worker class
*
*/
class Worker { class Worker {
public: public:
Worker(boost::mpi::communicator &comm) : m_comm(comm) {} Worker(boost::mpi::communicator &comm) : m_comm(comm) {}