new version 3.6.1

applications/solvers/cfdemSolverIB/Make/options

@@ -1,10 +1,12 @@
+sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)
 include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)
 
 PFLAGS+= -DCFDEMWMPROJECTVERSION="$(CFDEM_WM_PROJECT_VERSION)"
 
 EXE_INC = \
      $(PFLAGS) \
-    $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
+     $(PINC) \
+     $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
     -I$(LIB_SRC)/transportModels \
     -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
     -I$(LIB_SRC)/finiteVolume/lnInclude \
@@ -16,6 +18,7 @@ EXE_INC = \
     -I$(LIB_SRC)/dynamicMesh/dynamicFvMesh/lnInclude \
     -I$(LIB_SRC)/dynamicMesh/dynamicMesh/lnInclude \
     -I$(CFDEM_LIGGGHTS_SRC_DIR)
+
 EXE_LIBS = \
     -L$(CFDEM_LIB_DIR)\
     $(CFDEM_ADD_INCOMPTURBMOD_LIBS) \

applications/solvers/cfdemSolverIB/cfdemSolverIB.C

@@ -47,7 +47,6 @@ Contributions
 #else
     #include "turbulenceModel.H"
 #endif
-#include "superquadric_flag.h"
 #include "cfdemCloudIB.H"
 #if defined(SUPERQUADRIC_ACTIVE_FLAG)
 #include "cfdemCloudIBSuperquadric.H"
@@ -108,7 +107,7 @@ int main(int argc, char *argv[])
 
         //=== dyM ===================
         interFace = mag(mesh.lookupObject<volScalarField>("voidfractionNext"));
-        mesh.update(); //dyM
+        particleCloud.setMeshHasUpdatedFlag(mesh.update()); //dyM
 
         #if defined(version30)
             #include "readTimeControls.H"
@@ -121,7 +120,7 @@ int main(int argc, char *argv[])
 
         // do particle stuff
         Info << "- evolve()" << endl;
-        particleCloud.evolve(voidfraction);
+        particleCloud.evolve(voidfraction, interFace);
 
         // Pressure-velocity PISO corrector
         {

applications/solvers/cfdemSolverIB/createFields.H

@@ -42,6 +42,21 @@
         mesh
     );
 
+    /*Info<< "\nCreating outside field\n" << endl;
+    volScalarField outside
+    (
+        IOobject
+        (
+            "outside",
+            runTime.timeName(),
+            mesh,
+            IOobject::NO_READ,
+            IOobject::AUTO_WRITE
+        ),
+        mesh,
+        scalar(0)
+    );*/
+
 //========================
 // drag law modelling
 //========================

applications/solvers/cfdemSolverPiso/Make/options

@@ -1,14 +1,17 @@
+sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)
 include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)
 
 PFLAGS+= -DCFDEMWMPROJECTVERSION="$(CFDEM_WM_PROJECT_VERSION)"
 
 EXE_INC = \
      $(PFLAGS) \
-    $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
+     $(PINC) \
+     $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
     -I$(LIB_SRC)/transportModels \
     -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
     -I$(LIB_SRC)/finiteVolume/lnInclude \
     -I$(LIB_SRC)/meshTools/lnInclude \
+    -I$(LIB_SRC)/fvOptions/lnInclude \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \
     -I$(CFDEM_LIGGGHTS_SRC_DIR)
@@ -19,6 +22,7 @@ EXE_LIBS = \
     -lincompressibleTransportModels \
     -lfiniteVolume \
     -lmeshTools \
+    -lfvOptions \
     -l$(CFDEM_LIB_NAME) \
      $(CFDEM_ADD_LIB_PATHS) \
      $(CFDEM_ADD_LIBS)

applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C

@@ -44,13 +44,17 @@ Description
 #else
     #include "turbulenceModel.H"
 #endif
+#if defined(versionv1606plus) || defined(version40)
+    #include "fvOptions.H"
+#else
+    #include "fvIOoptionList.H"
+#endif
 #include "fixedFluxPressureFvPatchScalarField.H"
 #include "cfdemCloud.H"
 
 #if defined(anisotropicRotation)
     #include "cfdemCloudRotation.H"
 #endif
-#include "superquadric_flag.h"
 #if defined(SUPERQUADRIC_ACTIVE_FLAG)
     #include "cfdemCloudRotationSuperquadric.H"
 #endif
@@ -72,6 +76,7 @@ int main(int argc, char *argv[])
         #include "createTimeControls.H"
     #endif
     #include "createFields.H"
+    #include "createFvOptions.H"
     #include "initContinuityErrs.H"
 
     // create cfdemCloud
@@ -89,8 +94,6 @@ int main(int argc, char *argv[])
     Info<< "\nStarting time loop\n" << endl;
     while (runTime.loop())
     {
-        particleCloud.clockM().start(1,"Global");
-
         Info<< "Time = " << runTime.timeName() << nl << endl;
 
         #if defined(version30)
@@ -103,18 +106,22 @@ int main(int argc, char *argv[])
         #endif
 
         // do particle stuff
+        particleCloud.clockM().start(1,"Global");
         particleCloud.clockM().start(2,"Coupling");
         bool hasEvolved = particleCloud.evolve(voidfraction,Us,U);
 
         if(hasEvolved)
         {
-            particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces());
+            particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces());
         }
     
         Info << "update Ksl.internalField()" << endl;
         Ksl = particleCloud.momCoupleM(0).impMomSource();
         Ksl.correctBoundaryConditions();
 
+        surfaceScalarField voidfractionf = fvc::interpolate(voidfraction);
+        phi = voidfractionf*phiByVoidfraction;
+
         //Force Checks
         #include "forceCheckIm.H"
 
@@ -136,9 +143,11 @@ int main(int argc, char *argv[])
                   + particleCloud.divVoidfractionTau(U, voidfraction)
                   ==
                   - fvm::Sp(Ksl/rho,U)
+                  + fvOptions(U)
                 );
 
                 UEqn.relax();
+                fvOptions.constrain(UEqn);
 
                 #if defined(version30)
                     if (piso.momentumPredictor())
@@ -150,6 +159,8 @@ int main(int argc, char *argv[])
                         solve(UEqn == - fvc::grad(p) + Ksl/rho*Us);
                     else
                         solve(UEqn == - voidfraction*fvc::grad(p) + Ksl/rho*Us);
+
+                    fvOptions.correct(U);
                 }
 
                 // --- PISO loop
@@ -168,18 +179,54 @@ int main(int argc, char *argv[])
                     U = rUA*UEqn.H();
 
                     #ifdef version23
-                        phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() )
-                            + rUAfvoidfraction*fvc::ddtCorr(U, phi);
+                        phi = ( fvc::interpolate(U) & mesh.Sf() )
+                            + rUAfvoidfraction*fvc::ddtCorr(U, phiByVoidfraction);
                     #else
-                        phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() )
-                            + fvc::ddtPhiCorr(rUAvoidfraction, U, phi);
+                        phi = ( fvc::interpolate(U) & mesh.Sf() )
+                            + fvc::ddtPhiCorr(rUAvoidfraction, U, phiByVoidfraction);
                     #endif
-                    surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf());
-                    surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS);
+                    surfaceScalarField phiS(fvc::interpolate(Us) & mesh.Sf());
+                    phi += rUAf*(fvc::interpolate(Ksl/rho) * phiS);
 
                     if (modelType=="A")
                         rUAvoidfraction = volScalarField("(voidfraction2|A(U))",rUA*voidfraction*voidfraction);
 
