From a811e255562ed5db8ba3af94dd7a5f93a54c6a52 Mon Sep 17 00:00:00 2001
From: Kutalmis Bercin <kutalmis.bercin@esi-group.com>
Date: Wed, 4 Oct 2023 17:06:43 +0100
Subject: [PATCH] DOC: StandardWallInteraction: correct restitution coeff
 (fixes #2676)

---
 .../StandardWallInteraction/StandardWallInteraction.H    | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
index 1b821e9702..951ecab28c 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
@@ -6,7 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2017 OpenFOAM Foundation
-    Copyright (C) 2018-2019 OpenCFD Ltd.
+    Copyright (C) 2018-2023 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -44,10 +44,13 @@ Description
     {
         type        rebound; // stick, escape
         e           1;       // optional - elasticity coeff
-        mu          0;       // optional - restitution coeff
+        mu          0;       // optional - (1 - restitution coeff)
     }
     \endverbatim
 
+Note
+  - \c mu=1 results in perfectly inelastic collisions.
+
 \*---------------------------------------------------------------------------*/
 
 #ifndef StandardWallInteraction_H
@@ -82,7 +85,7 @@ protected:
         //- Elasticity coefficient
         scalar e_;
 
-        //- Restitution coefficient
+        //- The unity minus the restitution coefficient
         scalar mu_;