Postprocess framework

- Executed has been completed and testd.
- regions multipleSpheres are compelete
- Docs for regions is comelete.

src/PostprocessData/region/regionPoints/sphereRegionPoints/sphereRegionPoints.hpp

@@ -18,6 +18,19 @@ Licence:
 
 -----------------------------------------------------------------------------*/
 
+/**
+ * @file sphereRegionPoints.hpp
+ * @brief A class representing a spherical region for point selection
+ * 
+ * This class provides functionality to select points within a spherical region
+ * and to compute related properties such as volume and equivalent diameter.
+ * It inherits from regionPoints and implements all required virtual methods.
+ * 
+ * @see regionPoints
+ * @see sphere
+ * @see fieldsDataBase
+ */
+
 #ifndef __sphereRegionPoints_hpp__
 #define __sphereRegionPoints_hpp__
 
@@ -27,75 +40,127 @@ Licence:
 
 namespace pFlow
 {
+
 class sphereRegionPoints
 :
     public regionPoints
 {
 private:
 
-    /// spehre region for selecting points
+    /// Sphere object defining the region for point selection
     sphere  sphereRegion_;
 
-    /// the volume of region
+    /// Volume of the spherical region
     real    volume_;
 
+    /// Diameter of the spherical region
     real    diameter_;
 
-    /// the point indices that are selected by this region
+    /// Indices of points that are selected by this region
     uint32Vector    selectedPoints_;
 
 public:
 
     TypeInfo(sphere::TYPENAME());
 
+    /**
+     * @brief Construct a spherical region for point selection
+     * 
+     * @param dict Dictionary containing sphereInfo dictionary 
+     * @param fieldsDataBase Database containing fields data
+     */
     sphereRegionPoints(
         const dictionary& dict,
         fieldsDataBase& fieldsDataBase);
 
+    /// Destructor
     ~sphereRegionPoints() override = default;
     
+    /**
+     * @brief Get the number of regions (always 1 for sphere)
+     * @return Always returns 1
+     */
     uint32 size()const override
     {
         return 1;
     }
 
+    /**
+     * @brief Check if the region is empty
+     * @return Always returns false
+     */
     bool empty()const override
     {
         return false;
     }
 
+    /**
+     * @brief Get the volume of the spherical region
+     * @return A span containing the volume of the region
+     */
     span<const real> volumes()const override
     {
         return span<const real>(&volume_, 1);
     }
 
+    /**
+     * @brief Get the equivalent diameter of the spherical region
+     * @return A span containing the diameter of the region
+     */
     span<const real> eqDiameters()const override
     {
         return span<const real>(&diameter_, 1);
     }
 
+    /**
+     * @brief Get the center of the spherical region
+     * @return A span containing the center point of the region
+     */
     span<const realx3> centers()const override
     {
         return span<const realx3>(&sphereRegion_.center(), 1);
     }
-        
+    
+    /**
+     * @brief Get the indices of points within the region (const version)
+     * @param elem Element index (ignored as there's only one sphere)
+     * @return A span containing indices of points within the region
+     */    
     span<const uint32> indices(uint32 elem)const override
     {
         return span<const uint32>(selectedPoints_.data(), selectedPoints_.size());
     }
 
+    /**
+     * @brief Get the indices of points within the region (non-const version)
+     * @param elem Element index (ignored as there's only one sphere)
+     * @return A span containing indices of points within the region
+     */
     span<uint32> indices(uint32 elem) override
     {
         return span<uint32>(selectedPoints_.data(), selectedPoints_.size());
     }
 
+    /**
+     * @brief Update the points selected by this region
+     * @return True if update was successful
+     */
     bool update()override;
 
+    /**
+     * @brief Determine if data should be written to the same time file
+     * @return Always returns true
+     */
     bool writeToSameTimeFile()const override
     {
         return true;
     }
 
+    /**
+     * @brief Write region data to output stream
+     * @param os Output stream to write to
+     * @return True if write was successful
+     */
     bool write(iOstream& os)const override;
     
 };