+                    // Update the fixedFluxPressure BCs to ensure flux consistency
+                    #ifndef versionExt32
+                    #ifndef version40
+                        if (modelType=="A")
+                        {
+                            setSnGrad<fixedFluxPressureFvPatchScalarField>
+                            (
+                                #ifdef versionv1612plus
+                                    p.boundaryFieldRef(),
+                                #else
+                                    p.boundaryField(),
+                                #endif
+                                (
+                                    phi.boundaryField()
+                                  - (mesh.Sf().boundaryField() & U.boundaryField())
+                                )/(mesh.magSf().boundaryField()*rUAf.boundaryField()*voidfractionf.boundaryField())
+                            );
+                        }else
+                        {
+                            setSnGrad<fixedFluxPressureFvPatchScalarField>
+                            (
+                                #ifdef versionv1612plus
+                                    p.boundaryFieldRef(),
+                                #else
+                                    p.boundaryField(),
+                                #endif
+                                (
+                                    phi.boundaryField()
+                                  - (mesh.Sf().boundaryField() & U.boundaryField())
+                                )/(mesh.magSf().boundaryField()*rUAf.boundaryField())
+                            );
+                        }
+                    #endif
+                    #endif
+                    
+
                     // Non-orthogonal pressure corrector loop
                     #if defined(version30)
                         while (piso.correctNonOrthogonal())
@@ -190,7 +237,7 @@ int main(int argc, char *argv[])
                         // Pressure corrector
                         fvScalarMatrix pEqn
                         (
-                            fvm::laplacian(rUAvoidfraction, p) == fvc::div(phiGes) + particleCloud.ddtVoidfraction()
+                            fvm::laplacian(rUAvoidfraction, p) == fvc::div(voidfractionf*phi) + particleCloud.ddtVoidfraction()
                         );
                         pEqn.setReference(pRefCell, pRefValue);
 
@@ -198,8 +245,7 @@ int main(int argc, char *argv[])
                             pEqn.solve(mesh.solver(p.select(piso.finalInnerIter())));
                             if (piso.finalNonOrthogonalIter())
                             {
-                                phiGes -= pEqn.flux();
-                                phi = phiGes;
+                                phiByVoidfraction = phi - pEqn.flux()/voidfractionf;
                             }
                         #else
                             if( corr == nCorr-1 && nonOrth == nNonOrthCorr )
@@ -213,13 +259,13 @@ int main(int argc, char *argv[])
 
                             if (nonOrth == nNonOrthCorr)
                             {
-                                phiGes -= pEqn.flux();
-                                phi = phiGes;
+                                phiByVoidfraction = phi - pEqn.flux()/voidfractionf;
                             }
                         #endif
 
                     } // end non-orthogonal corrector loop
 
+                    phi = voidfractionf*phiByVoidfraction;
                     #include "continuityErrorPhiPU.H"
 
                     if (modelType=="B" || modelType=="Bfull")
@@ -228,6 +274,7 @@ int main(int argc, char *argv[])
                         U -= voidfraction*rUA*fvc::grad(p) - Ksl/rho*Us*rUA;
 
                     U.correctBoundaryConditions();
+                    fvOptions.correct(U);
 
                 } // end piso loop
             }

applications/solvers/cfdemSolverPiso/createFields.H

@@ -60,7 +60,7 @@
         mesh
     );
 
-    Info<< "\nCreating dummy density field rho\n" << endl;
+    Info<< "\nCreating density field rho\n" << endl;
     volScalarField rho
     (
         IOobject
@@ -109,7 +109,19 @@ surfaceScalarField phi
  );
 #endif
 
-
+Info<< "Generating interstitial face flux field phiByVoidfraction\n" << endl;
+surfaceScalarField phiByVoidfraction
+(
+ IOobject
+ (
+    "phiByVoidfraction",
+    runTime.timeName(),
+    mesh,
+    IOobject::NO_READ,
+    IOobject::NO_WRITE
+ ),
+ linearInterpolate(U) & mesh.Sf()
+);
 
     label pRefCell = 0;
     scalar pRefValue = 0.0;

applications/solvers/cfdemSolverPisoSTM/Make/options

@@ -1,10 +1,12 @@
+sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)
 include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)
 
 PFLAGS+= -DCFDEMWMPROJECTVERSION="$(CFDEM_WM_PROJECT_VERSION)"
 
 EXE_INC = \
      $(PFLAGS) \
-    $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
+     $(PINC) \
+     $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
     -I$(LIB_SRC)/transportModels \
     -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
     -I$(LIB_SRC)/finiteVolume/lnInclude \
@@ -12,6 +14,7 @@ EXE_INC = \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \
     -I$(CFDEM_SRC_DIR)/eulerian/scalarTransportModelsCFDEM/lnInclude \
+    -I$(CFDEM_LIGGGHTS_SRC_DIR)
 
 EXE_LIBS = \
     -L$(CFDEM_LIB_DIR)\

applications/solvers/cfdemSolverPisoSTM/cfdemSolverPisoSTM.C

@@ -44,7 +44,11 @@ Description
     #include "turbulenceModel.H"
 #endif
 #include "fixedFluxPressureFvPatchScalarField.H"
-#include "cfdemCloud.H"
+#ifdef MS
+    #include "cfdemCloudMS.H"
+#else
+    #include "cfdemCloud.H"
+#endif
 #if defined(anisotropicRotation)
     #include "cfdemCloudRotation.H"
 #endif
@@ -73,7 +77,11 @@ int main(int argc, char *argv[])
     #if defined(anisotropicRotation)
         cfdemCloudRotation particleCloud(mesh);
     #else
-        cfdemCloud particleCloud(mesh);
+        #ifdef MS
+            cfdemCloudMS particleCloud(mesh);
+        #else
+            cfdemCloud particleCloud(mesh);
+        #endif
     #endif
     #include "checkModelType.H"
 
@@ -106,13 +114,16 @@ int main(int argc, char *argv[])
 
         if(hasEvolved)
         {
-            particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces());
+            particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces());
         }
     
         Info << "update Ksl.internalField()" << endl;
         Ksl = particleCloud.momCoupleM(0).impMomSource();
         Ksl.correctBoundaryConditions();
 
+        surfaceScalarField voidfractionf = fvc::interpolate(voidfraction);
+        phi = voidfractionf*phiByVoidfraction;
+
         //Force Checks
         #include "forceCheckIm.H"
 
@@ -121,26 +132,9 @@ int main(int argc, char *argv[])
 
         particleCloud.clockM().start(26,"Flow");
 
-        /*// get scalar source from DEM        
-        particleCloud.forceM(1).manipulateScalarField(Tsource);
-        Tsource.correctBoundaryConditions();*/
-
+        //Scalar transport if desired. Use "none" (noTransport) if no scalar transport is desired
         stm().update();
 
-        /*// solve scalar transport equation
-        fvScalarMatrix TEqn
-        (
-           fvm::ddt(voidfraction,T) - fvm::Sp(fvc::ddt(voidfraction),T)
-         + fvm::div(phi, T) - fvm::Sp(fvc::div(phi),T)
-         - fvm::laplacian(DT*voidfraction, T)
-         ==
-           Tsource
-        );
-        TEqn.relax();
-        TEqn.solve();*/
-
-        particleCloud.clockM().start(26,"Flow");
-
         if(particleCloud.solveFlow())
         {
             // Pressure-velocity PISO corrector
@@ -186,26 +180,30 @@ int main(int argc, char *argv[])
                     U = rUA*UEqn.H();
 
                     #ifdef version23
-                        phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() )
-                            + rUAfvoidfraction*fvc::ddtCorr(U, phi);
+                        phi = ( fvc::interpolate(U) & mesh.Sf() )
+                            + rUAfvoidfraction*fvc::ddtCorr(U, phiByVoidfraction);
                     #else
-                        phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() )
-                            + fvc::ddtPhiCorr(rUAvoidfraction, U, phi);
+                        phi = ( fvc::interpolate(U) & mesh.Sf() )
+                            + fvc::ddtPhiCorr(rUAvoidfraction, U, phiByVoidfraction);
                     #endif
-                    surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf());
-                    surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS);
+                    surfaceScalarField phiS(fvc::interpolate(Us) & mesh.Sf());
+                    phi += rUAf*(fvc::interpolate(Ksl/rho) * phiS);
 
                     if (modelType=="A")
                         rUAvoidfraction = volScalarField("(voidfraction2|A(U))",rUA*voidfraction*voidfraction);
 
                     // Update the fixedFluxPressure BCs to ensure flux consistency
                     #ifndef versionExt32
