Move comments to header (BCfactory)

src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.cpp

@@ -9,22 +9,18 @@ void BoundaryConditionFactory::setVelocityBoundaryCondition(VelocityBC boundaryC
 
 boundaryCondition BoundaryConditionFactory::getVelocityBoundaryConditionPost() const
 {
+    // for descriptions of the boundary conditions refer to the header ( VelocityBC)
     switch (this->velocityBoundaryCondition) {
         case VelocityBC::VelocitySimpleBounceBackCompressible:
-            // VelocitySimpleBounceBackCompressible = plain bounce back velocity boundary condition
             return QVelDevicePlainBB27;
             break;
         case VelocityBC::VelocityIncompressible:
-            // VelocityIncompressible = interpolated velocity boundary condition, based on subgrid distances
             return QVelDev27;
             break;
-        case VelocityBC::VelocityCompressible:
-            // VelocityCompressible = interpolated velocity boundary condition, based on subgrid distances
+        case VelocityBC::VelocityCompressible:            
             return QVelDevComp27;
             break;
         case VelocityBC::VelocityAndPressureCompressible:
-            // VelocityAndPressureCompressible = interpolated velocity boundary condition, based on subgrid distances.
-            // Also sets the pressure to the bulk pressure.
             return QVelDevCompZeroPress27;
             break;
         default:

src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.h

@@ -14,16 +14,24 @@ using boundaryCondition = std::function<void(LBMSimulationParameter *, QforBound
 class BoundaryConditionFactory
 {
 public:
+    //! \brief An enumeration for selecting a velocity boundary condition
     enum class VelocityBC {
+        //! - VelocitySimpleBounceBackCompressible = plain bounce back velocity boundary condition
         VelocitySimpleBounceBackCompressible,
+        //! - VelocityIncompressible = interpolated velocity boundary condition, based on subgrid distances
         VelocityIncompressible,
+        //! - VelocityCompressible = interpolated velocity boundary condition, based on subgrid distances
         VelocityCompressible,
+        //! - VelocityAndPressureCompressible = interpolated velocity boundary condition, based on subgrid distances.
+        //! Also sets the pressure to the bulk pressure.
         VelocityAndPressureCompressible
     };
-    // enum class OutflowBoundaryConditon {};  // TODO:
+
+    // enum class OutflowBoundaryCondition {};  // TODO:
     // https://git.rz.tu-bs.de/m.schoenherr/VirtualFluids_dev/-/issues/16
 
     void setVelocityBoundaryCondition(const VelocityBC boundaryConditionType);
+
     // void setOutflowBoundaryCondition(...); // TODO:
     // https://git.rz.tu-bs.de/m.schoenherr/VirtualFluids_dev/-/issues/16
 
@@ -31,6 +39,7 @@ public:
 
 private:
     VelocityBC velocityBoundaryCondition;
+
     // OutflowBoundaryConditon outflowBC // TODO: https://git.rz.tu-bs.de/m.schoenherr/VirtualFluids_dev/-/issues/16
 };