From 57c8c1c7623ea061801c0c83e21ac774840424a8 Mon Sep 17 00:00:00 2001
From: tmjnijssen <tim@tim-nijssen.nl>
Date: Thu, 14 Apr 2022 15:50:39 +0200
Subject: [PATCH] add doc

---
 doc/CFDEMcoupling_models.txt               |  1 +
 doc/forceModel_transferFluidProperties.txt | 42 ++++++++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 doc/forceModel_transferFluidProperties.txt

diff --git a/doc/CFDEMcoupling_models.txt b/doc/CFDEMcoupling_models.txt
index 00ce8e28..073082dd 100644
--- a/doc/CFDEMcoupling_models.txt
+++ b/doc/CFDEMcoupling_models.txt
@@ -124,6 +124,7 @@ particleDeformation,
 potentialRelaxation,
 "surfaceTensionForce"_forceModel_surfaceTensionForce.html,
 terminalVelocity,
+"transferFluidProperties"_forceModel_transferFluidProperties.html,
 turbulentDispersion,
 turbulentVelocityFluctuations,
 "virtualMassForce"_forceModel_virtualMassForce.html,
diff --git a/doc/forceModel_transferFluidProperties.txt b/doc/forceModel_transferFluidProperties.txt
new file mode 100644
index 00000000..8606da78
--- /dev/null
+++ b/doc/forceModel_transferFluidProperties.txt
@@ -0,0 +1,42 @@
+"CFDEMproject Website"_lws - "Main Page"_main :c
+
+:link(lws,http://www.cfdem.com)
+:link(main,CFDEMcoupling_Manual.html)
+
+:line
+
+forceModel transferFluidProperties command :h3
+
+[Syntax:]
+
+Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
+dictionary.
+
+forceModels
+(
+    transferFluidProperties
+);
+transferFluidPropertiesProps
+\{
+    verbose       switch1;
+    interpolation switch2;
+\} :pre
+
+{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :ulb,l
+{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
+:ule
+
+[Description:]
+
+This "force model" does not influence the particles or the flow - it transfer to fluid density and (dynamic)
+viscosity from OpenFOAM to LIGGGHTS.
+
+
+[Restrictions:]
+
+This model requires {fix cfd/coupling/fluidproperties} to work.
+
+[Related commands:]
+
+"forceModel"_forceModel.html
+