+                    #ifndef version40
                         if (modelType=="A")
                         {
-                            surfaceScalarField voidfractionf(fvc::interpolate(voidfraction));
                             setSnGrad<fixedFluxPressureFvPatchScalarField>
                             (
-                                p.boundaryField(),
+                                #ifdef versionv1612plus
+                                    p.boundaryFieldRef(),
+                                #else
+                                    p.boundaryField(),
+                                #endif
                                 (
                                     phi.boundaryField()
                                   - (mesh.Sf().boundaryField() & U.boundaryField())
@@ -215,7 +213,11 @@ int main(int argc, char *argv[])
                         {
                             setSnGrad<fixedFluxPressureFvPatchScalarField>
                             (
-                                p.boundaryField(),
+                                #ifdef versionv1612plus
+                                    p.boundaryFieldRef(),
+                                #else
+                                    p.boundaryField(),
+                                #endif
                                 (
                                     phi.boundaryField()
                                   - (mesh.Sf().boundaryField() & U.boundaryField())
@@ -223,6 +225,8 @@ int main(int argc, char *argv[])
                             );
                         }
                     #endif
+                    #endif
+                    
 
                     // Non-orthogonal pressure corrector loop
                     #if defined(version30)
@@ -234,7 +238,7 @@ int main(int argc, char *argv[])
                         // Pressure corrector
                         fvScalarMatrix pEqn
                         (
-                            fvm::laplacian(rUAvoidfraction, p) == fvc::div(phiGes) + particleCloud.ddtVoidfraction()
+                            fvm::laplacian(rUAvoidfraction, p) == fvc::div(voidfractionf*phi) + particleCloud.ddtVoidfraction()
                         );
                         pEqn.setReference(pRefCell, pRefValue);
 
@@ -242,8 +246,7 @@ int main(int argc, char *argv[])
                             pEqn.solve(mesh.solver(p.select(piso.finalInnerIter())));
                             if (piso.finalNonOrthogonalIter())
                             {
-                                phiGes -= pEqn.flux();
-                                phi = phiGes;
+                                phiByVoidfraction = phi - pEqn.flux()/voidfractionf;
                             }
                         #else
                             if( corr == nCorr-1 && nonOrth == nNonOrthCorr )
@@ -257,13 +260,13 @@ int main(int argc, char *argv[])
 
                             if (nonOrth == nNonOrthCorr)
                             {
-                                phiGes -= pEqn.flux();
-                                phi = phiGes;
+                                phiByVoidfraction = phi - pEqn.flux()/voidfractionf;
                             }
                         #endif
 
                     } // end non-orthogonal corrector loop
 
+                    phi = voidfractionf*phiByVoidfraction;
                     #include "continuityErrorPhiPU.H"
 
                     if (modelType=="B" || modelType=="Bfull")

applications/solvers/cfdemSolverPisoSTM/createFields.H

@@ -105,7 +105,7 @@
         ),
         mesh//,
         //dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 273.15)
-    );
+    );*/
 
     Info<< "\nCreating fluid-particle heat flux field\n" << endl;
     volScalarField Tsource
@@ -115,14 +115,14 @@
             "Tsource",
             runTime.timeName(),
             mesh,
-            IOobject::MUST_READ,
-            IOobject::AUTO_WRITE
+            IOobject::NO_READ,
+            IOobject::NO_WRITE
         ),
-        mesh//,
-        //dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 0.0)
+        mesh,
+        dimensionedScalar("0", dimensionSet(0, 0, -1, 1, 0), 0.0)
     );
 
