From 0a3ad1b41c2b5bbd152aad5b0465e74d53c8d5e4 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Fri, 13 Nov 2020 18:42:38 +0000
Subject: [PATCH] fvOption::sixDoFAccelerationSource: Documented the structure
 of the accelerations vector

---
 .../sixDoFAccelerationSource.H                         | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/fvOptions/sources/derived/sixDoFAccelerationSource/sixDoFAccelerationSource.H b/src/fvOptions/sources/derived/sixDoFAccelerationSource/sixDoFAccelerationSource.H
index 87823efc1a..c20c07f67b 100644
--- a/src/fvOptions/sources/derived/sixDoFAccelerationSource/sixDoFAccelerationSource.H
+++ b/src/fvOptions/sources/derived/sixDoFAccelerationSource/sixDoFAccelerationSource.H
@@ -68,7 +68,10 @@ class sixDoFAccelerationSource
 {
 public:
 
-        //- Accelerations type
+        //- Accelerations type comprising
+        //      linear acceleration vector
+        //      angular velocity vector
+        //      angular acceleration vector
         typedef Vector<vector> accelerationVectors;
 
 
@@ -76,7 +79,10 @@ protected:
 
     // Protected data
 
-        //- Accelerations function
+        //- Accelerations function returning a vector containing
+        //      linear acceleration vector
+        //      angular velocity vector
+        //      angular acceleration vector
         autoPtr<Function1<accelerationVectors>> accelerations_;
 
         //- Velocity field name, default = U