Skip to content

Commit

Permalink
Add more comments on the dem_properties
Browse files Browse the repository at this point in the history
  • Loading branch information
blaisb authored and OGaboriault committed Jan 2, 2025
1 parent b4c9417 commit 5b2b4e0
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions include/core/dem_properties.h
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
{
Expand Down Expand Up @@ -65,7 +70,7 @@ namespace DEM
};
};

// **Template Specialization to Select PropertiesIndex**
/// Template specialization to select the adequate PropertiesIndex
template <SolverType solver_type>
struct PropertiesIndexEnum;

Expand Down

0 comments on commit 5b2b4e0

Please sign in to comment.