release on 2012-07-17_16-13-20

README

@@ -0,0 +1,82 @@
+/*---------------------------------------------------------------------------*\
+    CFDEMcoupling - Open Source CFD-DEM coupling
+
+    CFDEMcoupling is part of the CFDEMproject
+    www.cfdem.com
+                                Christoph Goniva, christoph.goniva@cfdem.com
+                                Copyright 2009-2012 JKU Linz
+                                Copyright 2012-     DCS Computing GmbH, Linz
+-------------------------------------------------------------------------------
+License
+    This file is part of CFDEMcoupling.
+
+    CFDEMcoupling is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 3 of the License, or (at your
+    option) any later version.
+
+    CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with CFDEMcoupling; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Description
+    This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS
+    and OpenFOAM. Note: this code is not part of OpenFOAM (see DISCLAIMER).
+\*---------------------------------------------------------------------------*/
+
+
+CFDEM coupling provides an open source parallel coupled CFD-DEM framework 
+combining the strengths of LIGGGHTS DEM code and the Open Source 
+CFD package OpenFOAM(R)(*). The CFDEMcoupling toolbox allows to expand 
+standard CFD solvers of OpenFOAM(R)(*) to include a coupling to the DEM 
+code LIGGGHTS. 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
+- its MPI parallelization enables to use it for large scale problems
+- the "forum"_lws on CFD-DEM gives the possibility to exchange with other 
+  users / developers
+- the use of GIT allows to easily update to the latest version
+- basic documentation is provided
+
+The file structure:
+
+- "src" directory including the source files of the coupling toolbox and models
+- "applications" directory including the solver files for coupled CFD-DEM simulations
+- "doc" directory including the documentation of CFDEMcoupling
+- "tutorials" directory including basic tutorial cases showing the functionality
+
+
+
+Details on installation are given on the "www.cfdem.com"
+
+The functionality of this CFD-DEM framwork is described via "tutorial cases" showing 
+how to use different solvers and models.
+
+CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -
+Discrete Element Method (DEM) coupling.
+
+CFDEMcoupling is an open-source code, distributed freely under the terms of the 
+GNU Public License (GPL).
+
+Core development of CFDEMcoupling is done by 
+Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012
+
+
+\*---------------------------------------------------------------------------*/
+(*) "OpenFOAM(R)"_of is a registered trade mark of Silicon Graphics 
+International Corp. This offering is not affiliated, approved or endorsed by 
+Silicon Graphics International Corp., the producer of the OpenFOAM(R) software 
+and owner of the OpenFOAM(R) trademark.
+\*---------------------------------------------------------------------------*/

doc/locateModel_engineSearch.html

@@ -19,7 +19,7 @@ engineProps
     treeSearch switch1;
 } 
 </PRE>
-<UL><LI><I>switch1</I> = names of the finite volume scalar fields to be temporally averaged 
+<UL><LI><I>switch1</I> = switch to use tree search algorithm 
 
 
 </UL>

doc/locateModel_engineSearch.txt

@@ -17,7 +17,7 @@ engineProps
     treeSearch switch1;
 \} :pre
 
-{switch1} = names of the finite volume scalar fields to be temporally averaged :ulb,l
+{switch1} = switch to use tree search algorithm :ulb,l
 :ule
 
 [Examples:]

doc/locateModel_turboEngineSearch.html

@@ -16,13 +16,10 @@
 <PRE>locateModel turboEngine;
 turboEngineProps
 {
-    faceDecomp switch1;
+    treeSearch switch1;
-    treeSearch switch2;
 } 
 </PRE>
-<UL><LI><I>switch1</I> = time to start the averaging (default 0) 
+<UL><LI><I>switch1</I> = switch to use tree search algorithm 
-
-<LI><I>switch2</I> = names of the finite volume scalar fields to be temporally averaged 
 
 
 </UL>
@@ -31,7 +28,6 @@ turboEngineProps
 <PRE>locateModel turboEngine;
 turboEngineProps
 {
-    faceDecomp false;
     treeSearch false;
 } 
 </PRE>

doc/locateModel_turboEngineSearch.txt

@@ -14,12 +14,10 @@ Defined in couplingProperties dictionary.
 locateModel turboEngine;
 turboEngineProps
 \{
-    faceDecomp switch1;
+    treeSearch switch1;
-    treeSearch switch2;
 \} :pre
 
-{switch1} = time to start the averaging (default 0) :ulb,l
+{switch1} = switch to use tree search algorithm :ulb,l
-{switch2} = names of the finite volume scalar fields to be temporally averaged :l
 :ule
 
 [Examples:]
