From 993872bf57ad91cda0a362d86a984531dbca9f84 Mon Sep 17 00:00:00 2001
From: Anna Wellmann <a.wellmann@tu-bs.de>
Date: Fri, 1 Jul 2022 09:16:26 +0000
Subject: [PATCH] Move comments to header (BCfactory)
---
.../BoundaryConditions/BoundaryConditionFactory.cpp | 8 ++------
.../BoundaryConditions/BoundaryConditionFactory.h | 11 ++++++++++-
2 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.cpp b/src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.cpp
index ea17e1f4f..6bc2326e1 100644
--- a/src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.cpp
+++ b/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:
diff --git a/src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.h b/src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.h
index 9db285751..aca98c968 100644
--- a/src/gpu/VirtualFluids_GPU/BoundaryConditions/BoundaryConditionFactory.h
+++ b/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
};
--
GitLab