mirror of
https://github.com/ParticulateFlow/CFDEMcoupling-PFM.git
synced 2025-12-08 06:37:44 +00:00
[DOC] split up main page
This commit is contained in:
danielque
@ -1,309 +1,93 @@
|
||||
"CFDEMproject WWW Site"_lws :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(lc,CFDEMcoupling_Manual.html#comm)
|
||||
:link(of,http://www.openfoam.com)
|
||||
:link(lig,http://www.cfdem.com)
|
||||
"CFDEMproject Website"_lig :c
|
||||
|
||||
:line
|
||||
CFDEMcoupling Documentation :h2,c
|
||||
CFDEMcoupling Documentation :h1,c
|
||||
<!-- HTML_ONLY -->
|
||||
Academic version :c
|
||||
<!-- END_HTML_ONLY -->
|
||||
|
||||
<!-- RST
|
||||
|
||||
|ProjectVersion|
|
||||
|
||||
END_RST -->
|
||||
|
||||
:line
|
||||
:c,image(Portfolio_CFDEMcoupling.png)
|
||||
:line
|
||||
|
||||
<!-- HTML_ONLY -->
|
||||
NOTE:
|
||||
|
||||
This is an academic adaptation of the CFDEMcoupling software package, released by
|
||||
the Department of Particulate Flow Modelling at "Johannes Kepler University
|
||||
Linz"_http://www.jku.at, Austria.
|
||||
This offering is not approved or endorsed by DCS Computing GmbH, the producer of
|
||||
the LIGGGHTS® and CFDEM®coupling software and owner of the LIGGGHTS
|
||||
and CFDEM® trade marks.
|
||||
<!-- END_HTML_ONLY -->
|
||||
|
||||
<!-- RST
|
||||
|
||||
.. note::
|
||||
|
||||
This is an academic adaptation of the CFDEMcoupling software package, released
|
||||
by the Department of Particulate Flow Modelling at `Johannes Kepler University
|
||||
Linz <http://www.jku.at>`_, Austria.
|
||||
This offering is not approved or endorsed by DCS Computing GmbH, the producer
|
||||
of the LIGGGHTS\ |reg| and CFDEM\ |reg|\ coupling software and owner of the
|
||||
LIGGGHTS and CFDEM\ |reg| trade marks.
|
||||
|
||||
.. |reg| unicode:: U+000AE .. REGISTERED SIGN
|
||||
|
||||
END_RST -->
|
||||
|
||||
<!-- HTML_ONLY -->
|
||||
1. Contents :h3
|
||||
<!-- END_HTML_ONLY -->
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
1.1 "About CFDEMcoupling"_#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)
|
||||
<!-- HTML_ONLY -->
|
||||
"About CFDEMcoupling"_CFDEMcoupling_about.html :olb,l
|
||||
"Installation"_CFDEMcoupling_install.html :l
|
||||
"Tutorials"_CFDEMcoupling_tutorials.html :l
|
||||
"Dictionaries"_CFDEMcoupling_dicts.html :l
|
||||
4.1 "couplingProperties dictionary"_CFDEMcoupling_dicts.html#couplingProperties :ulb,b
|
||||
4.2 "liggghtsCommands dictionary"_CFDEMcoupling_dicts.html#liggghtsCommands :ule,b
|
||||
"Solvers"_CFDEMcoupling_solvers.html :l
|
||||
"Models"_CFDEMcoupling_models.html :l
|
||||
:ole
|
||||
<!-- END_HTML_ONLY -->
|
||||
|
||||
:line
|
||||
<!-- RST
|
||||
|
||||
1.1 About CFDEMcoupling :link(1_1),h4
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:numbered:
|
||||
:caption: User Documentation
|
||||
:name: userdoc
|
||||
:includehidden:
|
||||
|
||||
CFDEM coupling provides an open source parallel coupled CFD-DEM framework combining the strengths of "LIGGGHTS"_lig DEM code and the Open Source CFD package "OpenFOAM(R)(*)"_of. The CFDEMcoupling toolbox allows to expand standard CFD solvers of "OpenFOAM(R)(*)"_of to include a coupling to the DEM code "LIGGGHTS"_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.
|
||||
CFDEMcoupling_about
|
||||
CFDEMcoupling_install
|
||||
CFDEMcoupling_tutorials
|
||||
CFDEMcoupling_dicts
|
||||
CFDEMcoupling_solvers
|
||||
CFDEMcoupling_models
|
||||
|
||||
The coupled solvers run fully parallel on distributed-memory clusters. Features are:
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
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
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
|
||||
The file structure:
|
||||
END_RST -->
|
||||
|
||||
{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 CFDEMcoupling :l
|
||||
{tutorials} directory including basic tutorial cases showing the functionality :l
|
||||
:ule
|
||||
:link(of,http://www.openfoam.org)
|
||||
:link(lig,http://www.cfdem.com)
|
||||
|
||||
Details on installation are given on the "CFDEMproject 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.
|
||||
|
||||
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
|
||||
|
||||
: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. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group.
|
||||
|
||||
: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 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).
|
||||
|
||||
[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"_lig input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS"_lig setup, please have a look at the "LIGGGHTS"_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 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.
|
||||
|
||||
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 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,
|
||||
"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html,
|
||||
"clockModel"_clockModel.html,
|
||||
"clockModel_noClock"_clockModel_noClock.html,
|
||||
"clockModel_standardClock"_clockModel_standardClock.html,
|
||||
"dataExchangeModel"_dataExchangeModel.html,
|
||||
"dataExchangeModel_noDataExchange"_dataExchangeModel_noDataExchange.html,
|
||||
"dataExchangeModel_oneWayVTK"_dataExchangeModel_oneWayVTK.html,
|
||||
"dataExchangeModel_twoWayFiles"_dataExchangeModel_twoWayFiles.html,
|
||||
"dataExchangeModel_twoWayMPI"_dataExchangeModel_twoWayMPI.html,
|
||||
"dataExchangeModel_twoWayMany2Many"_dataExchangeModel_twoWayMany2Many.html,
|
||||
"forceModel"_forceModel.html,
|
||||
"forceModel_Archimedes"_forceModel_Archimedes.html,
|
||||
"forceModel_ArchimedesIB"_forceModel_ArchimedesIB.html,
|
||||
"forceModel_DiFeliceDrag"_forceModel_DiFeliceDrag.html,
|
||||
"forceModel_dSauter"_forceModel_dSauter.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_fieldStore"_forceModel_fieldStore.html,
|
||||
"forceModel_pdCorrelation"_forceModel_pdCorrelation.html,
|
||||
"forceModel_gradPForce"_forceModel_gradPForce.html,
|
||||
"forceModel_noDrag"_forceModel_noDrag.html,
|
||||
"forceModel_particleCellVolume"_forceModel_particleCellVolume.html,
|
||||
"forceModel_virtualMassForce"_forceModel_virtualMassForce.html,
|
||||
"forceModel_viscForce"_forceModel_viscForce.html,
|
||||
"forceSubModel"_forceSubModel.html,
|
||||
"forceSubModel_ImEx"_forceSubModel_ImEx.html,
|
||||
"forceSubModel_ImExCorr"_forceSubModel_ImExCorr.html,
|
||||
"liggghtsCommandModel"_liggghtsCommandModel.html,
|
||||
"liggghtsCommandModel_execute"_liggghtsCommandModel_execute.html,
|
||||
"liggghtsCommandModel_readLiggghtsData"_liggghtsCommandModel_readLiggghtsData.html,
|
||||
"liggghtsCommandModel_runLiggghts"_liggghtsCommandModel_runLiggghts.html,
|
||||
"liggghtsCommandModel_writeLiggghts"_liggghtsCommandModel_writeLiggghts.html,
|
||||
"locateModel"_locateModel.html,
|
||||
"locateModel_engineSearch"_locateModel_engineSearch.html,
|
||||
"locateModel_engineSearchIB"_locateModel_engineSearchIB.html,
|
||||
"locateModel_engineSearchMany2Many"_locateModel_engineSearchMany2Many.html,
|
||||
"locateModel_standardSearch"_locateModel_standardSearch.html,
|
||||
"locateModel_turboEngineSearch"_locateModel_turboEngineSearch.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,
|
||||
"regionModel"_regionModel.html,
|
||||
"regionModel_allRegion"_regionModel_allRegion.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 :tb(c=2,ea=c)
|
||||
|
||||
64
doc/CFDEMcoupling_about.txt
Normal file
64
doc/CFDEMcoupling_about.txt
Normal file
@ -0,0 +1,64 @@
|
||||
"CFDEMproject Website"_lws - "Main Page"_main :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(main,CFDEMcoupling_Manual.html)
|
||||
|
||||
:line
|
||||
|
||||
1. About CFDEMcoupling :link(1_1),h3
|
||||
|
||||
CFDEMcoupling provides an open source parallel coupled CFD-DEM framework
|
||||
combining the strengths of the "LIGGGHTS"_lig DEM code and the Open Source CFD
|
||||
package "OpenFOAM(R)(*)"_of. The CFDEMcoupling toolbox allows to expand standard
|
||||
CFD solvers of "OpenFOAM(R)(*)"_of to include a coupling to the DEM code
|
||||
"LIGGGHTS"_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"_lig 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 CFDEMcoupling :l
|
||||
{tutorials} directory including basic tutorial cases showing the functionality :l
|
||||
:ule
|
||||
|
||||
Details on installation are given on the "CFDEMproject WWW Site"_lig .
|
||||
The functionality of this CFD-DEM framework is described via "tutorial
|
||||
cases"_CFDEMcoupling_tutorials.html 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
|
||||
|
||||
:line
|
||||
|
||||
NOTE:
|
||||
(*) This offering is not approved or endorsed by OpenCFD Limited, the producer
|
||||
of the OpenFOAM software and owner of the OPENFOAM(R) and OpenCFD(R) trade marks.
|
||||
OPENFOAM(R) is a registered trade mark of OpenCFD Limited, a wholly owned
|
||||
subsidiary of the ESI Group.
|
||||
|
||||
:link(of,http://www.openfoam.org)
|
||||
:link(lig,http://www.cfdem.com)
|
||||
|
||||
|
||||
92
doc/CFDEMcoupling_dicts.txt
Normal file
92
doc/CFDEMcoupling_dicts.txt
Normal file
@ -0,0 +1,92 @@
|
||||
"CFDEMproject Website"_lws - "Main Page"_main :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(main,CFDEMcoupling_Manual.html)
|
||||
|
||||
:line
|
||||
|
||||
4. Dictionaries :link(1_4),h3
|
||||
|
||||
4.1 "couplingProperties" dictionary :link(couplingProperties),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.
|
||||
|
||||
couplingInterval :pre
|
||||
|
||||
The coupling interval determines the time passing between two CFD-DEM data
|
||||
exchanges.
|
||||
|
||||
A useful procedure would be:
|
||||
|
||||
Set the DEM timestep in the in.xxx file according to the needs of the pure DEM problem. :olb,l
|
||||
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. :l
|
||||
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!". :l,ole
|
||||
|
||||
Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen
|
||||
every 0.0001s.
|
||||
|
||||
:line
|
||||
|
||||
4.2 "liggghtsCommands" dictionary :link(liggghtsCommands),h4
|
||||
|
||||
[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.
|
||||
|
||||
|
||||
14
doc/CFDEMcoupling_install.txt
Normal file
14
doc/CFDEMcoupling_install.txt
Normal file
@ -0,0 +1,14 @@
|
||||
"CFDEMproject Website"_lws - "Main Page"_main :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(main,CFDEMcoupling_Manual.html)
|
||||
|
||||
:line
|
||||
|
||||
2. Installation :link(1_2),h3
|
||||
|
||||
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).
|
||||
|
||||
|
||||
215
doc/CFDEMcoupling_models.txt
Normal file
215
doc/CFDEMcoupling_models.txt
Normal file
@ -0,0 +1,215 @@
|
||||
"CFDEMproject Website"_lws - "Main Page"_main :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(main,CFDEMcoupling_Manual.html)
|
||||
|
||||
:line
|
||||
|
||||
6. Models :h3,link(1_6),link(comm)
|
||||
|
||||
This section lists all CFDEMcoupling sub-models alphabetically, with
|
||||
a separate listing below of styles within certain commands.
|
||||
|
||||
6.1 I/O models :h4
|
||||
|
||||
The "IOModel"_IOModel.html keyword entry specifies the model for writing output
|
||||
data.
|
||||
|
||||
"basicIO"_IOModel_basicIO.html,
|
||||
"noIO"_IOModel_noIO.html,
|
||||
"sophIO"_IOModel_sophIO.html,
|
||||
"trackIO"_IOModel_trackIO.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.2 Averaging models :h4
|
||||
|
||||
The "averagingModel"_averagingModel.html keyword entry defines the model used to
|
||||
map the Lagrangian data to Eulerian values.
|
||||
|
||||
"dense"_averagingModel_dense.html,
|
||||
"dilute"_averagingModel_dilute.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.3 Chemistry models :h4
|
||||
|
||||
The "chemistryModels"_chemistryModel.html keyword is used to specify a list of
|
||||
models used for chemical reaction calculations.
|
||||
|
||||
"diffusionCoefficients"_chemistryModel_diffusionCoefficients.html,
|
||||
"massTransferCoeff"_chemistryModel_massTransferCoeff.html,
|
||||
noChemistry,
|
||||
reactantPerParticle,
|
||||
"species"_chemistryModel_species.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.4 Clock models :h4
|
||||
|
||||
The "clockModel"_clockModel.html keyword entry specifies the model used to
|
||||
examine the CFDEMcoupling code with respect to runtime.
|
||||
|
||||
"noClock"_clockModel_noClock.html,
|
||||
"standardClock"_clockModel_standardClock.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.5 Data exchange models :h4
|
||||
|
||||
The "dataExchangeModel"_dataExchangeModel.html keyword entry specifies the model
|
||||
that performs the data exchange between the DEM code and the CFD code.
|
||||
|
||||
"noDataExchange"_dataExchangeModel_noDataExchange.html,
|
||||
"oneWayVTK"_dataExchangeModel_oneWayVTK.html,
|
||||
"twoWayFiles"_dataExchangeModel_twoWayFiles.html,
|
||||
"twoWayMPI"_dataExchangeModel_twoWayMPI.html,
|
||||
"twoWayMany2Many"_dataExchangeModel_twoWayMany2Many.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.6 Energy models :h4
|
||||
|
||||
The {energyModels} keyword specifies a list of energy models used for e.g.
|
||||
compressible, reacting flows.
|
||||
|
||||
heatTransferGunn,
|
||||
heatTransferGunnImplicit,
|
||||
heatTransferGunnPartField,
|
||||
reactionHeat :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.7 Force models :h4
|
||||
|
||||
The "forceModels"_forceModel.html keyword specifies a list of models that exert
|
||||
a force on each DEM particle.
|
||||
|
||||
"Archimedes"_forceModel_Archimedes.html,
|
||||
"ArchimedesIB"_forceModel_ArchimedesIB.html,
|
||||
BeetstraDrag,
|
||||
BeetstraDragPoly,
|
||||
"DiFeliceDrag"_forceModel_DiFeliceDrag.html,
|
||||
"dSauter"_forceModel_dSauter.html,
|
||||
Fines,
|
||||
"GidaspowDrag"_forceModel_GidaspowDrag.html,
|
||||
"KochHillDrag"_forceModel_KochHillDrag.html,
|
||||
"LaEuScalarTemp"_forceModel_LaEuScalarTemp.html,
|
||||
"MeiLift"_forceModel_MeiLift.html,
|
||||
"SchillerNaumannDrag"_forceModel_SchillerNaumannDrag.html,
|
||||
"ShirgaonkarIB"_forceModel_ShirgaonkarIB.html,
|
||||
"fieldStore"_forceModel_fieldStore.html,
|
||||
"fieldTimeAverage"_forceModel_fieldTimeAverage.html,
|
||||
"gradPForce"_forceModel_gradPForce.html,
|
||||
granKineticEnergy,
|
||||
"interface"_forceModel_interface.html,
|
||||
"noDrag"_forceModel_noDrag.html,
|
||||
"particleCellVolume"_forceModel_particleCellVolume.html,
|
||||
"pdCorrelation"_forceModel_pdCorrelation.html,
|
||||
"virtualMassForce"_forceModel_virtualMassForce.html,
|
||||
"viscForce"_forceModel_viscForce.html,
|
||||
"volWeightedAverage"_forceModel_volWeightedAverage.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.7.1 Force sub-models :h5
|
||||
|
||||
The "forceSubModels"_forceSubModel.html keyword specifies a list
|
||||
of models that hold settings for a force model.
|
||||
|
||||
"ImEx"_forceSubModel_ImEx.html,
|
||||
ScaleForce,
|
||||
scaleForceBoundary :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.8 LIGGGHTS command models :h4
|
||||
|
||||
The "liggghtsCommandModels"_liggghtsCommandModel.html keyword specifies a list
|
||||
of models that execute LIGGGHTS commands within a CFD run.
|
||||
|
||||
"execute"_liggghtsCommandModel_execute.html,
|
||||
"readLiggghtsData"_liggghtsCommandModel_readLiggghtsData.html,
|
||||
"runLiggghts"_liggghtsCommandModel_runLiggghts.html,
|
||||
"writeLiggghts"_liggghtsCommandModel_writeLiggghts.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.9 Locate models :h4
|
||||
|
||||
The "locateModel"_locateModel.html keyword entry specifies the model used to
|
||||
search the CFD mesh for the CFD cell corresponding to a given position.
|
||||
|
||||
"engineSearch"_locateModel_engineSearch.html,
|
||||
"engineSearchIB"_locateModel_engineSearchIB.html,
|
||||
"engineSearchMany2Many"_locateModel_engineSearchMany2Many.html,
|
||||
"standardSearch"_locateModel_standardSearch.html,
|
||||
"turboEngineSearch"_locateModel_turboEngineSearch.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.10 Mesh motion models :h4
|
||||
|
||||
The "meshMotionModel"_meshMotionModel.html keyword entry specifies the model
|
||||
used to manipulate the CFD mesh according to the DEM mesh motion.
|
||||
|
||||
"noMeshMotion"_meshMotionModel_noMeshMotion.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.11 Momentum coupling models :h4
|
||||
|
||||
The "momCoupleModels"_momCoupleModel.html keyword specifies a list of models
|
||||
used for momentum exchange between DEM and CFD simulation
|
||||
|
||||
"explicitCouple"_momCoupleModel_explicitCouple.html,
|
||||
"implicitCouple"_momCoupleModel_implicitCouple.html,
|
||||
"noCouple"_momCoupleModel_noCouple.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.12 Other force models :h4
|
||||
|
||||
The {otherForceModels} keyword specifies a list of models that exert a force on
|
||||
each DEM particle.
|
||||
|
||||
expParticleForces,
|
||||
gravity,
|
||||
weightSecondaryPhase :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.13 Probe models :h4
|
||||
|
||||
The "probeModel"_probeModel.html keyword entry specifies the probing features in
|
||||
CFDEMcoupling simulations.
|
||||
|
||||
"noProbe"_probeModel_noProbe.html,
|
||||
"particleProbe"_probeModel_particleProbe.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.14 Region models :h4
|
||||
|
||||
The "regionModel"_regionModel.html keyword entry specifies the model used to
|
||||
select a certain region for coupled simulations.
|
||||
|
||||
"allRegion"_regionModel_allRegion.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.15 Smoothing models :h4
|
||||
|
||||
The "smoothingModel"_smoothingModel.html keyword entry specifies the model for
|
||||
smoothing the exchange fields.
|
||||
|
||||
"constDiffSmoothing"_smoothingModel_constDiffSmoothing.html,
|
||||
"noSmoothing"_smoothingModel_noSmoothing.html :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.16 Thermal conductivity models :h4
|
||||
|
||||
The {thermCondModel} keyword entry specifies the model for the thermal
|
||||
conductivity of the fluid phase in the presence of particles.
|
||||
|
||||
SyamlalThermCond,
|
||||
ZehnerSchluenderThermCond,
|
||||
noTherm :tb(c=2,ea=c)
|
||||
|
||||
|
||||
6.17 Void fraction models :h4
|
||||
|
||||
The "voidfractionModel"_voidFractionModel.html keyword entry specifies the model
|
||||
accounting for the volume of the particles in the CFD domain.
|
||||
|
||||
"GaussVoidFraction"_voidFractionModel_GaussVoidFraction.html,
|
||||
"IBVoidFraction"_voidFractionModel_IBVoidFraction.html,
|
||||
"bigParticleVoidFraction"_voidFractionModel_bigParticleVoidFraction.html,
|
||||
"centreVoidFraction"_voidFractionModel_centreVoidFraction.html,
|
||||
"dividedVoidFraction"_voidFractionModel_dividedVoidFraction.html :tb(c=2,ea=c)
|
||||
|
||||
18
doc/CFDEMcoupling_solvers.txt
Normal file
18
doc/CFDEMcoupling_solvers.txt
Normal file
@ -0,0 +1,18 @@
|
||||
"CFDEMproject Website"_lws - "Main Page"_main :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(main,CFDEMcoupling_Manual.html)
|
||||
|
||||
:line
|
||||
|
||||
5. Solvers :h3,link(1_5)
|
||||
|
||||
This section lists all CFDEMcoupling solvers alphabetically.
|
||||
|
||||
"cfdemSolverIB"_cfdemSolverIB.html,
|
||||
"cfdemSolverPiso"_cfdemSolverPiso.html,
|
||||
"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html,
|
||||
cfdemSolverRhoPimple,
|
||||
cfdemSolverRhoPimpleChem,
|
||||
cfdemSolverRhoSimple :tb(c=2,ea=c)
|
||||
|
||||
52
doc/CFDEMcoupling_tutorials.txt
Normal file
52
doc/CFDEMcoupling_tutorials.txt
Normal file
@ -0,0 +1,52 @@
|
||||
"CFDEMproject Website"_lws - "Main Page"_main :c
|
||||
|
||||
:link(lws,http://www.cfdem.com)
|
||||
:link(main,CFDEMcoupling_Manual.html)
|
||||
|
||||
:line
|
||||
|
||||
3. Tutorials :link(1_3),h3
|
||||
|
||||
[General:]
|
||||
|
||||
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).
|
||||
|
||||
[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"_lig input file located in
|
||||
$caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS"_lig setup,
|
||||
please have a look at the "LIGGGHTS"_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 command during a coupled simulation).
|
||||
|
||||
Reference in New Issue
Block a user