@@ -27,7 +25,6 @@ turboEngineProps
 locateModel turboEngine;
 turboEngineProps
 \{
-    faceDecomp false;
     treeSearch false;
 \} :pre
 

src/lagrangian/cfdemParticle/Make/files

@@ -1,5 +1,6 @@
 cfdemCloud = cfdemCloud
 forceModels = subModels/forceModel
+forceModelsMS = subModels/forceModelMS
 IOModels = subModels/IOModel
 voidFractionModels = subModels/voidFractionModel
 locateModels = subModels/locateModel
@@ -13,23 +14,37 @@ liggghtsCommandModels = subModels/liggghtsCommandModel
 
 $(cfdemCloud)/cfdemCloud.C
 derived/cfdemCloudIB/cfdemCloudIB.C
+derived/cfdemCloudMS/cfdemCloudMS.C
 
 $(forceModels)/forceModel/forceModel.C
 $(forceModels)/forceModel/newForceModel.C
 $(forceModels)/noDrag/noDrag.C
 $(forceModels)/DiFeliceDrag/DiFeliceDrag.C
+$(forceModels)/DiFeliceDragNLift/DiFeliceDragNLift.C
 $(forceModels)/GidaspowDrag/GidaspowDrag.C
 $(forceModels)/SchillerNaumannDrag/SchillerNaumannDrag.C
 $(forceModels)/Archimedes/Archimedes.C
 $(forceModels)/ArchimedesIB/ArchimedesIB.C
 $(forceModels)/interface/interface.C
 $(forceModels)/ShirgaonkarIB/ShirgaonkarIB.C
+$(forceModels)/fieldTimeAverage/fieldTimeAverage.C
+$(forceModels)/fieldBound/fieldBound.C
+$(forceModels)/volWeightedAverage/volWeightedAverage.C
+$(forceModels)/totalMomentumExchange/totalMomentumExchange.C
 $(forceModels)/KochHillDrag/KochHillDrag.C
+$(forceModels)/LaEuScalarLiquid/LaEuScalarLiquid.C
 $(forceModels)/LaEuScalarTemp/LaEuScalarTemp.C
+$(forceModels)/LaEuScalarDust/LaEuScalarDust.C
 $(forceModels)/virtualMassForce/virtualMassForce.C
 $(forceModels)/gradPForce/gradPForce.C
+$(forceModels)/gradULiftForce/gradULiftForce.C
 $(forceModels)/viscForce/viscForce.C
 $(forceModels)/MeiLift/MeiLift.C
+$(forceModels)/KochHillDragNLift/KochHillDragNLift.C
+
+$(forceModelsMS)/forceModelMS/forceModelMS.C
+$(forceModelsMS)/forceModelMS/newForceModelMS.C
+$(forceModelsMS)/DiFeliceDragMS/DiFeliceDragMS.C
 
 $(IOModels)/IOModel/IOModel.C
 $(IOModels)/IOModel/newIOModel.C
@@ -40,6 +55,7 @@ $(voidFractionModels)/voidFractionModel/voidFractionModel.C
 $(voidFractionModels)/voidFractionModel/newVoidFractionModel.C
 $(voidFractionModels)/centreVoidFraction/centreVoidFraction.C
 $(voidFractionModels)/dividedVoidFraction/dividedVoidFraction.C
+$(voidFractionModels)/dividedVoidFractionMS/dividedVoidFractionMS.C
 $(voidFractionModels)/bigParticleVoidFraction/bigParticleVoidFraction.C
 $(voidFractionModels)/GaussVoidFraction/GaussVoidFraction.C
 $(voidFractionModels)/IBVoidFraction/IBVoidFraction.C
@@ -55,6 +71,7 @@ $(locateModels)/engineSearchIB/engineSearchIB.C
 $(meshMotionModels)/meshMotionModel/meshMotionModel.C
 $(meshMotionModels)/meshMotionModel/newMeshMotionModel.C
 $(meshMotionModels)/noMeshMotion/noMeshMotion.C
+$(meshMotionModels)/DEMdrivenMeshMotion/DEMdrivenMeshMotion.C
 
 $(momCoupleModels)/momCoupleModel/momCoupleModel.C
 $(momCoupleModels)/momCoupleModel/newMomCoupleModel.C
@@ -65,6 +82,7 @@ $(momCoupleModels)/noCouple/noCouple.C
 $(regionModels)/regionModel/regionModel.C
 $(regionModels)/regionModel/newRegionModel.C
 $(regionModels)/allRegion/allRegion.C
+$(regionModels)/differentialRegion/differentialRegion.C
 
 $(dataExchangeModels)/dataExchangeModel/dataExchangeModel.C
 $(dataExchangeModels)/dataExchangeModel/newDataExchangeModel.C