Space documentation

src/include/space.h

@@ -13,9 +13,13 @@ class Particle;
 class Space : public Node
 {
 public:
-    Point minPoint, maxPoint;
+    /// @brief Minimum point of the space.
+    Point minPoint;
+    /// @brief Maximum point of the space.
+    Point maxPoint;
     Points centreOfCharge;
     Points getCentreOfCharge() override;
+    /// @brief Children of the space.
     std::vector<Node *> children;
     std::vector<Node *> getChildren() override;
 
@@ -51,6 +55,7 @@ class Space : public Node
                                                    HotspotShape hotspotShape,
                                                    std::initializer_list<double> params);
 
+    /// @brief Recalculates the centre of charge of the space and its children.
     void recalculateCentreOfCharge();
 
     /// @brief Function to convert the space to a string.

src/space.cpp

@@ -48,11 +48,14 @@ Point Space::midpoint()
     return Point((minPoint.x + maxPoint.x) / 2, (minPoint.y + maxPoint.y) / 2, (minPoint.z + maxPoint.z) / 2);
 }
 
-// Logic for insertion:
-// 1. If the particle is outside the bounds of the space, return.
-// 2. If the space is an external node, find the octet in which the particle belongs and insert it.
-// 3. If the octet is a nullptr, replace it with the particle.
-// 4. If the octet is a space, recursively insert the particle into the octet.
+/// @param particle The particle to be inserted.
+/// @details Inserts a particle into the space.
+/// @details Logic for insertion:
+/// @details 1. If the particle is outside the bounds of the space, return.
+/// @details 2. Determine which octet the particle belongs to.
+/// @details 3. If the octet is a nullptr, replace it with the particle.
+/// @details 4. If the octet is a particle, create a new space and insert the old particle and the new particle into the space.
+/// @details 5. If the octet is a space, recursively insert the particle into the octet.
 void Space::insert(Particle *particle)
 {
     if (particle->position.x < minPoint.x || particle->position.x > maxPoint.x ||
@@ -255,6 +258,12 @@ std::vector<Particle *> Space::generateParticles(double density,
     return generatedParticles;
 }
 
+/// @details Logic for recalculateCentreOfCharge(): 
+/// @details 1. Iterate over all children of the space.
+/// @details 2. If the child is a particle, add the charge to the total charge and calculate the position product sum (q*P).
+/// @details 3. If the child is a space, recursively call recalculateCentreOfCharge() on the space.
+/// @details 4. Calculate the centre of charge of the space by dividing the position product sum by the total charge (q*P/q = P).
+/// @details 5. The centre of charge is a pair of points, one for positive charge and one for negative charge.
 void Space::recalculateCentreOfCharge()
 {
     Charge totalCharge = Charge(0, 0);