-    IOdictionary transportProperties
+    /*IOdictionary transportProperties
     (
         IOobject
         (
@@ -159,7 +159,19 @@ surfaceScalarField phi
  );
 #endif
 
-
+Info<< "Generating interstitial face flux field phiByVoidfraction\n" << endl;
+surfaceScalarField phiByVoidfraction
+(
+ IOobject
+ (
+    "phiByVoidfraction",
+    runTime.timeName(),
+    mesh,
+    IOobject::NO_READ,
+    IOobject::NO_WRITE
+ ),
+ linearInterpolate(U) & mesh.Sf()
+);
 
     label pRefCell = 0;
     scalar pRefValue = 0.0;

applications/solvers/cfdemSolverPisoScalar/Make/options

@@ -1,16 +1,19 @@
+sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)
 include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)
 
 PFLAGS+= -DCFDEMWMPROJECTVERSION="$(CFDEM_WM_PROJECT_VERSION)"
 
 EXE_INC = \
      $(PFLAGS) \
-    $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
+     $(PINC) \
+     $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
     -I$(LIB_SRC)/transportModels \
     -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
     -I$(LIB_SRC)/finiteVolume/lnInclude \
     -I$(LIB_SRC)/meshTools/lnInclude \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/cfdTools \
+    -I$(CFDEM_LIGGGHTS_SRC_DIR)
 
 EXE_LIBS = \
     -L$(CFDEM_LIB_DIR)\

applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C

@@ -100,13 +100,16 @@ int main(int argc, char *argv[])
 
         if(hasEvolved)
         {
-            particleCloud.smoothingM().smoothen(particleCloud.forceM(0).impParticleForces());
+            particleCloud.smoothingM().smoothenAbsolutField(particleCloud.forceM(0).impParticleForces());
         }
     
         Info << "update Ksl.internalField()" << endl;
         Ksl = particleCloud.momCoupleM(0).impMomSource();
         Ksl.correctBoundaryConditions();
 
+        surfaceScalarField voidfractionf = fvc::interpolate(voidfraction);
+        phi = voidfractionf*phiByVoidfraction;
+
         //Force Checks
         #include "forceCheckIm.H"
 
@@ -118,6 +121,7 @@ int main(int argc, char *argv[])
         // get scalar source from DEM        
         particleCloud.forceM(1).manipulateScalarField(Tsource);
         Tsource.correctBoundaryConditions();
+        particleCloud.forceM(1).commToDEM();
 
         // solve scalar transport equation
         fvScalarMatrix TEqn
@@ -176,26 +180,30 @@ int main(int argc, char *argv[])
                     U = rUA*UEqn.H();
 
                     #ifdef version23
-                        phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() )
-                            + rUAfvoidfraction*fvc::ddtCorr(U, phi);
+                        phi = ( fvc::interpolate(U) & mesh.Sf() )
+                            + rUAfvoidfraction*fvc::ddtCorr(U, phiByVoidfraction);
                     #else
-                        phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() )
-                            + fvc::ddtPhiCorr(rUAvoidfraction, U, phi);
+                        phi = ( fvc::interpolate(U) & mesh.Sf() )
+                            + fvc::ddtPhiCorr(rUAvoidfraction, U, phiByVoidfraction);
                     #endif
-                    surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf());
-                    surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS);
+                    surfaceScalarField phiS(fvc::interpolate(Us) & mesh.Sf());
+                    phi += rUAf*(fvc::interpolate(Ksl/rho) * phiS);
 
                     if (modelType=="A")
                         rUAvoidfraction = volScalarField("(voidfraction2|A(U))",rUA*voidfraction*voidfraction);
 
                     // Update the fixedFluxPressure BCs to ensure flux consistency
                     #ifndef versionExt32
+                    #ifndef version40
                         if (modelType=="A")
                         {
-                            surfaceScalarField voidfractionf(fvc::interpolate(voidfraction));
                             setSnGrad<fixedFluxPressureFvPatchScalarField>
                             (
-                                p.boundaryField(),
+                                #ifdef versionv1612plus
+                                    p.boundaryFieldRef(),
+                                #else
+                                    p.boundaryField(),
+                                #endif
                                 (
                                     phi.boundaryField()
                                   - (mesh.Sf().boundaryField() & U.boundaryField())
@@ -205,7 +213,11 @@ int main(int argc, char *argv[])
                         {
                             setSnGrad<fixedFluxPressureFvPatchScalarField>
                             (
-                                p.boundaryField(),
+                                #ifdef versionv1612plus
+                                    p.boundaryFieldRef(),
+                                #else
+                                    p.boundaryField(),
+                                #endif
                                 (
                                     phi.boundaryField()
                                   - (mesh.Sf().boundaryField() & U.boundaryField())
@@ -213,6 +225,8 @@ int main(int argc, char *argv[])
                             );
                         }
                     #endif
+                    #endif
+                    
 
                     // Non-orthogonal pressure corrector loop
                     #if defined(version30)
@@ -224,7 +238,7 @@ int main(int argc, char *argv[])
                         // Pressure corrector
                         fvScalarMatrix pEqn
                         (
-                            fvm::laplacian(rUAvoidfraction, p) == fvc::div(phiGes) + particleCloud.ddtVoidfraction()
+                            fvm::laplacian(rUAvoidfraction, p) == fvc::div(voidfractionf*phi) + particleCloud.ddtVoidfraction()
                         );
                         pEqn.setReference(pRefCell, pRefValue);
 
@@ -232,8 +246,7 @@ int main(int argc, char *argv[])
                             pEqn.solve(mesh.solver(p.select(piso.finalInnerIter())));
                             if (piso.finalNonOrthogonalIter())
                             {
-                                phiGes -= pEqn.flux();
-                                phi = phiGes;
+                                phiByVoidfraction = phi - pEqn.flux()/voidfractionf;
                             }
                         #else
                             if( corr == nCorr-1 && nonOrth == nNonOrthCorr )
@@ -247,13 +260,13 @@ int main(int argc, char *argv[])
 
                             if (nonOrth == nNonOrthCorr)
                             {
-                                phiGes -= pEqn.flux();
-                                phi = phiGes;
+                                phiByVoidfraction = phi - pEqn.flux()/voidfractionf;
                             }
                         #endif
 
                     } // end non-orthogonal corrector loop
 
+                    phi = voidfractionf*phiByVoidfraction;
                     #include "continuityErrorPhiPU.H"
 
                     if (modelType=="B" || modelType=="Bfull")

applications/solvers/cfdemSolverPisoScalar/createFields.H

@@ -159,7 +159,19 @@ surfaceScalarField phi
  );
 #endif
 
-
+Info<< "Generating interstitial face flux field phiByVoidfraction\n" << endl;
+surfaceScalarField phiByVoidfraction
+(
+ IOobject
+ (
+    "phiByVoidfraction",
+    runTime.timeName(),
+    mesh,
+    IOobject::NO_READ,
+    IOobject::NO_WRITE
+ ),
+ linearInterpolate(U) & mesh.Sf()
+);
 
     label pRefCell = 0;
     scalar pRefValue = 0.0;

applications/utilities/cfdemPostproc/Make/options

@@ -1,15 +1,18 @@
+sinclude $(GENERAL_RULES)/mplib$(WM_MPLIB)
 include $(CFDEM_ADD_LIBS_DIR)/$(CFDEM_ADD_LIBS_NAME)
 
 PFLAGS+= -DCFDEMWMPROJECTVERSION="$(CFDEM_WM_PROJECT_VERSION)"
 
 EXE_INC = \
      $(PFLAGS) \
-    $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
+     $(PINC) \
+     $(CFDEM_ADD_INCOMPTURBMOD_PATHS) \
     -I$(LIB_SRC)/transportModels \
     -I$(LIB_SRC)/transportModels/incompressible/singlePhaseTransportModel \
     -I$(LIB_SRC)/finiteVolume/lnInclude \
     -I$(CFDEM_SRC_DIR)/lagrangian/cfdemParticle/lnInclude \
     -I$(LIB_SRC)/meshTools/lnInclude \
+    -I$(CFDEM_LIGGGHTS_SRC_DIR)
 
 
 EXE_LIBS = \

applications/utilities/cfdemPostproc/cfdemPostproc.C

@@ -71,14 +71,14 @@ int main(int argc, char *argv[])
     int DEM_dump_Interval=1000;
     particleCloud.reAllocArrays();
 
-    double **positions_;
-    double **velocities_;
-    double **radii_;
-    double **voidfractions_;
-    double **particleWeights_;
-    double **particleVolumes_;
-    double **particleV_;
-    double **cellIDs_;
+    double **positions_(NULL);
+    double **velocities_(NULL);
+    double **radii_(NULL);
+    double **voidfractions_(NULL);
+    double **particleWeights_(NULL);
+    double **particleVolumes_(NULL);
+    double **particleV_(NULL);
+    double **cellIDs_(NULL);
     
     particleCloud.dataExchangeM().allocateArray(positions_,0.,3);
     particleCloud.dataExchangeM().allocateArray(velocities_,0.,3);
@@ -114,8 +114,11 @@ int main(int argc, char *argv[])
         particleCloud.setPos(positions_);
 
         particleCloud.voidFractionM().setvoidFraction(NULL,voidfractions_,particleWeights_,particleVolumes_,particleV_);
-
-        voidfraction.internalField() = particleCloud.voidFractionM().voidFractionInterp();
+        #if defined(versionv1612plus) || defined(version40) 
+            voidfraction = particleCloud.voidFractionM().voidFractionInterp();
+        #else
+            voidfraction.internalField() = particleCloud.voidFractionM().voidFractionInterp();
+        #endif
         voidfraction.correctBoundaryConditions();
 
         particleCloud.averagingM().setVectorAverage

doc/CFDEMcoupling_Manual.html

@@ -1,245 +0,0 @@
-<HTML>
-<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> 
-</CENTER>
-
-
-
-
-
-
-
-
-<HR>
-
-<H2><CENTER>CFDEMcoupling Documentation 
-</CENTER></H2>
-<HR>
-
-<CENTER><IMG SRC = "Portfolio_CFDEMcoupling.png">
-</CENTER>
-<HR>
-
-<H3>1. Contents 
-</H3>
-<P>The CFDEMcoupling documentation is organized into the following sections. If you find any errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so the CFDEMcoupling documentation can be improved.
-</P>
-1.1 <A HREF = "#1_1">About CFDEMcoupling</A><BR>
-1.2 <A HREF = "#1_2">Installation</A><BR>
-1.3 <A HREF = "#1_3">Tutorials</A><BR>
-1.4 <A HREF = "#1_4">couplingProperties dictionary</A><BR>
-1.5 <A HREF = "#1_5">liggghtsCommands dictionary</A><BR>
-1.6 <A HREF = "#cmd_5">Models and solvers</A> <BR>
-
-<HR>
-
-<A NAME = "1_1"></A><H4>1.1 About CFDEMcoupling 
-</H4>
-<P>CFDEM coupling provides an open source parallel coupled CFD-DEM framework combining the strengths of <A HREF = "http://www.cfdem.com">LIGGGHTS</A> DEM code and the Open Source CFD package <A HREF = "http://www.openfoam.com">OpenFOAM(R)(*)</A>. The CFDEMcoupling toolbox allows to expand standard CFD solvers of <A HREF = "http://www.openfoam.com">OpenFOAM(R)(*)</A> to include a coupling to the DEM code <A HREF = "http://www.cfdem.com">LIGGGHTS</A>. In this toolbox the particle representation within the CFD solver is organized by "cloud" classes. Key functionalities are organised in sub-models (e.g. force models, data exchange models, etc.) which can easily be selected and combined by dictionary settings.
-</P>
-<P>The coupled solvers run fully parallel on distributed-memory clusters. Features are:
-</P>
-<UL><LI>its modular approach allows users to easily implement new models 
-
-<LI>its MPI parallelization enables to use it for large scale problems 
-
-<LI>the <A HREF = "http://www.cfdem.com">forum</A> on CFD-DEM gives the possibility to exchange with other users / developers 
-
-<LI>the use of GIT allows to easily update to the latest version 
-
-<LI>basic documentation is provided 
-
-
-</UL>
-<P>The file structure:
-</P>
-<UL><LI><I>src</I> directory including the source files of the coupling toolbox and models 
-
-<LI><I>applications</I> directory including the solver files for coupled CFD-DEM simulations 
-
-<LI><I>doc</I> directory including the documentation of CFDEMcoupling 
-
-<LI><I>tutorials</I> directory including basic tutorial cases showing the functionality  
-
-
-</UL>
-<P>Details on installation are given on the <A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> .
-The functionality of this CFD-DEM framework is described via <A HREF = "#_1_2">tutorial cases</A> showing how to use different solvers and models.
-</P>
-<P>CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling.
-</P>
-<P>CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL).
-</P>
-<P>Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012
-</P>
-<P>This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012
-</P>
-<HR>
-
-<P>(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM®  and OpenCFD®  trade marks.
-</P>
-<HR>
-
-<A NAME = "1_2"></A><H4>1.2 Installation 
-</H4>
-<P>Please follow the installation routine provided at www.cfdem.com.
-In order to get the latest code version, please use the git repository at http://github.com (<A HREF = "githubAccess_public.html">githubAccess</A>). 
-</P>
-<HR>
-
-<A NAME = "1_3"></A><H4>1.3 Tutorials 
-</H4>
-<P><B>General:</B>
-</P>
-<P>Each solver of the CFDEMcoupling comes with at least one tutorial example, showing its functionality and correct usage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization).
-</P>
-<P><B>Location:</B>
-</P>
-<P>The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which can be reached by typing "cfdemTut"
-</P>
-<P><B>Structure:</B>
-</P>
-<P>Each case is structured in a directory called "CFD" covering the CFD relevant settings and data, and a dirctory called "DEM" covering the DEM relevant settings and data. This allows to easily expand a pure CFD or DEM simulation case to a coupled case.
-</P>
-<P><B>Usage:</B>
-</P>
-<P>Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell script, executed by typing "./Allrun.sh". The successful run of the script might need some third party software (e.g. octave, evince, etc.).
-</P>
-<P><B>Settings:</B>
-</P>
-<P>The main settings of a simulation are done via dictionaries:
-</P>
-<P>The DEM setup of each case is defined by a <A HREF = "http://www.cfdem.com">LIGGGHTS</A> input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the <A HREF = "http://www.cfdem.com">LIGGGHTS</A> setup, please have a look at the <A HREF = "http://www.cfdem.com">LIGGGHTS</A> manual.
-</P>
-<P>Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in <A HREF = "http://www.openfoam.com">OpenFOAM(R)(*)</A> documentations (www.openFoam.com)(*).
-</P>
-<P>Settings of the coupling routines are defined in $caseDir/CFD/constant/<A HREF = "#1_3">couplingProperies</A> (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/<A HREF = "#1_3">liggghtsCommands</A> (allows to execute a LIGGGHTS command during a coupled simulation).
-</P>
-<HR>
-
-<A NAME = "1_4"></A><H4>1.4 "couplingProperties" dictionary 
-</H4>
-<P><B>General:</B>
-</P>
-<P>In the "couplingProperties" dictionary the setup of the coupling routines of the CFD-DEM simulation are defined.
-</P>
-<P><B>Location:</B> $caseDir/CFD/constant
-</P>
-<P><B>Structure:</B>
-</P>
-<P>The dictionary is divided into two parts, "sub-models & settings" and "sub-model properties".
-</P>
-<P>In "sub-models & settings" the following routines must be specified:
-</P>
-<UL><LI>modelType 
-
-<LI>couplingInterval 
-
-<LI>voidFractionModel 
-
-<LI>locateModel 
-
-<LI>meshMotionModel 
-
-<LI>regionModel 
-
-<LI>IOModel 
-
-<LI>dataExchangeModel 
-
-<LI>averagingModel 
-
-<LI>forceModels 
-
-<LI>momCoupleModels 
-
-<LI>turbulenceModelType 
-
-
-</UL>
-<P>In "sub-model properties" sub-dictionaries might be defined to specify model specific parameters.
-</P>
-<P><B>Settings:</B>
-</P>
-<P>Reasonable example settings for the "couplingProperties" dictionary are given in the tutorial cases.
-</P>
-<PRE>modelType 
-</PRE>
-<P>"modelType" refers to the formulation of the equations to be solved. Choose "A", "B" or "Bfull", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM. "A" requires the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". "Bfull" refers to model type I.
-</P>
-<PRE>couplingInterval 
-</PRE>
-<P>The coupling interval determines the time passing between two CFD-DEM data exchanges.
-</P>
-<P>A useful procedure would be:
-1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem.
-2) Set the "couplingInterval", which refers to the DEM timesteps. Depending on the problem you will need to have a close (small couplingInterval) or loose coupling.
-3) Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!".
-</P>
-<P>Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s.
-</P>
-<HR>
-
-<H4><A NAME = "1_5"></A>1.5 "liggghtsCommands" dictionary 
-</H4>
-<P><B>General:</B>
-</P>
-<P>In the "liggghtsCommands" dictionary liggghts commands being executed during a coupled CFD-DEM simulation are specified.
-</P>
-<P><B>Location:</B> $caseDir/CFD/constant
-</P>
-<P><B>Structure:</B>
-</P>
-<P>The dictionary is divided into two parts, first a list of "liggghtsCommandModels" is defined, then the settings for each model must be specified.
-</P>
-<P><B>Settings:</B>
-</P>
-<P>Reasonable example settings for the "liggghtsCommands" dictionary are given in the tutorial cases.
-</P>
-<HR>
-
-<H4><A NAME = "cmd_5"></A><A NAME = "comm"></A>1.6 Models/Solvers 
-</H4>
-<P>This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate
-listing below of styles within certain commands.
-</P>
-<DIV ALIGN=center><TABLE  BORDER=1 >
-<TR ALIGN="center"><TD ><A HREF = "IOModel.html">IOModel</A></TD><TD ><A HREF = "IOModel_basicIO.html">IOModel_basicIO</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "IOModel_noIO.html">IOModel_noIO</A></TD><TD ><A HREF = "IOModel_sophIO.html">IOModel_sophIO</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "IOModel_trackIO.html">IOModel_trackIO</A></TD><TD ><A HREF = "averagingModel.html">averagingModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "averagingModel_dense.html">averagingModel_dense</A></TD><TD ><A HREF = "averagingModel_dilute.html">averagingModel_dilute</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "cfdemSolverIB.html">cfdemSolverIB</A></TD><TD ><A HREF = "cfdemSolverPiso.html">cfdemSolverPiso</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "cfdemSolverPisoScalar.html">cfdemSolverPisoScalar</A></TD><TD ><A HREF = "clockModel.html">clockModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "clockModel_noClock.html">clockModel_noClock</A></TD><TD ><A HREF = "clockModel_standardClock.html">clockModel_standardClock</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "dataExchangeModel.html">dataExchangeModel</A></TD><TD ><A HREF = "dataExchangeModel_noDataExchange.html">dataExchangeModel_noDataExchange</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "dataExchangeModel_oneWayVTK.html">dataExchangeModel_oneWayVTK</A></TD><TD ><A HREF = "dataExchangeModel_twoWayFiles.html">dataExchangeModel_twoWayFiles</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "dataExchangeModel_twoWayMPI.html">dataExchangeModel_twoWayMPI</A></TD><TD ><A HREF = "forceModel.html">forceModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_Archimedes.html">forceModel_Archimedes</A></TD><TD ><A HREF = "forceModel_ArchimedesIB.html">forceModel_ArchimedesIB</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_DiFeliceDrag.html">forceModel_DiFeliceDrag</A></TD><TD ><A HREF = "forceModel_GidaspowDrag.html">forceModel_GidaspowDrag</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_KochHillDrag.html">forceModel_KochHillDrag</A></TD><TD ><A HREF = "forceModel_LaEuScalarTemp.html">forceModel_LaEuScalarTemp</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_MeiLift.html">forceModel_MeiLift</A></TD><TD ><A HREF = "forceModel_SchillerNaumannDrag.html">forceModel_SchillerNaumannDrag</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_ShirgaonkarIB.html">forceModel_ShirgaonkarIB</A></TD><TD ><A HREF = "forceModel_fieldStore.html">forceModel_fieldStore</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_fieldTimeAverage.html">forceModel_fieldTimeAverage</A></TD><TD ><A HREF = "forceModel_gradPForce.html">forceModel_gradPForce</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_noDrag.html">forceModel_noDrag</A></TD><TD ><A HREF = "forceModel_particleCellVolume.html">forceModel_particleCellVolume</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_particleVolume.html">forceModel_particleVolume</A></TD><TD ><A HREF = "forceModel_scalarGeneralExchange.html">forceModel_scalarGeneralExchange</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_virtualMassForce.html">forceModel_virtualMassForce</A></TD><TD ><A HREF = "forceModel_viscForce.html">forceModel_viscForce</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceModel_volWeightedAverage.html">forceModel_volWeightedAverage</A></TD><TD ><A HREF = "forceSubModel.html">forceSubModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "forceSubModel_ImEx.html">forceSubModel_ImEx</A></TD><TD ><A HREF = "liggghtsCommandModel.html">liggghtsCommandModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "liggghtsCommandModel_execute.html">liggghtsCommandModel_execute</A></TD><TD ><A HREF = "liggghtsCommandModel_readLiggghtsData.html">liggghtsCommandModel_readLiggghtsData</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "liggghtsCommandModel_runLiggghts.html">liggghtsCommandModel_runLiggghts</A></TD><TD ><A HREF = "liggghtsCommandModel_writeLiggghts.html">liggghtsCommandModel_writeLiggghts</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "locateModel.html">locateModel</A></TD><TD ><A HREF = "locateModel_engineSearch.html">locateModel_engineSearch</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "locateModel_engineSearchIB.html">locateModel_engineSearchIB</A></TD><TD ><A HREF = "locateModel_standardSearch.html">locateModel_standardSearch</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "meshMotionModel.html">meshMotionModel</A></TD><TD ><A HREF = "meshMotionModel_noMeshMotion.html">meshMotionModel_noMeshMotion</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "momCoupleModel.html">momCoupleModel</A></TD><TD ><A HREF = "momCoupleModel_explicitCouple.html">momCoupleModel_explicitCouple</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "momCoupleModel_implicitCouple.html">momCoupleModel_implicitCouple</A></TD><TD ><A HREF = "momCoupleModel_noCouple.html">momCoupleModel_noCouple</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "probeModel.html">probeModel</A></TD><TD ><A HREF = "probeModel_noProbe.html">probeModel_noProbe</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "probeModel_particleProbe.html">probeModel_particleProbe</A></TD><TD ><A HREF = "regionModel.html">regionModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "regionModel_allRegion.html">regionModel_allRegion</A></TD><TD ><A HREF = "scalarTransportModel.html">scalarTransportModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "smoothingModel.html">smoothingModel</A></TD><TD ><A HREF = "smoothingModel_constDiffSmoothing.html">smoothingModel_constDiffSmoothing</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "smoothingModel_noSmoothing.html">smoothingModel_noSmoothing</A></TD><TD ><A HREF = "voidFractionModel.html">voidfractionModel</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "voidFractionModel_GaussVoidFraction.html">voidfractionModel_GaussVoidFraction</A></TD><TD ><A HREF = "voidFractionModel_IBVoidFraction.html">voidfractionModel_IBVoidFraction</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "voidFractionModel_bigParticleVoidFraction.html">voidfractionModel_bigParticleVoidFraction</A></TD><TD ><A HREF = "voidFractionModel_centreVoidFraction.html">voidfractionModel_centreVoidFraction</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "voidFractionModel_dividedVoidFraction.html">voidfractionModel_dividedVoidFraction</A></TD><TD ><A HREF = "voidFractionModel_noVoidFraction.html">voidfractionModel_noVoidFractionVoidFraction</A></TD></TR>
-<TR ALIGN="center"><TD ><A HREF = "voidFractionModel_trilinearVoidFraction.html">voidfractionModel_trilinearVoidFraction</A> 
-</TD></TR></TABLE></DIV>
-
-</HTML>

doc/CFDEMcoupling_Manual.html

@@ -0,0 +1 @@
+_build/html/CFDEMcoupling_Manual.html

doc/CFDEMcoupling_Manual.txt

@@ -0,0 +1,262 @@
+"CFDEM(R)project WWW Site"_lws :c
+
+:line
+CFDEM(R)coupling Documentation :h2,c
+:line
+:c,image(Portfolio_CFDEMcoupling.png)
+:line
+
+:link(lws,http://www.cfdem.com)
+:link(lc,CFDEMcoupling_Manual.html#comm)
+:link(of,http://www.openfoam.com)
+:link(lig,http://www.cfdem.com)
+
+1. Contents :h3
+
+The CFDEM(R)coupling documentation is organized into the following sections. If you find any errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so the CFDEM(R)coupling documentation can be improved.
+
+1.1 "About CFDEM(R)coupling"_#1_1
+1.2 "Installation"_#1_2
+1.3 "Tutorials"_#1_3
+1.4 "couplingProperties dictionary"_#1_4
+1.5 "liggghtsCommands dictionary"_#1_5
+1.6 "Models and solvers"_#cmd_5 :all(b)
+
+:line
+
+1.1 About CFDEM(R)coupling :link(1_1),h4
+
+CFDEM(R)coupling provides an open source parallel coupled CFD-DEM framework combining the strengths of "LIGGGHTS(R)"_lig DEM code and the Open Source CFD package "OpenFOAM(R)(*)"_of. The CFDEM(R)coupling toolbox allows to expand standard CFD solvers of "OpenFOAM(R)(*)"_of to include a coupling to the DEM code "LIGGGHTS(R)"_lig. In this toolbox the particle representation within the CFD solver is organized by "cloud" classes. Key functionalities are organised in sub-models (e.g. force models, data exchange models, etc.) which can easily be selected and combined by dictionary settings.
+
+The coupled solvers run fully parallel on distributed-memory clusters. Features are:
+
+its modular approach allows users to easily implement new models :ulb,l
+its MPI parallelization enables to use it for large scale problems :l
+the "forum"_lws on CFD-DEM gives the possibility to exchange with other users / developers :l
+the use of GIT allows to easily update to the latest version :l
+basic documentation is provided :l
+:ule
+
+The file structure:
+
+{src} directory including the source files of the coupling toolbox and models :ulb,l
+{applications} directory including the solver files for coupled CFD-DEM simulations :l
+{doc} directory including the documentation of CFDEM(R)coupling :l
+{tutorials} directory including basic tutorial cases showing the functionality  :l
+:ule
+
+Details on installation are given on the "CFDEM(R)project WWW Site"_lws .
+The functionality of this CFD-DEM framework is described via "tutorial cases"_#_1_2 showing how to use different solvers and models.
+
+CFDEM(R)coupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling.
+
+CFDEM(R)coupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL).
+
+Core development of CFDEM(R)coupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012
+
+This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012
+
+:line
+(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM®  and OpenCFD®  trade marks.
+
+:line
+
+1.2 Installation :link(1_2),h4
+
+Please follow the installation routine provided at www.cfdem.com.
+In order to get the latest code version, please use the git repository at http://github.com ("githubAccess"_githubAccess_public.html). 
+
+:line
+
+1.3 Tutorials :link(1_3),h4
+
+[General:]
+
+Each solver of the CFDEM(R)coupling comes with at least one tutorial example, showing its functionality and correct usage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization).
+
+[Location:]
+
+The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which can be reached by typing "cfdemTut"
+
+[Structure:]
+
+Each case is structured in a directory called "CFD" covering the CFD relevant settings and data, and a dirctory called "DEM" covering the DEM relevant settings and data. This allows to easily expand a pure CFD or DEM simulation case to a coupled case.
+
+[Usage:]
+
+Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell script, executed by typing "./Allrun.sh". The successful run of the script might need some third party software (e.g. octave, evince, etc.).
+
+[Settings:]
+
+The main settings of a simulation are done via dictionaries:
+
+The DEM setup of each case is defined by a "LIGGGHTS(R)"_lig input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS(R)"_lig setup, please have a look at the "LIGGGHTS(R)"_lig manual.
+
+Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in "OpenFOAM(R)(*)"_of documentations (www.openFoam.com)(*).
+
+Settings of the coupling routines are defined in $caseDir/CFD/constant/"couplingProperies"_#1_3 (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/"liggghtsCommands"_#1_3 (allows to execute a LIGGGHTS(R) command during a coupled simulation).
+
+:line
+
+1.4 "couplingProperties" dictionary :link(1_4),h4
+
+[General:]
+
+In the "couplingProperties" dictionary the setup of the coupling routines of the CFD-DEM simulation are defined.
+
+[Location:] $caseDir/CFD/constant
+
+[Structure:]
+
+The dictionary is divided into two parts, "sub-models & settings" and "sub-model properties".
+
+In "sub-models & settings" the following routines must be specified:
+
+modelType :ulb,l
+couplingInterval :l
+voidFractionModel :l
+locateModel :l
+meshMotionModel :l
+regionModel :l
+IOModel :l
+dataExchangeModel :l
+averagingModel :l
+forceModels :l
+momCoupleModels :l
+turbulenceModelType :l
+:ule
+
+In "sub-model properties" sub-dictionaries might be defined to specify model specific parameters.
+
+[Settings:]
+
+Reasonable example settings for the "couplingProperties" dictionary are given in the tutorial cases.
+
+modelType :pre
+
+"modelType" refers to the formulation of the equations to be solved. Choose "A", "B" or "Bfull", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM. "A" requires the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". "Bfull" refers to model type I, "A" refers to model type II and "B" refers to type III in the nomenclature used by Zhou et al.
+
+couplingInterval :pre
+
+The coupling interval determines the time passing between two CFD-DEM data exchanges.
+
+A useful procedure would be:
+1) Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem.
+2) Set the "couplingInterval", which refers to the DEM timesteps. Depending on the problem you will need to have a close (small couplingInterval) or loose coupling.
+3) Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!".
+
+Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s.
+
+:line
+
+1.5 "liggghtsCommands" dictionary :h4,link(1_5)
+
+[General:]
+
+In the "liggghtsCommands" dictionary LIGGGHTS(R) commands being executed during a coupled CFD-DEM simulation are specified.
+
+[Location:] $caseDir/CFD/constant
+
+[Structure:]
+
+The dictionary is divided into two parts, first a list of "liggghtsCommandModels" is defined, then the settings for each model must be specified.
+
+[Settings:]
+
+Reasonable example settings for the "liggghtsCommands" dictionary are given in the tutorial cases.
+
+:line
+
+
+
+
+
+
+
+
+1.6 Models/Solvers :h4,link(cmd_5),link(comm)
+
+This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate
+listing below of styles within certain commands.
+
+
+"IOModel"_IOModel.html,
+"IOModel_basicIO"_IOModel_basicIO.html,
+"IOModel_noIO"_IOModel_noIO.html,
+"IOModel_sophIO"_IOModel_sophIO.html,
+"IOModel_trackIO"_IOModel_trackIO.html,
+"averagingModel"_averagingModel.html,
+"averagingModel_dense"_averagingModel_dense.html,
+"averagingModel_dilute"_averagingModel_dilute.html,
+"cfdemSolverIB"_cfdemSolverIB.html,
+"cfdemSolverPiso"_cfdemSolverPiso.html,
+"cfdemSolverPisoSTM"_cfdemSolverPisoSTM.html,
+"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html,
+"clockModel"_clockModel.html,
+"clockModel_noClock"_clockModel_noClock.html,
+"clockModel_standardClock"_clockModel_standardClock.html,
+"couple/cfd"_fix_couple_cfd.html,
+"couple/cfd/force"_fix_couple_cfd_force.html,
+"couple/cfd/force/implicit"_fix_couple_cfd_force_implicit.html,
+"dataExchangeModel"_dataExchangeModel.html,
+"dataExchangeModel_noDataExchange"_dataExchangeModel_noDataExchange.html,
+"dataExchangeModel_oneWayVTK"_dataExchangeModel_oneWayVTK.html,
+"dataExchangeModel_twoWayFiles"_dataExchangeModel_twoWayFiles.html,
+"dataExchangeModel_twoWayMPI"_dataExchangeModel_twoWayMPI.html,
+"forceModel"_forceModel.html,
+"forceModel_Archimedes"_forceModel_Archimedes.html,
+"forceModel_ArchimedesIB"_forceModel_ArchimedesIB.html,
+"forceModel_DiFeliceDrag"_forceModel_DiFeliceDrag.html,
+"forceModel_GidaspowDrag"_forceModel_GidaspowDrag.html,
+"forceModel_KochHillDrag"_forceModel_KochHillDrag.html,
+"forceModel_LaEuScalarTemp"_forceModel_LaEuScalarTemp.html,
+"forceModel_MeiLift"_forceModel_MeiLift.html,
+"forceModel_SchillerNaumannDrag"_forceModel_SchillerNaumannDrag.html,
+"forceModel_ShirgaonkarIB"_forceModel_ShirgaonkarIB.html,
+"forceModel_checkCouplingInterval"_forceModel_checkCouplingInterval.html,
+"forceModel_fieldStore"_forceModel_fieldStore.html,
+"forceModel_fieldTimeAverage"_forceModel_fieldTimeAverage.html,
+"forceModel_gradPForce"_forceModel_gradPForce.html,
+"forceModel_noDrag"_forceModel_noDrag.html,
+"forceModel_particleCellVolume"_forceModel_particleCellVolume.html,
+"forceModel_particleVolume"_forceModel_particleVolume.html,
+"forceModel_scalarGeneralExchange"_forceModel_scalarGeneralExchange.html,
+"forceModel_virtualMassForce"_forceModel_virtualMassForce.html,
+"forceModel_viscForce"_forceModel_viscForce.html,
+"forceModel_volWeightedAverage"_forceModel_volWeightedAverage.html,
+"forceSubModel"_forceSubModel.html,
+"forceSubModel_ImEx"_forceSubModel_ImEx.html,
+"liggghtsCommandModel"_liggghtsCommandModel.html,
+"liggghtsCommandModel_execute"_liggghtsCommandModel_execute.html,
+"liggghtsCommandModel_readLiggghtsData"_liggghtsCommandModel_readLiggghtsData.html,
+"liggghtsCommandModel_runLiggghts"_liggghtsCommandModel_runLiggghts.html,
+"liggghtsCommandModel_setDEMGravity"_liggghtsCommandModel_setDEMGravity.html,
+"liggghtsCommandModel_writeLiggghts"_liggghtsCommandModel_writeLiggghts.html,
+"locateModel"_locateModel.html,
+"locateModel_engineSearch"_locateModel_engineSearch.html,
+"locateModel_engineSearchIB"_locateModel_engineSearchIB.html,
+"locateModel_standardSearch"_locateModel_standardSearch.html,
+"meshMotionModel"_meshMotionModel.html,
+"meshMotionModel_noMeshMotion"_meshMotionModel_noMeshMotion.html,
+"momCoupleModel"_momCoupleModel.html,
+"momCoupleModel_explicitCouple"_momCoupleModel_explicitCouple.html,
+"momCoupleModel_implicitCouple"_momCoupleModel_implicitCouple.html,
+"momCoupleModel_noCouple"_momCoupleModel_noCouple.html,
+"probeModel"_probeModel.html,
+"probeModel_noProbe"_probeModel_noProbe.html,
+"probeModel_particleProbe"_probeModel_particleProbe.html,
+"regionModel"_regionModel.html,
+"regionModel_allRegion"_regionModel_allRegion.html,
+"scalarTransportModel"_scalarTransportModel.html,
+"scalarTransportModel_generalManual"_scalarTransportModel_generalManual.html,
+"smoothingModel"_smoothingModel.html,
+"smoothingModel_constDiffSmoothing"_smoothingModel_constDiffSmoothing.html,
+"smoothingModel_noSmoothing"_smoothingModel_noSmoothing.html,
+"voidfractionModel"_voidFractionModel.html,
+"voidfractionModel_GaussVoidFraction"_voidFractionModel_GaussVoidFraction.html,
+"voidfractionModel_IBVoidFraction"_voidFractionModel_IBVoidFraction.html,
+"voidfractionModel_bigParticleVoidFraction"_voidFractionModel_bigParticleVoidFraction.html,
+"voidfractionModel_centreVoidFraction"_voidFractionModel_centreVoidFraction.html,
+"voidfractionModel_dividedVoidFraction"_voidFractionModel_dividedVoidFraction.html,
+"voidfractionModel_noVoidFractionVoidFraction"_voidFractionModel_noVoidFraction.html,
+"voidfractionModel_trilinearVoidFraction"_voidFractionModel_trilinearVoidFraction.html :tb(c=2,ea=c)

doc/IOModel.html

@@ -1,40 +0,0 @@
-<HTML>
-<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A> 
-</CENTER>
-
-
-
-
-<HR>
-
-<H3>IOModel command 
-</H3>
-<P><B>Syntax:</B>
-</P>
-<P>Defined in couplingProperties dictionary.
-</P>
-<PRE>IOModel "model"; 
-</PRE>
-<UL><LI>model = name of IO-model to be applied 
-</UL>
-<P><B>Examples:</B>
-</P>
-<P>IOModel "off";
-</P>
-<P>Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation.
-</P>
-<P><B>Description:</B>
-</P>
-<P>The IO-model is the base class to write data (e.g. particle properties) to files.
-</P>
-<P><B>Restrictions:</B>
-</P>
-<P>none.
-</P>
-<P><B>Related commands:</B>
-</P>
-<P>Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation.
-</P>
-<P><B>Default:</B> none.
-</P>
-</HTML>

doc/IOModel.txt

@@ -0,0 +1,36 @@
+"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
+
+:link(lws,http://www.cfdem.com)
+:link(lc,CFDEMcoupling_Manual.html#comm)
+
+:line
+
+IOModel command :h3
+
+[Syntax:]
+
+Defined in couplingProperties dictionary.
+
+IOModel "model"; :pre
+
+model = name of IO-model to be applied :ul
+
+[Examples:]
+
+IOModel "off";
+
+Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation.
+
+[Description:]
+
+The IO-model is the base class to write data (e.g. particle properties) to files.
+
+[Restrictions:]
+
+none.
+
+[Related commands:]
+
+Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation.
+
+[Default:] none.

doc/IOModel_basicIO.html

@@ -1,32 +0,0 @@
-<HTML>
-<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A> 
-</CENTER>
-
-
-
-
-<HR>
-
-<H3>IOModel_basicIO command 
-</H3>
-<P><B>Syntax:</B>
-</P>
-<P>Defined in couplingProperties dictionary.
-</P>
-<PRE>IOModel "basicIO"; 
-</PRE>
-<P><B>Examples:</B>
-</P>
-<PRE>IOModel "basicIO"; 
-</PRE>
-<P><B>Description:</B>
-</P>
-<P>The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation.
-</P>
-<P><B>Restrictions:</B> None.
-</P>
-<P><B>Related commands:</B>
-</P>
-<P><A HREF = "IOModel.html">IOModel</A>
-</P>
-</HTML>

doc/IOModel_basicIO.txt

@@ -0,0 +1,29 @@
+"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
+
+:link(lws,http://www.cfdem.com)
+:link(lc,CFDEMcoupling_Manual.html#comm)
+
+:line
+
+IOModel_basicIO command :h3
+
+[Syntax:]
+
+Defined in couplingProperties dictionary.
+
+IOModel "basicIO"; :pre
+
+[Examples:]
+
+IOModel "basicIO"; :pre
+
+[Description:]
+
+The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation.
+
+[Restrictions:] None.
+
+[Related commands:]
+
+"IOModel"_IOModel.html
+

doc/IOModel_noIO.html

@@ -1,32 +0,0 @@
-<HTML>
-<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A> 
-</CENTER>
-
-
-
-
-<HR>
-
-<H3>IOModel_noIO command 
-</H3>
-<P><B>Syntax:</B>
-</P>
-<P>Defined in couplingProperties dictionary.
-</P>
-<PRE>IOModel "off"; 
-</PRE>
-<P><B>Examples:</B>
-</P>
-<PRE>IOModel "off"; 
-</PRE>
-<P><B>Description:</B>
-</P>
-<P>The noIO-model is a dummy IO model.
-</P>
-<P><B>Restrictions:</B> None.
-</P>
-<P><B>Related commands:</B>
-</P>
-<P><A HREF = "IOModel.html">IOModel</A>
-</P>
-</HTML>

doc/IOModel_noIO.txt

@@ -0,0 +1,29 @@
+"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
+
+:link(lws,http://www.cfdem.com)
+:link(lc,CFDEMcoupling_Manual.html#comm)
+
+:line
+
+IOModel_noIO command :h3
+
+[Syntax:]
+
+Defined in couplingProperties dictionary.
+
+IOModel "off"; :pre
+
+[Examples:]
+
+IOModel "off"; :pre
+
+[Description:]
+
+The noIO-model is a dummy IO model.
+
+[Restrictions:] None.
+
+[Related commands:]
+
+"IOModel"_IOModel.html
+

doc/IOModel_sophIO.html

@@ -1,32 +0,0 @@
-<HTML>
-<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A> 
-</CENTER>
-
-
-
-
-<HR>
-
-<H3>IOModel_sophIO command 
-</H3>
-<P><B>Syntax:</B>
-</P>
-<P>Defined in couplingProperties dictionary.
-</P>
-<PRE>IOModel "sophIO"; 
-</PRE>
-<P><B>Examples:</B>
-</P>
-<PRE>IOModel "sophIO"; 
-</PRE>
-<P><B>Description:</B>
-</P>
-<P>The sophIO-model is based on basicIO model and additionally writes voidfraction, implicit forces, explicit forces. Data is written every write time of the CFD simulation.
-</P>
-<P><B>Restrictions:</B> None.
-</P>
-<P><B>Related commands:</B>
-</P>
-<P><A HREF = "IOModel.html">IOModel</A>
-</P>
-</HTML>

doc/IOModel_sophIO.txt

@@ -0,0 +1,29 @@
+"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
+
+:link(lws,http://www.cfdem.com)
+:link(lc,CFDEMcoupling_Manual.html#comm)
+
+:line
+
+IOModel_sophIO command :h3
+
+[Syntax:]
+
+Defined in couplingProperties dictionary.
+
+IOModel "sophIO"; :pre
+
+[Examples:]
+
+IOModel "sophIO"; :pre
+
+[Description:]
+
+The sophIO-model is based on basicIO model and additionally writes voidfraction, implicit forces, explicit forces. Data is written every write time of the CFD simulation.
+
+[Restrictions:] None.
+
+[Related commands:]
+
+"IOModel"_IOModel.html
+

doc/IOModel_trackIO.html

@@ -1,32 +0,0 @@
-<HTML>
-<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A> 
-</CENTER>
-
-
-
-
-<HR>
-
-<H3>IOModel_trackIO command 
-</H3>
-<P><B>Syntax:</B>
-</P>
-<P>Defined in couplingProperties dictionary.
-</P>
-<PRE>IOModel "trackIO"; 
-</PRE>
-<P><B>Examples:</B>
-</P>
-<PRE>IOModel "trackIO"; 
-</PRE>
-<P><B>Description:</B>
-</P>
-<P>The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file.
-</P>
-<P><B>Restrictions:</B> None.
-</P>
-<P><B>Related commands:</B>
-</P>
-<P><A HREF = "IOModel.html">IOModel</A>
-</P>
-</HTML>

doc/IOModel_trackIO.txt

@@ -0,0 +1,29 @@
+"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
+
+:link(lws,http://www.cfdem.com)
+:link(lc,CFDEMcoupling_Manual.html#comm)
+
+:line
+
+IOModel_trackIO command :h3
+
+[Syntax:]
+
+Defined in couplingProperties dictionary.
+
+IOModel "trackIO"; :pre
+
+[Examples:]
+
+IOModel "trackIO"; :pre
+
+[Description:]
+
+The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file.
+
+[Restrictions:] None.
+
+[Related commands:]
+
+"IOModel"_IOModel.html
+