From 5b2b4e01057d6155ae7746ec6622e8de85677ccb Mon Sep 17 00:00:00 2001 From: Bruno Blais Date: Wed, 1 Jan 2025 17:35:29 -0500 Subject: [PATCH] Add more comments on the dem_properties --- include/core/dem_properties.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/include/core/dem_properties.h b/include/core/dem_properties.h index ae543059f5..5408e5ffb4 100644 --- a/include/core/dem_properties.h +++ b/include/core/dem_properties.h @@ -9,6 +9,12 @@ namespace DEM { + /* The SolverType enum identifies which type of solver is using the DEM particles. + * This is used to identify which index corresponds to which properties. Two type of + * solvers are currently supported. DEM implies pure DEM simulation whereas cfd_dem + * is used to indicate simulations in which the particles are coupled to CFD. In the latter case + * the particles carry additional properties related to the particle-fluid coupling. + */ enum SolverType { dem, @@ -19,8 +25,7 @@ namespace DEM * particles properties within the property pool and also to generate * the associative names for the properties * This is the only part where we should use a classical enum because it is - * used as an integer within the code I think this is a temporary solution for - * now + * used as an integer when indexing the particle properties. */ namespace DEMsolver { @@ -65,7 +70,7 @@ namespace DEM }; }; - // **Template Specialization to Select PropertiesIndex** + /// Template specialization to select the adequate PropertiesIndex template struct PropertiesIndexEnum;