+
+The CFDEMcoupling documentation is organized into the following sections. If you find errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so we can improve the CFDEMcoupling documentation. +
+1.1 About CFDEMcouplingCFDEM 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: +
+The file structure: +
+Details on installation are given on the CFDEMproject WWW Site . +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 +
+This documentation was written by Christoph Goniva, DCS Computing GmbH, 2012 +
+(*) 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. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group. +
+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). +
+General: +
+Each solver of the CFDEMcoupling is comes with at least one tutorial example, showing its functionality and correct useage. 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 input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the LIGGGHTS setup, please have a look in the LIGGGHTS 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)(*) documentations (www.openFoam.com)(*). +
+Settings of the coupling routines are defined in $caseDir/CFD/constant/couplingProperies (e.g. force models, data exchange model, etc.) and $caseDir/CFD/constant/liggghtsCommands (allows to execute a LIGGGHTS command during a coupled simulation). +
+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: +
+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 ++
"modelType" refers to the formulation of the equations to be solved. Choose "A" or "B", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their appliccability", JFM. "A" requres the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". +
+couplingInterval ++
The coupling interval determines the time passing between two CFD-DEM data exchanges. +
+A useful procedure would be: +1) Set the DEM TS in the in.xxx 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 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. +
+General: +
+In the "liggghtsCommands" dictionary liggghts 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. +
+This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate +listing below of styles within certain commands. +
+Syntax:
diff --git a/doc/probeModel_noProbe.txt b/doc/probeModel_noProbe.txt index 3fc6a3e0..cf3c9307 100644 --- a/doc/probeModel_noProbe.txt +++ b/doc/probeModel_noProbe.txt @@ -5,7 +5,7 @@ :line -probeModel noProbe command :h3 +probeModel_noProbe command :h3 [Syntax:] diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValueTube/uniformFixedValueTubeFvPatchField.C b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValueTube/uniformFixedValueTubeFvPatchField.C old mode 100644 new mode 100755 diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValueTube/uniformFixedValueTubeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValueTube/uniformFixedValueTubeFvPatchField.H old mode 100644 new mode 100755 diff --git a/src/lagrangian/cfdemParticle/Make/files b/src/lagrangian/cfdemParticle/Make/files index 7e1f5884..cd1bd708 100644 --- a/src/lagrangian/cfdemParticle/Make/files +++ b/src/lagrangian/cfdemParticle/Make/files @@ -6,14 +6,15 @@ voidFractionModels = subModels/voidFractionModel locateModels = subModels/locateModel meshMotionModels = subModels/meshMotionModel momCoupleModels = subModels/momCoupleModel -regionModels = subModels/regionModel dataExchangeModels = subModels/dataExchangeModel averagingModels = subModels/averagingModel clockModels = subModels/clockModel liggghtsCommandModels = subModels/liggghtsCommandModel smoothingModels = subModels/smoothingModel +probeModels = subModels/probeModel $(cfdemCloud)/cfdemCloud.C +derived/cfdemCloudBiDisperse/cfdemCloudBiDisperse.C derived/cfdemCloudIB/cfdemCloudIB.C derived/cfdemCloudMS/cfdemCloudMS.C @@ -22,27 +23,47 @@ $(forceModels)/forceModel/newForceModel.C $(forceModels)/noDrag/noDrag.C $(forceModels)/checkCouplingInterval/checkCouplingInterval.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)/KochHillRWDrag/KochHillRWDrag.C +$(forceModels)/BeetstraDrag/multiphaseFlowBasic/multiphaseFlowBasic.C +$(forceModels)/BeetstraDrag/BeetstraDrag.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)/HollowayDrag/HollowayDrag.C $(forceModels)/viscForce/viscForce.C $(forceModels)/MeiLift/MeiLift.C +$(forceModels)/melting/melting.C +$(forceModels)/KochHillDragNLift/KochHillDragNLift.C +$(forceModels)/solidsPressureForce/solidsPressureForce.C +$(forceModels)/periodicPressure/periodicPressure.C +$(forceModels)/periodicPressureControl/periodicPressureControl.C +$(forceModels)/averageSlipVel/averageSlipVel.C $(forceModels)/particleCellVolume/particleCellVolume.C -$(forceModels)/fieldTimeAverage/fieldTimeAverage.C -$(forceModels)/volWeightedAverage/volWeightedAverage.C $(forceModelsMS)/forceModelMS/forceModelMS.C $(forceModelsMS)/forceModelMS/newForceModelMS.C $(forceModelsMS)/DiFeliceDragMS/DiFeliceDragMS.C +$(probeModels)/probeModel/probeModel.C +$(probeModels)/probeModel/newProbeModel.C +$(probeModels)/noProbe/noProbe.C +$(probeModels)/particleProbe/particleProbe.C + $(IOModels)/IOModel/IOModel.C $(IOModels)/IOModel/newIOModel.C $(IOModels)/noIO/noIO.C @@ -54,6 +75,7 @@ $(voidFractionModels)/voidFractionModel/voidFractionModel.C $(voidFractionModels)/voidFractionModel/newVoidFractionModel.C $(voidFractionModels)/centreVoidFraction/centreVoidFraction.C $(voidFractionModels)/dividedVoidFraction/dividedVoidFraction.C +$(voidFractionModels)/dividedVoidFractionBiDi/dividedVoidFractionBiDi.C $(voidFractionModels)/dividedVoidFractionMS/dividedVoidFractionMS.C $(voidFractionModels)/bigParticleVoidFraction/bigParticleVoidFraction.C $(voidFractionModels)/GaussVoidFraction/GaussVoidFraction.C @@ -67,21 +89,18 @@ $(locateModels)/turboEngineSearch/turboEngineSearch.C $(locateModels)/turboEngineSearchM2M/turboEngineSearchM2M.C $(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 $(momCoupleModels)/explicitCouple/explicitCouple.C +$(momCoupleModels)/explicitCoupleSource/explicitCoupleSource.C $(momCoupleModels)/implicitCouple/implicitCouple.C $(momCoupleModels)/noCouple/noCouple.C -$(regionModels)/regionModel/regionModel.C -$(regionModels)/regionModel/newRegionModel.C -$(regionModels)/allRegion/allRegion.C - $(dataExchangeModels)/dataExchangeModel/dataExchangeModel.C $(dataExchangeModels)/dataExchangeModel/newDataExchangeModel.C $(dataExchangeModels)/oneWayVTK/oneWayVTK.C @@ -94,6 +113,7 @@ $(averagingModels)/averagingModel/averagingModel.C $(averagingModels)/averagingModel/newAveragingModel.C $(averagingModels)/dilute/dilute.C $(averagingModels)/dense/dense.C +$(averagingModels)/denseBiDi/denseBiDi.C $(clockModels)/clockModel/clockModel.C $(clockModels)/clockModel/newClockModel.C @@ -111,5 +131,6 @@ $(smoothingModels)/smoothingModel/smoothingModel.C $(smoothingModels)/smoothingModel/newSmoothingModel.C $(smoothingModels)/noSmoothing/noSmoothing.C $(smoothingModels)/constDiffSmoothing/constDiffSmoothing.C +$(smoothingModels)/localPSizeDiffSmoothing/localPSizeDiffSmoothing.C -LIB = $(FOAM_USER_LIBBIN)/lib$(CFDEM_LIB_NAME) +LIB = $(CFDEM_LIB_DIR)/lib$(CFDEM_LIB_NAME) diff --git a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh new file mode 100755 index 00000000..fb71d387 --- /dev/null +++ b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_all.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +#===================================================================# +# compile routine for CFDEMcoupling + LIGGGHTS, part of CFDEMproject +# Christoph Goniva - May. 2012, DCS Computing GmbH +#===================================================================# + +#- include functions +source $CFDEM_SRC_DIR/etc/functions.sh + +NOW="$(date +"%Y-%m-%d-%H:%M")" +logDir="log" + + +cd $CFDEM_SRC_DIR/etc +mkdir -p $logDir + +#================================================================================# +# compile LIGGGHTS +#================================================================================# +bash $CFDEM_SRC_DIR/etc/compileLIGGGHTS.sh + +#================================================================================# +# compile CFDEMcoupling +#================================================================================# +bash $CFDEM_SRC_DIR/etc/compileCFDEMcoupling.sh diff --git a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh index b6ec976b..5cfb5df8 100755 --- a/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh +++ b/src/lagrangian/cfdemParticle/etc/compileCFDEMcoupling_sol.sh @@ -5,32 +5,81 @@ # Christoph Goniva - May. 2012, DCS Computing GmbH #===================================================================# +whitelist="solver-list.txt" + #- include functions source $CFDEM_SRC_DIR/etc/functions.sh - -NOW="$(date +"%Y-%m-%d-%H:%M")" logDir="log" - - cd $CFDEM_SRC_DIR/etc mkdir -p $logDir -#================================================================================# -# compile solvers -#================================================================================# +CWD="$(dirname "$(readlink -f ${BASH_SOURCE[0]})")" +NOW="$(date +"%Y-%m-%d-%H:%M")" +echo "" +echo "This routine will compile the solvers specified in solver-list.txt" +echo "" +echo "Are the variables CFDEM_SOLVER_DIR=$CFDEM_SOLVER_DIR" +echo "and CFDEM_SRC_DIR=$CFDEM_SRC_DIR correct? (y/n)" +read YN +if [ "$YN" != "y" ];then + echo "Aborted by user." + exit 1 +fi -for solverName in "cfdemSolverPiso" "cfdemSolverIB" "cfdemSolverPisoScalar" -do - #--------------------------------------------------------------------------------# - #- define variables - logpath="$(dirname "$(readlink -f ${BASH_SOURCE[0]})")/$logDir" - logfileName="log_compileCFDEMcoupling""_$solverName" - casePath="$CFDEM_SOLVER_DIR/$solverName" - headerText="$logfileName""_$solverName""-$NOW" - #--------------------------------------------------------------------------------# - compileSolver $logpath $logfileName $casePath $headerText -done +echo "" +echo "Please provide the solvers to be compiled in the $CWD/$whitelist file." +echo "structure:" +echo "path to provide the path relative to CFDEM_SOLVER_DIR" +echo "" +echo "example:" +echo "cfdemSolverPiso/dir" +echo "" -#echo "Note: the list of solvers compiled might be incomplete." -#echo "please check $CFDEM_SOLVER_DIR for more solvers available" +if [ ! -f "$CWD/$whitelist" ];then + echo "$whitelist does not exist in $CWD" +else + NLINES=`wc -l < $CWD/$whitelist` + COUNT=0 + + for masterLogFile in "$masterLogName" + do + + while [ $COUNT -lt $NLINES ] + do + let COUNT++ + LINE=`head -n $COUNT $CWD/$whitelist | tail -1` + + # white lines + if [[ "$LINE" == "" ]]; then + continue + # comments + elif [[ "$LINE" == \#* ]]; then + continue + # paths + elif [[ "$LINE" == */dir ]]; then + echo "change path" + LINE=$(echo "${LINE%????}") + path="$CFDEM_SOLVER_DIR/$LINE" + cd $path + #continue + fi + + #- execute tutorial + echo "running testcase $path" + #bash Allrun.sh + + #--------------------------------------------------------------------------------# + #- define variables + logpath="$(dirname "$(readlink -f ${BASH_SOURCE[0]})")/$logDir" + logfileName="log_compileCFDEMcoupling""_$LINE" + casePath="$CFDEM_SOLVER_DIR/$LINE" + headerText="$logfileName""_$LINE""-$NOW" + #--------------------------------------------------------------------------------# + compileSolver $logpath $logfileName $casePath $headerText + + #echo "did the solvers compile correcty? - press enter to proceed." + #read + done + done +fi diff --git a/src/lagrangian/cfdemParticle/etc/solver-list.txt b/src/lagrangian/cfdemParticle/etc/solver-list.txt new file mode 100644 index 00000000..9a3d5b0c --- /dev/null +++ b/src/lagrangian/cfdemParticle/etc/solver-list.txt @@ -0,0 +1,3 @@ +cfdemSolverPiso/dir +cfdemSolverIB/dir +cfdemSolverPisoScalar/dir diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/error.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/error.o deleted file mode 100644 index d050d3e0..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/error.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/files.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/files.o deleted file mode 100644 index 580ea813..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/files.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/irregular.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/irregular.o deleted file mode 100644 index 0fcf9924..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/irregular.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/lammps_data_write.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/lammps_data_write.o deleted file mode 100644 index 4f22b4eb..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/lammps_data_write.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/many2many.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/many2many.o deleted file mode 100644 index 48a90bcd..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/many2many.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/many2one.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/many2one.o deleted file mode 100644 index 09b899b4..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/many2one.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/memory.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/memory.o deleted file mode 100644 index 19032380..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/memory.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/one2many.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/one2many.o deleted file mode 100644 index a8c5c13b..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/one2many.o and /dev/null differ diff --git a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/send2one.o b/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/send2one.o deleted file mode 100644 index 71a5422f..00000000 Binary files a/src/lagrangian/cfdemParticle/subModels/dataExchangeModel/twoWayM2M/library/send2one.o and /dev/null differ diff --git a/tutorials/cfdemPostproc/fillCylinder/DEM/post/dummy b/tutorials/cfdemPostproc/fillCylinder/DEM/post/dummy deleted file mode 100644 index ebf63dfd..00000000 --- a/tutorials/cfdemPostproc/fillCylinder/DEM/post/dummy +++ /dev/null @@ -1 +0,0 @@ -dummyfile