-
-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 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 framework 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 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 input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the LIGGGHTS setup, please have a look at 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", "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 --
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. -
-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: -
-Defined in couplingProperties dictionary. -
-IOModel "model"; --
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. -
- diff --git a/doc/IOModel.txt b/doc/IOModel.txt index 77014da2..bc82cc1c 100644 --- a/doc/IOModel.txt +++ b/doc/IOModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,28 +9,34 @@ IOModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -IOModel "model"; :pre +IOModel model; :pre model = name of IO-model to be applied :ul [Examples:] -IOModel "off"; +IOModel off; :pre -Note: This examples list might not be complete - please look for other models (IOModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other IO models +in this documentation. [Description:] -The IO-model is the base class to write data (e.g. particle properties) to files. +{IOModel} is the base class to write data (e.g. particle properties) to files. [Restrictions:] -none. +none [Related commands:] -Note: This examples list may be incomplete - please look for other models (IOModel_XY) in this documentation. +"IOModel basicIO"_IOModel_basicIO.html, "IOModel off"_IOModel_noIO.html, +"IOModel sophIO"_IOModel_sophIO.html, "IOModel trackIO"_IOModel_trackIO.html + +[Default:] + +none -[Default:] none. diff --git a/doc/IOModel_basicIO.html b/doc/IOModel_basicIO.html deleted file mode 100644 index 8152c9e9..00000000 --- a/doc/IOModel_basicIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-IOModel "basicIO"; --
Examples: -
-IOModel "basicIO"; --
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 -
- diff --git a/doc/IOModel_basicIO.txt b/doc/IOModel_basicIO.txt index 98daa37a..32115308 100644 --- a/doc/IOModel_basicIO.txt +++ b/doc/IOModel_basicIO.txt @@ -1,27 +1,39 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -IOModel_basicIO command :h3 +IOModel basicIO command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -IOModel "basicIO"; :pre +IOModel basicIO; :pre [Examples:] -IOModel "basicIO"; :pre +IOModel basicIO; +serialOutput; :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. +The {basicIO} model writes particle positions, velocities and radii to files. +The default output directory is {$casePath/CFD/proc*/time/lagrangian}. -[Restrictions:] None. +Using the keyword {serialOutput;} in the +"couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties dictionary, +the IO is serial to the directory {$casePath/CFD/lagrangian}. In this case +only the data on processor 0 is written! + +Data is written every write time of the CFD simulation. + +[Restrictions:] + +none [Related commands:] diff --git a/doc/IOModel_noIO.html b/doc/IOModel_noIO.html deleted file mode 100644 index 0fb2343c..00000000 --- a/doc/IOModel_noIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-IOModel "off"; --
Examples: -
-IOModel "off"; --
Description: -
-The noIO-model is a dummy IO model. -
-Restrictions: None. -
-Related commands: -
-IOModel -
- diff --git a/doc/IOModel_noIO.txt b/doc/IOModel_noIO.txt index d90d77cf..92c47159 100644 --- a/doc/IOModel_noIO.txt +++ b/doc/IOModel_noIO.txt @@ -1,27 +1,30 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -IOModel_noIO command :h3 +IOModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -IOModel "off"; :pre +IOModel off; :pre [Examples:] -IOModel "off"; :pre +IOModel off; :pre [Description:] -The noIO-model is a dummy IO model. +This IOModel produces no output. -[Restrictions:] None. +[Restrictions:] + +none [Related commands:] diff --git a/doc/IOModel_sophIO.html b/doc/IOModel_sophIO.html deleted file mode 100644 index 2bbf56ce..00000000 --- a/doc/IOModel_sophIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-IOModel "sophIO"; --
Examples: -
-IOModel "sophIO"; --
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 -
- diff --git a/doc/IOModel_sophIO.txt b/doc/IOModel_sophIO.txt index 09dcd3e6..98a5a0f5 100644 --- a/doc/IOModel_sophIO.txt +++ b/doc/IOModel_sophIO.txt @@ -1,29 +1,35 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -IOModel_sophIO command :h3 +IOModel sophIO command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -IOModel "sophIO"; :pre +IOModel sophIO; :pre [Examples:] -IOModel "sophIO"; :pre +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. +The {sophIO} model is based on the "basicIO"_IOModel_basicIO.html model and +additionally writes void fraction, implicit forces and explicit forces. -[Restrictions:] None. +Data is written every write time of the CFD simulation. + +[Restrictions:] + +none [Related commands:] -"IOModel"_IOModel.html +"IOModel"_IOModel.html, "IOModel basicIO"_IOModel_basicIO.html diff --git a/doc/IOModel_trackIO.html b/doc/IOModel_trackIO.html deleted file mode 100644 index 28d1e861..00000000 --- a/doc/IOModel_trackIO.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-IOModel "trackIO"; --
Examples: -
-IOModel "trackIO"; --
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 -
- diff --git a/doc/IOModel_trackIO.txt b/doc/IOModel_trackIO.txt index dff7906e..fcef4a94 100644 --- a/doc/IOModel_trackIO.txt +++ b/doc/IOModel_trackIO.txt @@ -1,29 +1,35 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -IOModel_trackIO command :h3 +IOModel trackIO command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -IOModel "trackIO"; :pre +IOModel trackIO; :pre [Examples:] -IOModel "trackIO"; :pre +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. +The {trackIO} model is based on the "sophIO"_IOModel_sophIO.html 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. +[Restrictions:] + +none [Related commands:] -"IOModel"_IOModel.html +"IOModel"_IOModel.html, "IOModel sophIO"_IOModel_sophIO.html diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..f20ac01d --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,189 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +#SPHINXBUILD = /usr/share/sphinx/scripts/python3/sphinx-build +PAPER = +BUILDDIR = _build +TXT2RST = txt2rst + +SOURCES=$(wildcard *.txt) +OBJECTS=$(SOURCES:%.txt=%.rst) + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`makeSyntax: -
-Defined in couplingProperties dictionary. -
-averagingModel model; --
Examples: -
-averagingModel dense; -averagingModel dilute; --
Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation. -
-Description: -
-The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). -
-Restrictions: -
-None. -
-Related commands: -
- -Default: none -
- diff --git a/doc/averagingModel.txt b/doc/averagingModel.txt index 36c327e7..e474ac75 100644 --- a/doc/averagingModel.txt +++ b/doc/averagingModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ averagingModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. averagingModel model; :pre @@ -20,18 +21,24 @@ model = name of averaging model to be applied :ul averagingModel dense; averagingModel dilute; :pre -Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation. +NOTE: +This examples list might not be complete - please look for other averaging +models in this documentation. [Description:] -The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). +The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. +particle velocities). [Restrictions:] -None. +none [Related commands:] "dense"_averagingModel_dense.html, "dilute"_averagingModel_dilute.html -[Default:] none +[Default:] + +none + diff --git a/doc/averagingModel_dense.html b/doc/averagingModel_dense.html deleted file mode 100644 index 239c82d9..00000000 --- a/doc/averagingModel_dense.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-averagingModel dense; --
Examples: -
-averagingModel dense; --
Description: -
-The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). In the "cfdemParticle cloud" this averaging model is used to calculate the average particle velocity inside a CFD cell. The "dense" model is supposed to be applied to cases where the granular regime is rather dense. -
-Restrictions: -
-No known restrictions. -
-Related commands: -
- - diff --git a/doc/averagingModel_dense.txt b/doc/averagingModel_dense.txt index 52da602b..f5c74160 100644 --- a/doc/averagingModel_dense.txt +++ b/doc/averagingModel_dense.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -averagingModel_dense command :h3 +averagingModel dense command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. averagingModel dense; :pre @@ -19,7 +20,10 @@ averagingModel dense; :pre [Description:] -The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). In the "cfdemParticle cloud" this averaging model is used to calculate the average particle velocity inside a CFD cell. The "dense" model is supposed to be applied to cases where the granular regime is rather dense. +The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. +particle velocities). In the "cfdemParticle cloud" this averaging model is used +to calculate the average particle velocity inside a CFD cell. The {dense} model +is supposed to be applied to cases where the granular regime is rather dense. [Restrictions:] diff --git a/doc/averagingModel_dilute.html b/doc/averagingModel_dilute.html deleted file mode 100644 index 6f75339c..00000000 --- a/doc/averagingModel_dilute.html +++ /dev/null @@ -1,35 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-averagingModel dilute; --
Examples: -
-averagingModel dilute; --
Description: -
-The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). -In the "cfdemParticle cloud" this averaging model is used to calculate the average particle velocity inside a CFD cell. The "dilute" model is supposed to be applied to cases where the granular regime is rather dilute. The particle velocity inside a CFD cell is evaluated from a single particle in a cell (no averaging). -
-Restrictions: -
-This model is computationally efficient, but should only be used when only one particle is inside one CFD cell. -
-Related commands: -
- - diff --git a/doc/averagingModel_dilute.txt b/doc/averagingModel_dilute.txt index 56640de8..47fa7dfe 100644 --- a/doc/averagingModel_dilute.txt +++ b/doc/averagingModel_dilute.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -averagingModel_dilute command :h3 +averagingModel dilute command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. averagingModel dilute; :pre @@ -19,12 +20,18 @@ averagingModel dilute; :pre [Description:] -The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities). -In the "cfdemParticle cloud" this averaging model is used to calculate the average particle velocity inside a CFD cell. The "dilute" model is supposed to be applied to cases where the granular regime is rather dilute. The particle velocity inside a CFD cell is evaluated from a single particle in a cell (no averaging). +The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. +particle velocities). +In the "cfdemParticle cloud" this averaging model is used to calculate the +average particle velocity inside a CFD cell. The {dilute} model is supposed to +be applied to cases where the granular regime is rather dilute. The particle +velocity inside a CFD cell is evaluated from a single particle in a cell (no +averaging). [Restrictions:] -This model is computationally efficient, but should only be used when only one particle is inside one CFD cell. +This model is computationally efficient but should only be used when only one +particle is inside one CFD cell. [Related commands:] diff --git a/doc/cfdemSolverIB.html b/doc/cfdemSolverIB.html deleted file mode 100644 index 556d2441..00000000 --- a/doc/cfdemSolverIB.html +++ /dev/null @@ -1,53 +0,0 @@ - -Description: -
-"cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating -the dynamics between immersed bodies and the surrounding fluid. Being an implementation of an immersed boundary method it allows tackling problems where the body diameter exceeds the maximal size of a fluid cell. Using the toolbox of OpenFOAM(R)(*) the governing equations of the fluid are computed and the corrections of velocity and pressure field with respect to the body-movement information, gained from LIGGGHTS, are incorporated. -
-Code of this solver contributions by Alice Hager, JKU. -
-Algorithm: -
-For each time step ... -
-Use: -
-The solver is realized within the Open Source framework CFDEMcoupling. Just as for the unresolved CFD-DEM solver cfdemSolverPiso the file CFD/constant/couplingProperties contains information about the settings for the different models. While IOmodel, DataExchangeModel etc. are applicable for all CFDEMcoupling-solvers, special locate-, force- and void fraction models were designed for the present case: -
-engineSearchIB, ArchimedesIB, ShirgaonkarIB, IBVoidfraction -
-References: -
-GONIVA, C., KLOSS, C., HAGER,A., WIERINK, G. and PIRKER, S. (2011): "A MULTI-PURPOSE OPEN SOURCE CFD-DEM APPROACH", Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, Trondheim, Norway -
-and -
-HAGER, A., KLOSS, C. and GONIVA, C. (2011): "TOWARDS AN EFFICIENT IMMERSED BOUNDARY METHOD WITHIN AN OPEN SOURCE FRAMEWORK", Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, Trondheim, Norway -
-(*) OpenFOAM(R) 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. -
-Description: -
-"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying the PISO algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the DEM code "LIGGGHTS". The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles whose trajectories are calculated in the DEM code LIGGGHTS. -
-see: -
-GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): "An Open Source CFD-DEM Perspective", Proc. of OpenFOAM Workshop, Göteborg, June 22.-24. -
-(*) 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. -
-Description: -
-"cfdemSolverPisoScalar" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying PISO algorithm, "cfdemSolverPisoScalar" has additional functionality for a coupling to the DEM code "LIGGGHTS" as well as a scalar transport equation. The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles, whose trajectories are calculated in the DEM code LIGGGHTS. The scalar transport equation is coupled to scalar properties of the particle phase, thus convective heat transfer in a fluid granular system can be modeled with "cfdemSolverPisoScalar". -
-see: -
-GONIVA, C., KLOSS, C., HAGER,A. and PIRKER, S. (2010): "An Open Source CFD-DEM Perspective", Proc. of OpenFOAM Workshop, Göteborg, June 22.-24. -
-The heat transfer equation is implemented according to Nield & Bejan (2013), Convection in Porous Media, DOI 10.1007/978-1-4614-5541-7_2, Springer -
-(*) 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. -
-Syntax: -
-Defined in couplingProperties dictionary. -
-chemistryModels -( - model_x - model_y -); --
Examples: -
-chemistryModels -( - species - diffusionCoefficients - massTransferCoeff -); --
Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation. -
-Description: -
-The chemistry model initialized the fields performs calculation of molar fractions and diffusion coefficients of the gaseous reactants at the location of each DEM particle. All models are executed sequentially. These values are used in the DEM calculation of particle reduction models. -
-Restrictions: -
-None. -
-Related commands: -
-species, diffusionCoefficient, massTransferCoeff -
-Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation. -
-Default: none. -
- diff --git a/doc/chemistryModel.txt b/doc/chemistryModel.txt index 458d52c8..4ba06f9b 100644 --- a/doc/chemistryModel.txt +++ b/doc/chemistryModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ chemistryModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( @@ -30,16 +31,22 @@ chemistryModels [Description:] -The chemistry model initializes the required fields for the calculation of molar fractions, determines the diffusion coefficients of the gaseous reactants, calculates the necessary coefficients for the calculation of a mass transfer coefficient. All models are executed sequentially. These values are used in the DEM calculation of particle reduction models. +The chemistry model initializes the required fields for the calculation of molar +fractions, determines the diffusion coefficients of the gaseous reactants, +calculates the necessary coefficients for the calculation of a mass transfer +coefficient. All models are executed sequentially. These values are used in the +DEM calculation of particle reduction models. [Restrictions:] -None. +none [Related commands:] -"species"_chemistryModel_species.html, "diffusionCoefficient"_chemistryModel_diffusionCoefficient.html, "massTransferCoeff"_chemistryModel_massTransferCoeffs.html +"diffusionCoefficient"_chemistryModel_diffusionCoefficients.html, +"massTransferCoeff"_chemistryModel_massTransferCoeff.html, +"species"_chemistryModel_species.html -Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation. +[Default:] -[Default:] none. +none diff --git a/doc/chemistryModel_diffusionCoefficients.html b/doc/chemistryModel_diffusionCoefficients.html deleted file mode 100644 index 94c463dd..00000000 --- a/doc/chemistryModel_diffusionCoefficients.html +++ /dev/null @@ -1,62 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-chemistryModels
-(
- diffusionCoefficients
-);
-diffusionCoefficientsProps
-{
- verbose switch1;
- ChemistryFile "$casePath/CFD/constant/foam.inp";
- diffusantGasNames ( speciesNames );
-};
-
-Examples: -
-chemistryModels
-(
- diffusionCoefficients
-);
-speciesProps
-{
- verbose false;
- ChemistryFile "$casePath/CFD/constant/foam.inp";
- diffusantGasNames ( CO
- H2
- );
-}
-
-Description: -
-The chemistry model performs the calculation of chemical reactional effects acting on each DEM particle. The diffusionCoefficients model activates the binary molecular diffusion calculation of the reacting species using the Fuller-Schettler-Giddings correlation. -
-Restrictions: -
-Species model needs to be active. -
-Related commands: -
- - diff --git a/doc/chemistryModel_diffusionCoefficients.txt b/doc/chemistryModel_diffusionCoefficients.txt index 8a116317..df64243b 100644 --- a/doc/chemistryModel_diffusionCoefficients.txt +++ b/doc/chemistryModel_diffusionCoefficients.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -chemistryModel_diffusionCoefficients command :h3 +chemistryModel diffusionCoefficients command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( @@ -17,40 +18,44 @@ chemistryModels ); diffusionCoefficientsProps \{ - verbose switch1; - ChemistryFile "$casePath/CFD/constant/foam.inp"; - diffusantGasNames ( speciesNames ); -\}; :pre + verbose switch1; + ChemistryFile "$casePath/CFD/constant/foam.inp"; + diffusantGasNames ( speciesNames ); +\} :pre -{switch1} = (optional, normally off) flag to give information :l -{ChemistryFile} = path to file, where the reacting species are listed :ulb,l +{switch1} = (optional, normally off) flag to give information :ulb,l +{ChemistryFile} = path to file, where the reacting species are listed :l {diffusantGasNames} = list of gas field names that are the reactant gases :l :ule [Examples:] -chemistryModels +chemistryModels ( diffusionCoefficients ); -speciesProps +diffusionCoefficientsProps \{ - verbose false; - ChemistryFile "$casePath/CFD/constant/foam.inp"; - diffusantGasNames ( CO - H2 - ); + verbose false; + ChemistryFile "$casePath/CFD/constant/foam.inp"; + diffusantGasNames ( CO + H2 + ); \} :pre [Description:] -The chemistry model performs the calculation of chemical reactional effects acting on each DEM particle. The diffusionCoefficients model activates the binary molecular diffusion calculation of the reacting species using the Fuller-Schettler-Giddings correlation. +The chemistry model performs the calculation of chemical reactional effects +acting on each DEM particle. The diffusionCoefficients model activates the +binary molecular diffusion calculation of the reacting species using the +Fuller-Schettler-Giddings correlation. [Restrictions:] -Species model needs to be active. +The "species"_chemistryModel_species.html model needs to be active. [Related commands:] -"chemistryModel"_chemistryModel.html +"chemistryModel"_chemistryModel.html, +"chemistryModel species"_chemistryModel_species.html diff --git a/doc/chemistryModel_massTransferCoeff.html b/doc/chemistryModel_massTransferCoeff.html deleted file mode 100644 index a80c8d4a..00000000 --- a/doc/chemistryModel_massTransferCoeff.html +++ /dev/null @@ -1,52 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-chemistryModels
-(
- massTransferCoeff
-);
-diffusionCoefficientsProps
-{
- verbose switch1;
-};
-
-Examples: -
-chemistryModels
-(
- massTransferCoeff
-);
-massTransferCoeffProps
-{
- verbose false;
-}
-
-Description: -
-The chemistry model performs the calculation of chemical reactional effects acting on each DEM particle. The coeffs needed to calculate the mass transfer coefficients are transferred to the DEM side, where it is used in the fix_chem_shrink_core module. -
-Restrictions: -
-Species model needs to be active. -
-Related commands: -
- - diff --git a/doc/chemistryModel_massTransferCoeff.txt b/doc/chemistryModel_massTransferCoeff.txt index f0f04ba4..39573ac4 100644 --- a/doc/chemistryModel_massTransferCoeff.txt +++ b/doc/chemistryModel_massTransferCoeff.txt @@ -1,48 +1,53 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -chemistryModel_massTransferCoeff command :h3 +chemistryModel massTransferCoeff command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( massTransferCoeff ); -diffusionCoefficientsProps +massTransferCoeffProps \{ - verbose switch1; -\}; :pre + verbose switch1; +\} :pre {switch1} = (optional, normally off) flag to give information :l :ule [Examples:] -chemistryModels +chemistryModels ( massTransferCoeff ); massTransferCoeffProps \{ - verbose false; + verbose false; \} :pre [Description:] -The chemistry model performs the calculation of chemical reactional effects acting on each DEM particle. The coeffs needed to calculate the mass transfer coefficients are transferred to the DEM side, where it is used in the fix_chem_shrink_core module. +The chemistry model performs the calculation of chemical reactional effects +acting on each DEM particle. The coefficients needed to calculate the mass +transfer coefficients are transferred to the DEM side, where it is used in the +{fix chem/shrink/core} module. [Restrictions:] -Species model needs to be active. +The "species"_chemistryModel_species.html model needs to be active. [Related commands:] -"chemistryModel"_chemistryModel.html +"chemistryModel"_chemistryModel.html, +"chemistryModel species"_chemistryModel_species.html diff --git a/doc/chemistryModel_noChemistry.txt b/doc/chemistryModel_noChemistry.txt new file mode 100644 index 00000000..8ae222d6 --- /dev/null +++ b/doc/chemistryModel_noChemistry.txt @@ -0,0 +1,33 @@ +"CFDEMproject Website"_lws - "Main Page"_main :c + +:link(lws,http://www.cfdem.com) +:link(main,CFDEMcoupling_Manual.html) + +:line + +chemistryModel off command :h3 + +[Syntax:] + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +chemistryModel off; :pre + +[Examples:] + +chemistryModel off; :pre + +[Description:] + +The {off} model is a dummy chemistryModel model which does not perform any +chemical reaction calculations. + +[Restrictions:] + +none + +[Related commands:] + +"chemistryModel"_chemistryModel.html + diff --git a/doc/chemistryModel_species.html b/doc/chemistryModel_species.html deleted file mode 100644 index 7a4da001..00000000 --- a/doc/chemistryModel_species.html +++ /dev/null @@ -1,74 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-chemistryModels
-(
- species
-);
-speciesProps
-{
- ChemistryFile "$casePath/CFD/constant/foam.inp";
- verbose switch1;
- tempFieldName "T";
- densityFieldName "rho"
- voidfractionFieldName "voidfraction"
- totalMoleFieldName "molarConc"
- partTempName "partTemp"
- partRhoName "partRho"
-};
-
-Examples: -
-chemistryModels
-(
- species
-);
-speciesProps
-{
- ChemistryFile "$casePath/CFD/constant/foam.inp";
- verbose false;
-}
-
-Description: -
-The chemistry model performs the calculation of chemical reactional effects acting on each DEM particle. The species model is the model, where the specified species fields (from the foam.inp folder) are intialized, and information such as temperature, density, molar concentration and more importantly the molar fractions are transferred to DEM side. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/chemistryModel_species.txt b/doc/chemistryModel_species.txt index 66f92a9d..ad4891bf 100644 --- a/doc/chemistryModel_species.txt +++ b/doc/chemistryModel_species.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -chemistryModel_species command :h3 +chemistryModel species command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. chemistryModels ( @@ -17,20 +18,20 @@ chemistryModels ); speciesProps \{ - ChemistryFile "$casePath/CFD/constant/foam.inp"; - verbose switch1; - tempFieldName "T"; - densityFieldName "rho" - voidfractionFieldName "voidfraction" - totalMoleFieldName "molarConc" - partTempName "partTemp" - partRhoName "partRho" -\}; :pre + ChemistryFile "$casePath/CFD/constant/foam.inp"; + tempFieldName "T"; + densityFieldName "rho"; + voidfractionFieldName "voidfraction"; + totalMoleFieldName "molarConc"; + partTempName "partTemp"; + partRhoName "partRho"; + verbose switch1; +\} :pre {ChemistryFile} = path to file, where the reacting species are listed :ulb,l {T} = name of the finite volume temperature field, it is already added in default and doesn't need to be specified if name is the same :l {rho} = name of the finite volume density field, it is already added in default and doesn't need to be specified if name is the same :l -{voidfraction} = name of the finite volume voidfraction field, it is already added in default and doesn't need to be specified if name is the same :l +{voidfraction} = name of the finite volume void fraction field, it is already added in default and doesn't need to be specified if name is the same :l {molarConc} = name of the finite volume molar concentration field, it is already added in default and doesn't need to be specified if name is the same :l {partTemp} = name of the finite volume cell averaged particle temperature field, it is already added in default and doesn't need to be specified if name is the same :l {partRho} = name of the finite volume cell averaged density temperature field, it is already added in default and doesn't need to be specified if name is the same :l @@ -39,23 +40,27 @@ speciesProps [Examples:] -chemistryModels +chemistryModels ( species ); speciesProps \{ - ChemistryFile "$casePath/CFD/constant/foam.inp"; - verbose false; + ChemistryFile "$casePath/CFD/constant/foam.inp"; + verbose false; \} :pre [Description:] -The chemistry model performs the calculation of chemical reactional effects acting on each DEM particle. The species model is the model, where the specified species fields (from the foam.inp folder) are intialized, and information such as temperature, density, molar concentration and more importantly the molar fractions are transferred to DEM side. +The chemistry model performs the calculation of chemical reactional effects +acting on each DEM particle. The species model is the model, where the specified +species fields (from the foam.inp folder) are initialized, and information such +as temperature, density, molar concentration and more importantly the molar +fractions are transferred to DEM side. [Restrictions:] -none. +none [Related commands:] diff --git a/doc/clockModel.html b/doc/clockModel.html deleted file mode 100644 index 7b590f81..00000000 --- a/doc/clockModel.html +++ /dev/null @@ -1,36 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-clockModel model; --
Examples: -
-clockModel standardClock; --
Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation. -
-Description: -
-The clockModel is the base class for models to examine the code/algorithm with respect to run time. -
-Main parts of the clockModel classes are written by Josef Kerbl, JKU. -
-Restrictions: none. -
-Default: none. -
- diff --git a/doc/clockModel.txt b/doc/clockModel.txt index fa93276a..370cb59d 100644 --- a/doc/clockModel.txt +++ b/doc/clockModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ clockModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. clockModel model; :pre @@ -19,14 +20,20 @@ model = name of the clockModel to be applied :ul clockModel standardClock; :pre -Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other clock +models in this documentation. [Description:] -The clockModel is the base class for models to examine the code/algorithm with respect to run time. +The clockModel is the base class for models to examine the code/algorithm with +respect to run time. -Main parts of the clockModel classes are written by Josef Kerbl, JKU. +Main parts of the clockModel classes were written by Josef Kerbl, JKU. -[Restrictions:] none. +[Restrictions:] -[Default:] none. +none + +[Default:] + +none diff --git a/doc/clockModel_noClock.html b/doc/clockModel_noClock.html deleted file mode 100644 index 23448e45..00000000 --- a/doc/clockModel_noClock.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-clockModel off; --
Examples: -
-clockModel off; --
Description: -
-The "noClock" model is a dummy clockModel model which does not measure/evaluate the run time. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/clockModel_noClock.txt b/doc/clockModel_noClock.txt index 509c0b65..ae6af057 100644 --- a/doc/clockModel_noClock.txt +++ b/doc/clockModel_noClock.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -clockModel_noClock command :h3 +clockModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. clockModel off; :pre @@ -19,9 +20,12 @@ clockModel off; :pre [Description:] -The "noClock" model is a dummy clockModel model which does not measure/evaluate the run time. +The {off} model is a dummy clockModel model which does not measure/evaluate the +run time. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] diff --git a/doc/clockModel_standardClock.html b/doc/clockModel_standardClock.html deleted file mode 100644 index b757df1f..00000000 --- a/doc/clockModel_standardClock.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-clockModel standardClock; --
Examples: -
-clockModel standardClock; --
Description: -
-The "standardClock" model is a basic clockModel model which measures the run time between every ".start(int arrayPos,string name)" and ".stop(string name)" statement placed in the code. If a ".start(name)" is called more than once (e.g. in a loop) the accumulated times are calculated. After the simulation has finished, the data is stored in $caseDir/CFD/clockData/$startTime/*.txt . -Since the measurements are stored in an array, it is necessary to put a variable arrayPos (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If arrayPos is out of bounds, the array size will be doubled. The stop command does not need arrayPos, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like ".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a safety feature, because if the name is not equal to the started name, output will be produced for information. -After the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like 'python < matPlot.py' and you have to be in the directory of the desired time step, where there is a file called "timeEvalFull.txt", which contains averaged and maximum data with respect to the number of processes. There is an alias called "vizClock" to run this python routine for visualizing the data. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/clockModel_standardClock.txt b/doc/clockModel_standardClock.txt index bae9832a..596eba70 100644 --- a/doc/clockModel_standardClock.txt +++ b/doc/clockModel_standardClock.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -clockModel_standardClock command :h3 +clockModel standardClock command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. clockModel standardClock; :pre @@ -19,11 +20,38 @@ clockModel standardClock; :pre [Description:] -The "standardClock" model is a basic clockModel model which measures the run time between every ".start(int arrayPos,string name)" and ".stop(string name)" statement placed in the code. If a ".start(name)" is called more than once (e.g. in a loop) the accumulated times are calculated. After the simulation has finished, the data is stored in $caseDir/CFD/clockData/$startTime/*.txt . -Since the measurements are stored in an array, it is necessary to put a variable {arrayPos} (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If {arrayPos} is out of bounds, the array size will be doubled. The stop command does not need {arrayPos}, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like ".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a safety feature, because if the name is not equal to the started name, output will be produced for information. -After the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like 'python < matPlot.py' and you have to be in the directory of the desired time step, where there is a file called "timeEvalFull.txt", which contains averaged and maximum data with respect to the number of processes. There is an alias called "vizClock" to run this python routine for visualizing the data. +The {standardClock} model is a basic clock model which measures the run time +between every ".start(int arrayPos,string name)" and ".stop(string name)" +statement placed in the code. If a ".start(name)" is called more than once +(e.g. in a loop) the accumulated times are calculated. -[Restrictions:] none. +After the simulation has finished, the data is stored in +$caseDir/CFD/clockData/$startTime/*.txt. + +Since the measurements are stored in an array, it is necessary to put a variable +{arrayPos} (type integer) at the start command. Those do not need to be in +ascending order and positions may be omitted. The standard size of this array is +30 and can be changed at the initialization of the standardClock class. If +{arrayPos} is out of bounds, the array size will be doubled. The stop command +does not need {arrayPos}, since the class remembers the positions. The string +name is intended for easier evaluation afterwards an may be omitted like +".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a +safety feature, because if the name is not equal to the started name, output +will be produced for information. + +After the case ran you may use the matPlot.py script located in +$CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The +usage is like + +python < matPlot.py :pre +and you have to be in the directory of the desired time step, where there is a +file called "timeEvalFull.txt", which contains averaged and maximum data with +respect to the number of processes. There is an alias called "vizClock" to run +this python routine for visualizing the data. + +[Restrictions:] + +none [Related commands:] diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 00000000..fbca9962 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,289 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# LAMMPS documentation build configuration file, created by +# sphinx-quickstart on Sat Sep 6 14:20:08 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# Special treatment of package import error +# see https://github.com/spinus/sphinxcontrib-images/issues/41 +from docutils.parsers.rst.directives.admonitions import BaseAdmonition +from sphinx.util import compat +compat.make_admonition = BaseAdmonition + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.mathjax', + 'sphinxcontrib.images', +] + +images_config = { + 'default_image_width' : '25%', + 'default_group' : 'default' +} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'CFDEMcoupling_Manual' + +# General information about the project. +project = 'CFDEMcoupling Academic' +copyright = '2018 JKU Linz and DCS Computing GmbH' + +def get_cfdemcoupling_version(): + import os + script_dir = os.path.dirname(os.path.realpath(__file__)) + #with open(os.path.join(script_dir, '../src/lagrangian/cfdemParticle/cfdTools/versionInfo.H'), 'r') as f: + with open(os.path.join(script_dir, '../etc/bashrc'), 'r') as f: + versionline = [line for line in f if line.startswith('export CFDEM_VERSION=')][0] + return versionline.strip('export CFDEM_VERSION=') + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = get_cfdemcoupling_version() +# The full version, including alpha/beta/rc tags. +release = version + +rst_epilog = """ +.. |ProjectVersion| replace:: Academic version {versionnum} +""".format( +versionnum = version, +) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'lammps_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ['_themes'] + +# The name for this set of Sphinx documents. If None, it defaults to +# "Syntax: -
-Defined in couplingProperties dictionary. -
-dataExchangeModel model; --
Examples: -
-dataExchangeModel twoWayFiles; -dataExchangeModel twoWayMPI; --
Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation. -
-Description: -
-The data exchange model performs the data exchange between the DEM code and the CFD code. -
-Restrictions: -
-None. -
-Related commands: -
-noDataExchange, oneWayVTK, twoWayFiles, twoWayMPI -
-Default: none -
- diff --git a/doc/dataExchangeModel.txt b/doc/dataExchangeModel.txt index 42e06384..ee054d2f 100644 --- a/doc/dataExchangeModel.txt +++ b/doc/dataExchangeModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ dataExchangeModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel model; :pre @@ -20,18 +21,25 @@ model = name of data exchange model to be applied :ul dataExchangeModel twoWayFiles; dataExchangeModel twoWayMPI; :pre -Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(dataExchangeModel XY) in this documentation. [Description:] -The data exchange model performs the data exchange between the DEM code and the CFD code. +The data exchange model performs the data exchange between the DEM code and the +CFD code. [Restrictions:] -None. +none [Related commands:] -"noDataExchange"_dataExchangeModel_noDataExchange.html, "oneWayVTK"_dataExchangeModel_oneWayVTK.html, "twoWayFiles"_dataExchangeModel_twoWayFiles.html, "twoWayMPI"_dataExchangeModel_twoWayMPI.html +"noDataExchange"_dataExchangeModel_noDataExchange.html, +"oneWayVTK"_dataExchangeModel_oneWayVTK.html, +"twoWayFiles"_dataExchangeModel_twoWayFiles.html, +"twoWayMPI"_dataExchangeModel_twoWayMPI.html -[Default:] none +[Default:] + +none diff --git a/doc/dataExchangeModel_noDataExchange.html b/doc/dataExchangeModel_noDataExchange.html deleted file mode 100644 index f84f4a55..00000000 --- a/doc/dataExchangeModel_noDataExchange.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-dataExchangeModel noDataExchange; --
Examples: -
-dataExchangeModel noDataExchange; --
Description: -
-The data exchange model performs the data exchange between the DEM code and the CFD code. The noDataExchange model is a dummy model where no data is exchanged. -
-Restrictions: -
-None. -
-Related commands: -
- - diff --git a/doc/dataExchangeModel_noDataExchange.txt b/doc/dataExchangeModel_noDataExchange.txt index ee6db034..676907c8 100644 --- a/doc/dataExchangeModel_noDataExchange.txt +++ b/doc/dataExchangeModel_noDataExchange.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -dataExchangeModel_noDataExchange command :h3 +dataExchangeModel noDataExchange command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel noDataExchange; :pre @@ -19,11 +20,12 @@ dataExchangeModel noDataExchange; :pre [Description:] -The data exchange model performs the data exchange between the DEM code and the CFD code. The noDataExchange model is a dummy model where no data is exchanged. +The data exchange model performs the data exchange between the DEM code and the +CFD code. The {noDataExchange} model is a dummy model where no data is exchanged. [Restrictions:] -None. +none [Related commands:] diff --git a/doc/dataExchangeModel_oneWayVTK.html b/doc/dataExchangeModel_oneWayVTK.html deleted file mode 100644 index def26192..00000000 --- a/doc/dataExchangeModel_oneWayVTK.html +++ /dev/null @@ -1,58 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-dataExchangeModel oneWayVTK;
-oneWayVTKProps
-{
- DEMts timeStep;
- relativePath "path";
- couplingFilename "filename";
- maxNumberOfParticles number;
-};
-
-Examples: -
-dataExchangeModel oneWayVTK;
-oneWayVTKProps
-{
- DEMts 0.0001;
- relativePath "../DEM/post";
- couplingFilename "vtk_out%4.4d.vtk";
- maxNumberOfParticles 30000;
-}
-
-Description: -
-The data exchange model performs the data exchange between the DEM code and the CFD code. The oneWayVTK model is a model that can exchange particle properties from DEM to CFD based on previously stored VTK data. -
-Restrictions: -
-None. -
-Related commands: -
- - diff --git a/doc/dataExchangeModel_oneWayVTK.txt b/doc/dataExchangeModel_oneWayVTK.txt index 3cf66429..f565f0da 100644 --- a/doc/dataExchangeModel_oneWayVTK.txt +++ b/doc/dataExchangeModel_oneWayVTK.txt @@ -1,24 +1,25 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -dataExchangeModel_oneWayVTK command :h3 +dataExchangeModel oneWayVTK command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel oneWayVTK; oneWayVTKProps \{ - DEMts timeStep; - relativePath "path"; - couplingFilename "filename"; - maxNumberOfParticles number; -\}; :pre + DEMts timeStep; + relativePath "path"; + couplingFilename "filename"; + maxNumberOfParticles number; +\} :pre {timeStep} = time step size of stored DEM data :ulb,l {path} = path to the VTK data files relative do simulation directory :l @@ -31,19 +32,21 @@ oneWayVTKProps dataExchangeModel oneWayVTK; oneWayVTKProps \{ - DEMts 0.0001; - relativePath "../DEM/post"; - couplingFilename "vtk_out%4.4d.vtk"; - maxNumberOfParticles 30000; + DEMts 0.0001; + relativePath "../DEM/post"; + couplingFilename "vtk_out%4.4d.vtk"; + maxNumberOfParticles 30000; \} :pre [Description:] -The data exchange model performs the data exchange between the DEM code and the CFD code. The oneWayVTK model is a model that can exchange particle properties from DEM to CFD based on previously stored VTK data. +The data exchange model performs the data exchange between the DEM code and the +CFD code. The {oneWayVTK} model is a model that can exchange particle properties +from DEM to CFD based on previously stored VTK data. [Restrictions:] -None. +none [Related commands:] diff --git a/doc/dataExchangeModel_twoWayFiles.html b/doc/dataExchangeModel_twoWayFiles.html deleted file mode 100644 index 46d2d891..00000000 --- a/doc/dataExchangeModel_twoWayFiles.html +++ /dev/null @@ -1,50 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-dataExchangeModel twoWayFiles;
-twoWayFilesProps
-{
- couplingFilename "filename";
- maxNumberOfParticles number;
-};
-
-Examples: -
-dataExchangeModel twoWayFiles;
-twoWayFilesProps
-{
- couplingFilename "vtk_out%4.4d.vtk";
- maxNumberOfParticles 30000;
-}
-
-Description: -
-The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayFiles model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via files that are sequentially written/read by the codes. -
-Restrictions: -
-Developed only for two processors, one for DEM and one for CFD run. -
-Related commands: -
- - diff --git a/doc/dataExchangeModel_twoWayFiles.txt b/doc/dataExchangeModel_twoWayFiles.txt index cd31b167..d2cb2a38 100644 --- a/doc/dataExchangeModel_twoWayFiles.txt +++ b/doc/dataExchangeModel_twoWayFiles.txt @@ -1,25 +1,28 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -dataExchangeModel_twoWayFiles command :h3 +dataExchangeModel twoWayFiles command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel twoWayFiles; twoWayFilesProps \{ - couplingFilename "filename"; - maxNumberOfParticles number; -\}; :pre + couplingFilename "filename"; + maxNumberOfParticles scalar1; + DEMts scalar2; +\} :pre {filename} = filename of the VTK file series :ulb,l -{number} = maximum number of particles in DEM simulation :l +{scalar1} = maximum number of particles in DEM simulation :l +{scalar2} = DEM time step width :l :ule [Examples:] @@ -27,13 +30,16 @@ twoWayFilesProps dataExchangeModel twoWayFiles; twoWayFilesProps \{ - couplingFilename "vtk_out%4.4d.vtk"; - maxNumberOfParticles 30000; + couplingFilename "vtk_out%4.4d.vtk"; + maxNumberOfParticles 30000; \} :pre [Description:] -The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayFiles model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via files that are sequentially written/read by the codes. +The data exchange model performs the data exchange between the DEM code and the +CFD code. The {twoWayFiles} model is a model that can exchange particle +properties from DEM to CFD and from CFD to DEM. Data is exchanged via files that +are sequentially written/read by the codes. [Restrictions:] diff --git a/doc/dataExchangeModel_twoWayMPI.html b/doc/dataExchangeModel_twoWayMPI.html deleted file mode 100644 index cde5fabe..00000000 --- a/doc/dataExchangeModel_twoWayMPI.html +++ /dev/null @@ -1,46 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-dataExchangeModel twoWayMPI;
-twoWayMPIProps
-{
- liggghtsPath "path";
-};
-
-Examples: -
-dataExchangeModel twoWayMPI;
-twoWayMPIProps
-{
- liggghtsPath "../DEM/in.liggghts_init";
-}
-
-Description: -
-The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayMPI model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique. The DEM run is executed by the coupling model, via a liggghtsCommandModel object. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/dataExchangeModel_twoWayMPI.txt b/doc/dataExchangeModel_twoWayMPI.txt index f698b0e0..5410ef1e 100644 --- a/doc/dataExchangeModel_twoWayMPI.txt +++ b/doc/dataExchangeModel_twoWayMPI.txt @@ -1,21 +1,22 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -dataExchangeModel_twoWayMPI command :h3 +dataExchangeModel twoWayMPI command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel twoWayMPI; twoWayMPIProps \{ liggghtsPath "path"; -\}; :pre +\} :pre {path} = path to the DEM simulation input file :ulb,l :ule @@ -30,11 +31,14 @@ twoWayMPIProps [Description:] -The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayMPI model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique. The DEM run is executed by the coupling model, via a liggghtsCommandModel object. +The data exchange model performs the data exchange between the DEM code and the +CFD code. The {twoWayMPI} model is a model that can exchange particle properties +from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique. The +DEM run is executed by the coupling model, via a {liggghtsCommandModel} object. [Restrictions:] -none. +none [Related commands:] diff --git a/doc/dataExchangeModel_twoWayMany2Many.html b/doc/dataExchangeModel_twoWayMany2Many.html deleted file mode 100644 index db5b6592..00000000 --- a/doc/dataExchangeModel_twoWayMany2Many.html +++ /dev/null @@ -1,46 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-dataExchangeModel twoWayMany2Many;
-twoWayMany2ManyProps
-{
- liggghtsPath "path";
-};
-
-Examples: -
-dataExchangeModel twoWayMany2Many;
-twoWayMany2ManyProps
-{
- liggghtsPath "../DEM/in.liggghts_init";
-}
-
-Description: -
-The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayMany2Many model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique using the many to many mapping scheme. The DEM run is executed by the coupling model, via a liggghtsCommandModel object. -
-Restrictions: -
-Must be used in combination with the engineSearchMany2Many locate model! -
-Related commands: -
- - diff --git a/doc/dataExchangeModel_twoWayMany2Many.txt b/doc/dataExchangeModel_twoWayMany2Many.txt index 31f87e67..0cf4e372 100644 --- a/doc/dataExchangeModel_twoWayMany2Many.txt +++ b/doc/dataExchangeModel_twoWayMany2Many.txt @@ -1,21 +1,22 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -dataExchangeModel_twoWayMany2Many command :h3 +dataExchangeModel twoWayMany2Many command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. dataExchangeModel twoWayMany2Many; twoWayMany2ManyProps \{ liggghtsPath "path"; -\}; :pre +\} :pre {path} = path to the DEM simulation input file :ulb,l :ule @@ -30,11 +31,16 @@ twoWayMany2ManyProps [Description:] -The data exchange model performs the data exchange between the DEM code and the CFD code. The twoWayMany2Many model is a model that can exchange particle properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI technique using the many to many mapping scheme. The DEM run is executed by the coupling model, via a liggghtsCommandModel object. +The data exchange model performs the data exchange between the DEM code and the +CFD code. The {twoWayMany2Many} model is a model that can exchange particle +properties from DEM to CFD and from CFD to DEM. Data is exchanged via MPI +technique using the many to many mapping scheme. The DEM run is executed by the +coupling model, via a {liggghtsCommandModel} object. [Restrictions:] -Must be used in combination with the engineSearchMany2Many locate model! +Must be used in combination with the +"engineSearchMany2Many"_locateModel_engineSearchMany2Many.html locate model! [Related commands:] diff --git a/doc/forceModel.html b/doc/forceModel.html deleted file mode 100644 index fa2d2f78..00000000 --- a/doc/forceModel.html +++ /dev/null @@ -1,50 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels -( - model_x - model_y -); --
Examples: -
-forceModels -( - Archimedes - DiFeliceDrag -); --
Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation. -
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. All force models selected are executed sequentially and the forces on the particles are superposed. If the fluid density field is needed, by default a field named "rho" will be used. Via the forceSubModel an alternative field can be chosen. -
-Restrictions: -
-None. -
-Related commands: -
-Archimedes, DiFeliceDrag, gradPForce, viscForce">dSauter -
-Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation. -
-Default: none. -
- diff --git a/doc/forceModel.txt b/doc/forceModel.txt index 2ada849a..4f8edeba 100644 --- a/doc/forceModel.txt +++ b/doc/forceModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ forceModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -27,20 +28,28 @@ forceModels DiFeliceDrag ); :pre -Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(forceModel XY) in this documentation. [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. All force models selected are executed sequentially and the forces on the particles are superposed. If the fluid density field is needed, by default a field named "rho" will be used. Via the forceSubModel an alternative field can be chosen. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. All force models selected are +executed sequentially and the forces on the particles are superposed. If the +fluid density field is needed, by default a field named "rho" will be used. Via +the forceSubModel an alternative field can be chosen. [Restrictions:] -None. +none [Related commands:] -"Archimedes"_forceModel_Archimedes.html, "DiFeliceDrag"_forceModel_DiFeliceDrag.html, "gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html,"dSauter"_forceModel_dSauter.html +"Archimedes"_forceModel_Archimedes.html, "DiFeliceDrag"_forceModel_DiFeliceDrag.html, +"gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html, +"dSauter"_forceModel_dSauter.html -Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation. +[Default:] + +none -[Default:] none. diff --git a/doc/forceModel_Archimedes.html b/doc/forceModel_Archimedes.html deleted file mode 100644 index 8301478d..00000000 --- a/doc/forceModel_Archimedes.html +++ /dev/null @@ -1,52 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- Archimedes
-);
-ArchimedesProps
-{
- gravityFieldName "gravity";
-};
-
-Examples: -
-forceModels
-(
- Archimedes
-);
-ArchimedesProps
-{
- gravityFieldName "g";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The Archimedes model is a model that calculates the Archimedes' volumetric lift force stemming from density difference of fluid and particle. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_Archimedes.txt b/doc/forceModel_Archimedes.txt index 41c18aee..48b95e44 100644 --- a/doc/forceModel_Archimedes.txt +++ b/doc/forceModel_Archimedes.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_Archimedes command :h3 +forceModel Archimedes command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,10 +18,14 @@ forceModels ); ArchimedesProps \{ - gravityFieldName "gravity"; -\}; :pre + gravityFieldName "gravity"; + treatForceExplicit switch1; + treatForceDEM switch2; +\} :pre {gravity} = name of the finite volume gravity field :ulb,l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -36,11 +41,14 @@ ArchimedesProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The Archimedes model is a model that calculates the Archimedes' volumetric lift force stemming from density difference of fluid and particle. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {Archimedes} model is a +model that calculates the Archimedes' volumetric lift force stemming from +density difference of fluid and particle. [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_ArchimedesIB.html b/doc/forceModel_ArchimedesIB.html deleted file mode 100644 index 9f43172f..00000000 --- a/doc/forceModel_ArchimedesIB.html +++ /dev/null @@ -1,56 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- ArchimedesIB
-);
-ArchimedesIBProps
-{
- gravityFieldName "gravity";
- voidfractionFieldName "voidfraction";
-};
-
-Examples: -
-forceModels
-(
- ArchimedesIB
-);
-ArchimedesIBProps
-{
- gravityFieldName "g";
- voidfractionFieldName "voidfractionNext";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB' volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method. -
-Restrictions: -
-Only for immersed boundary solvers. -
-Related commands: -
- - diff --git a/doc/forceModel_ArchimedesIB.txt b/doc/forceModel_ArchimedesIB.txt index 041d737b..bd661f54 100644 --- a/doc/forceModel_ArchimedesIB.txt +++ b/doc/forceModel_ArchimedesIB.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_ArchimedesIB command :h3 +forceModel ArchimedesIB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,12 +18,16 @@ forceModels ); ArchimedesIBProps \{ - gravityFieldName "gravity"; + gravityFieldName "gravity"; voidfractionFieldName "voidfraction"; -\}; :pre + twoDimensional; + treatForceExplicit switch1; +\} :pre {gravity} = name of the finite volume gravity field :ulb,l -{voidfraction} = name of the finite volume voidfraction field :l +{voidfraction} = name of the finite volume void fraction field :l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -33,13 +38,18 @@ forceModels ); ArchimedesIBProps \{ - gravityFieldName "g"; + gravityFieldName "g"; voidfractionFieldName "voidfractionNext"; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB' volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {ArchimedesIB} model is a +model that calculates the ArchimedesIB' volumetric lift force stemming from +density difference of fluid and particle. This model is especially suited for +resolved CFD-DEM simulations where the particle is represented by immersed +boundary method. [Restrictions:] diff --git a/doc/forceModel_BeetstraDrag.txt b/doc/forceModel_BeetstraDrag.txt new file mode 100644 index 00000000..b1c16c57 --- /dev/null +++ b/doc/forceModel_BeetstraDrag.txt @@ -0,0 +1,117 @@ +"CFDEMproject Website"_lws - "Main Page"_main :c + +:link(lws,http://www.cfdem.com) +:link(main,CFDEMcoupling_Manual.html) + +:line + +forceModel BeetstraDrag command :h3 + +[Syntax:] + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +forceModels +( + BeetstraDrag +); +BeetstraDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + minVoidfraction scalar1; + granVelFieldName "Us"; +\ + useFilteredDragModel; + g gravity; + dPrim dPrimValue; + rhoP rhoPValue; + rho rhoValue; + nuf nufValue; +\ + useParcelSizeDependentFilteredDrag; + k kValue; +\ + treatForceExplicit; + implForceDEM; + verbose; + interpolation; +\} :pre + +{U} = name of the finite volume fluid velocity field :ulb,l +{voidfraction} = name of the finite volume void fraction field :l +{minVoidfraction} = minimum void fraction value to ensure meaningful interpolated void fraction (default = 0.1) :l +{Us} = name of the finite volume cell averaged particle velocity field :l + +{useFilteredDragModel} = switch for using a coarsening correction for the Beetstra drag model (takes grid-size effects into account; default = off) :l + +{gravity} = gravity value (default = 9.81) :l +{dPrimValue} = diameter of primary particle :l +{rhoPValue} = particle density :l +{rhoValue} = finite volume density :l +{nufValue} = kinematic viscosity :l + +{useParcelSizeDependentFilteredDrag} = switch for using a coarsening correction for the Beetstra drag model (only used if {useFilteredDragModel} is on; default = off) :l + +{kValue} = factor for parcels size effect (default = 0.05; must be defined if useParcelSizeDependentFilteredDrag is used) :l + +{interpolation} = flag to use interpolated void fraction and fluid velocity values (normally off) :l +{treatForceExplicit} = switch to force explicit treatment of force (normally off) :l +{implForceDEM} = flag to use implicit formulation of drag on DEM side (normally off, if on, this switch will force {treatForceExplicit} to be off) :l +{verbose} = switch to force display of data on screen (default: off; typically used for debug purposes) :l +:ule + +[Examples:] + +forceModels +( + BeetstraDrag +); +BeetstraDragProps +\{ + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + interpolation true; + useFilteredDragModel; + g 9.81; + dPrim 100e-6; + rhoP 7000.; + rho 10.; + nuf 1.5e-4; + useParcelSizeDependentFilteredDrag; + k 0.05; +\} :pre + +[Description:] + +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {BeetstraDrag} model is a +model that calculates the particle based drag force following the correlation of +"Beetstra et al. (2007)"_#Beetstra2007. +The filtered drag model is based on "Radl and Sundaresan (2014)"_#Radl2014. + +[Restrictions:] + +This model is strictly valid only for monodisperse gas-particle flows. +For the polydisperse model of "Beetstra et al. (2007)"_#Beetstra2007 use +{BeetstraDragPoly}. + +[Related commands:] + +"forceModel"_forceModel.html, BeetstraDragPoly + +:line + +:link(Beetstra2007) +[(Beetstra, 2007)] +Beetstra, R., van der Hoef, M. A. and Kuipers J. A. M., +"Drag force of intermediate Reynolds number flow past mono- and bidisperse arrays of spheres", +AIChE J., 53(2) (2007) + +:link(Radl2014) +[(Radl, 2014)] Radl, S. and Sundaresan, S., +"A drag model for filtered Euler-Lagrange simulations of clustered gas-particle suspensions", +Chem. Eng. Sci., 117, pp. 416-425 (2014) + diff --git a/doc/forceModel_DiFeliceDrag.html b/doc/forceModel_DiFeliceDrag.html deleted file mode 100644 index 53a2aebf..00000000 --- a/doc/forceModel_DiFeliceDrag.html +++ /dev/null @@ -1,56 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- DiFeliceDrag
-);
-DiFeliceDragProps
-{
- velFieldName "U";
- interpolation switch1;
-};
-
-Examples: -
-forceModels
-(
- DiFeliceDrag
-);
-DiFeliceDragProps
-{
- velFieldName "U";
- interpolation true;
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The DiFeliceDrag model is a model that calculates the particle based drag force following the correlation of Di Felice (see Zhou et al. (2010), JFM). -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_DiFeliceDrag.txt b/doc/forceModel_DiFeliceDrag.txt index 77e6e4ba..7fe5396d 100644 --- a/doc/forceModel_DiFeliceDrag.txt +++ b/doc/forceModel_DiFeliceDrag.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_DiFeliceDrag command :h3 +forceModel DiFeliceDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,12 +18,29 @@ forceModels ); DiFeliceDragProps \{ - velFieldName "U"; - interpolation switch1; -\}; :pre + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us"; + scale scalar1; + scaleDrag scalar2; + treatForceExplicit switch1; + implForceDEM switch2; + verbose switch3; + interpolation switch4; + scalarViscosity switch5; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{switch1} = flag to use interpolated voidfraction and velocity values (normally off) :l +{voidfraction} = name of the finite volume void fraction field :l +{Us} = name of the finite volume granular velocity field :l +{scalar1} = (optional) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse-grained) particle diameter. +scale=coarse-graining factor. d_real= particle diameter as it is measured. :l +{scalar2} = (optional) scaling factor which directly scales the drag force. :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) flag to use interpolated void fraction and velocity values :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -33,17 +51,20 @@ forceModels ); DiFeliceDragProps \{ - velFieldName "U"; + velFieldName "U"; interpolation true; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The DiFeliceDrag model is a model that calculates the particle based drag force following the correlation of Di Felice (see Zhou et al. (2010), JFM). +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {DiFeliceDrag} model is a +model that calculates the particle based drag force following the correlation of +Di Felice (see Zhou et al. (2010), JFM). [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_GidaspowDrag.html b/doc/forceModel_GidaspowDrag.html deleted file mode 100644 index 9aa7318d..00000000 --- a/doc/forceModel_GidaspowDrag.html +++ /dev/null @@ -1,68 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- GidaspowDrag
-);
-GidaspowDragProps
-{
- velFieldName "U";
- voidfractionFieldName "voidfraction";
- granVelFieldName "Us";
- phi "scalar";
- interpolation switch1;
- implForceDEM switch2;
-};
-
-Examples: -
-forceModels
-(
- GidaspowDrag
-);
-GidaspowDragProps
-{
- velFieldName "U";
- voidfractionFieldName "voidfraction";
- granVelFieldName "Us";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Ergun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): "Discrete particle simulation of particulate systems: Theoretical developments", ChemEngScience). -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_GidaspowDrag.txt b/doc/forceModel_GidaspowDrag.txt index 452c67f1..2905df7b 100644 --- a/doc/forceModel_GidaspowDrag.txt +++ b/doc/forceModel_GidaspowDrag.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_GidaspowDrag command :h3 +forceModel GidaspowDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,20 +18,32 @@ forceModels ); GidaspowDragProps \{ - velFieldName "U"; + velFieldName "U"; voidfractionFieldName "voidfraction"; - granVelFieldName "Us"; - phi "scalar"; - interpolation switch1; - implForceDEM switch2; -\}; :pre + granVelFieldName "Us"; + phi scalar1; + scale scalar2; + scaleDrag scalar3; + switchingVoidfraction scalar4; + treatForceExplicit switch1; + implForceDEM switch2; + verbose switch3; + interpolation switch4; + scalarViscosity switch5; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{voidfraction} = name of the finite volume voidfraction field :l +{voidfraction} = name of the finite volume void fraction field :l {Us} = name of the finite volume cell averaged particle velocity field :l -{phi} = drag correction factor (in doubt 1) :l -{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l -{switch2} = (optional, normally off) flag to use implicit formulation of drag on DEM side:l +{scalar1} = drag correction factor (in doubt 1) :l +{scalar2} = (optional, default 1.0) scaling of particle diameter: d_sim=scale*d_real. d_sim=(potentially coarse-grained) particle diameter. scale=coarse-graining factor. d_real= particle diameter as it is measured. :l +{scalar3} = (optional, default 1.0) scaling of drag law :l +{scalar4} = (optional, default 0.8) void fraction above which dilute formulation will be used :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) flag to use implicit formulation of drag on DEM side :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) flag to use interpolated void fraction and fluid velocity values :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -41,18 +54,23 @@ forceModels ); GidaspowDragProps \{ - velFieldName "U"; + velFieldName "U"; voidfractionFieldName "voidfraction"; - granVelFieldName "Us"; + granVelFieldName "Us"; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Ergun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): "Discrete particle simulation of particulate systems: Theoretical developments", ChemEngScience). +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {GidaspowDrag} model is a +model that calculates the particle based drag force following the correlation of +Gidaspow which is a combination of Ergun (1952) and Wen & Yu (1966) +(see Zhu et al. (2007): "Discrete particle simulation of particulate systems: +Theoretical developments", ChemEngScience). [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_KochHillDrag.html b/doc/forceModel_KochHillDrag.html deleted file mode 100644 index 1cf16d96..00000000 --- a/doc/forceModel_KochHillDrag.html +++ /dev/null @@ -1,61 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- KochHillDrag
-);
-KochHillDragProps
-{
- velFieldName "U";
- voidfractionFieldName "voidfraction";
- interpolation "bool1";
- implForceDEM "bool2";
-};
-
-Examples: -
-forceModels
-(
- KochHillDrag
-);
-KochHillDragProps
-{
- velFieldName "U";
- voidfractionFieldName "voidfraction";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental study on multiple-spout fluidized beds", ChemEngScience). -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_KochHillDrag.txt b/doc/forceModel_KochHillDrag.txt index 0737bb22..190de60d 100644 --- a/doc/forceModel_KochHillDrag.txt +++ b/doc/forceModel_KochHillDrag.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_KochHillDrag command :h3 +forceModel KochHillDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,16 +18,26 @@ forceModels ); KochHillDragProps \{ - velFieldName "U"; - voidfractionFieldName "voidfraction"; - interpolation "bool1"; - implForceDEM "bool2"; -\}; :pre + velFieldName "U"; + voidfractionFieldName "voidfraction"; + granVelFieldName "Us" + treatForceExplicit switch1; + implForceDEM switch2; + verbose switch3; + interpolation switch4; + implForceDEMaccumulated switch5; + scalarViscosity switch6; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{voidfraction} = name of the finite volume voidfraction field :l -{bool1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l -{bool2} = (optional, normally off) flag to use implicit formulation of drag on DEM side:l +{voidfraction} = name of the finite volume void fraction field :l +{Us} = (optional, default "Us") name of finite volume granular velocity field :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) flag to use implicit formulation of drag on DEM side :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch4} = (optional, default false) flag to use interpolated void fraction and fluid velocity values :l +{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch6} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -38,16 +49,20 @@ forceModels KochHillDragProps \{ velFieldName "U"; - voidfractionFieldName "voidfraction"; + voidfractionFieldName "voidfraction"; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental study on multiple-spout fluidized beds", ChemEngScience). +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {KochHillDrag} model is a +model that calculates the particle based drag force following the correlation of +Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental +study on multiple-spout fluidized beds", ChemEngScience). [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_LaEuScalarTemp.html b/doc/forceModel_LaEuScalarTemp.html deleted file mode 100644 index 778d3e32..00000000 --- a/doc/forceModel_LaEuScalarTemp.html +++ /dev/null @@ -1,82 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- LaEuScalarTemp
-);
-LaEuScalarTempProps
-{
- velFieldName "U";
- tempFieldName "T";
- voidfractionFieldName "voidfraction";
- partTempName "Temp";
- partHeatFluxName "convectiveHeatFlux";
- lambda value;
- Cp value1;
- interpolation "switch1";
- verbose "switch2";
-};
-
-Examples: -
-forceModels
-(
- LaEuScalarTemp
-);
-LaEuScalarTempProps
-{
- velFieldName "U";
- tempFieldName "T";
- voidfractionFieldName "voidfraction";
- partTempName "Temp";
- partHeatFluxName "convectiveHeatFlux";
- lambda 0.0256;
- Cp 1007;
-}
-
-Description: -
-This "forceModel" does not influence the particles or the fluid flow! Using the particles' temperature a scalar field representing "particle-fluid heatflux" is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112 -
-Restrictions: -
-Goes only with cfdemSolverScalar. The force model has to be the second (!!!) model in the forces list. -
-Related commands: -
- - diff --git a/doc/forceModel_LaEuScalarTemp.txt b/doc/forceModel_LaEuScalarTemp.txt index 307693c7..2be22fee 100644 --- a/doc/forceModel_LaEuScalarTemp.txt +++ b/doc/forceModel_LaEuScalarTemp.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_LaEuScalarTemp command :h3 +forceModel LaEuScalarTemp command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,26 +18,30 @@ forceModels ); LaEuScalarTempProps \{ - velFieldName "U"; - tempFieldName "T"; + velFieldName "U"; + tempFieldName "T"; voidfractionFieldName "voidfraction"; - partTempName "Temp"; - partHeatFluxName "convectiveHeatFlux"; - lambda value; - Cp value1; - interpolation "switch1"; - verbose "switch2"; -\}; :pre + partTempName "Temp"; + partHeatFluxName "convectiveHeatFlux"; + lambda scalar1; + Cp scalar2; + maxSource scalar3; + verbose switch1; + interpolation switch2; + scalarViscosity switch3; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l {T} = name of the finite volume scalar temperature field :l -{voidfraction} = name of the finite volume voidfraction field :l +{voidfraction} = name of the finite volume void fraction field :l {Temp} = name of the DEM data representing the particles temperature :l {convectiveHeatFlux} = name of the DEM data representing the particle-fluid convective heat flux :l -{value} = fluid thermal conductivity \[W/(m*K)\] :l -{value1} = fluid specific heat capacity \[W*s/(kg*K)\] :l -{switch1} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l -{switch2} = (normally off) for verbose run :l +{scalar1} = fluid thermal conductivity \[W/(m*K)\] :l +{scalar2} = fluid specific heat capacity \[W*s/(kg*K)\] :l +{scalar3} = (optional, default 1e30) limit maximal turbulence :l +{switch1} = (optional, default false) for verbose run :l +{switch2} = (optional, default false) flag to use interpolated void fraction and fluid velocity values :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -47,22 +52,28 @@ forceModels ); LaEuScalarTempProps \{ - velFieldName "U"; - tempFieldName "T"; + velFieldName "U"; + tempFieldName "T"; voidfractionFieldName "voidfraction"; - partTempName "Temp"; - partHeatFluxName "convectiveHeatFlux"; - lambda 0.0256; - Cp 1007; + partTempName "Temp"; + partHeatFluxName "convectiveHeatFlux"; + lambda 0.0256; + Cp 1007; \} :pre [Description:] -This "forceModel" does not influence the particles or the fluid flow! Using the particles' temperature a scalar field representing "particle-fluid heatflux" is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112 +This "force model" does not influence the particles or the fluid flow! Using the +particles' temperature a scalar field representing "particle-fluid heat flux" is +calculated. The solver then uses this source field in the scalar transport +equation for the temperature. The model for convective heat transfer is based on +Li and Mason (2000), A computational investigation of transient heat transfer in +pneumatic transport of granular particles, Pow.Tech 112 [Restrictions:] -Goes only with cfdemSolverScalar. The force model has to be the second (!!!) model in the forces list. +Goes only with cfdemSolverPisoScalar. The force model has to be the second (!!!) +model in the forces list. [Related commands:] diff --git a/doc/forceModel_MeiLift.html b/doc/forceModel_MeiLift.html deleted file mode 100644 index e21aa8b2..00000000 --- a/doc/forceModel_MeiLift.html +++ /dev/null @@ -1,64 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- MeiLift
-);
-MeiLiftProps
-{
- velFieldName "U";
- useSecondOrderTerms;
- interpolation "switch1";
- verbose "switch2";
-};
-
-Examples: -
-forceModels
-(
- MeiLift
-);
-MeiLiftProps
-{
- velFieldName "U";
- useSecondOrderTerms;
- interpolation true;
- verbose true;
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The MeiLift model calculates the lift force for each particle based on Loth and Dorgan (2009). In case the keyword "useSecondOrderTerms" is not specified, this lift force model uses the expression of McLaughlin (1991, Journal of Fluid Mechanics 224:261-274). -
-Restrictions: -
-None. -
-Related commands: -
- - diff --git a/doc/forceModel_MeiLift.txt b/doc/forceModel_MeiLift.txt index 205a5978..de006c5b 100644 --- a/doc/forceModel_MeiLift.txt +++ b/doc/forceModel_MeiLift.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_MeiLift command :h3 +forceModel MeiLift command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,16 +18,20 @@ forceModels ); MeiLiftProps \{ - velFieldName "U"; + velFieldName "U"; useSecondOrderTerms; - interpolation "switch1"; - verbose "switch2"; -\}; :pre + treatForceExplicit switch1; + verbose switch2; + interpolation switch3; + scalarViscosity switch4; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{useSecondOrderTerms} = switch to activate second order terms in the lift force model :l -{switch1} = switch to activate tri-linear interpolation of the flow quantities at the particle position :l -{switch2} = switch to activate the report of per-particle quantities to the screen :l +{useSecondOrderTerms} = (optional, default false) switch to activate second order terms in the lift force model :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) switch to activate the report of per-particle quantities to the screen :l +{switch3} = (optional, default false) switch to activate tri-linear interpolation of the flow quantities at the particle position :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -37,19 +42,23 @@ forceModels ); MeiLiftProps \{ - velFieldName "U"; + velFieldName "U"; useSecondOrderTerms; - interpolation true; - verbose true; + interpolation true; + verbose true; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The MeiLift model calculates the lift force for each particle based on Loth and Dorgan (2009). In case the keyword "useSecondOrderTerms" is not specified, this lift force model uses the expression of McLaughlin (1991, Journal of Fluid Mechanics 224:261-274). +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {MeiLift} model calculates +the lift force for each particle based on Loth and Dorgan (2009). In case the +keyword "useSecondOrderTerms" is not specified, this lift force model uses the +expression of McLaughlin (1991, J. Fluid Mech. 224:261-274). [Restrictions:] -None. +none [Related commands:] diff --git a/doc/forceModel_SchillerNaumannDrag.html b/doc/forceModel_SchillerNaumannDrag.html deleted file mode 100644 index 7ff1ecae..00000000 --- a/doc/forceModel_SchillerNaumannDrag.html +++ /dev/null @@ -1,52 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- SchillerNaumannDrag
-);
-SchillerNaumannDragProps
-{
- velFieldName "U";
-};
-
-Examples: -
-forceModels
-(
- SchillerNaumannDrag
-);
-SchillerNaumannDragProps
-{
- velFieldName "U";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The SchillerNaumannDrag model is a model that calculates the particle based drag force following the correlation of Schiller and Naumann. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_SchillerNaumannDrag.txt b/doc/forceModel_SchillerNaumannDrag.txt index aaa1c8a8..7c243739 100644 --- a/doc/forceModel_SchillerNaumannDrag.txt +++ b/doc/forceModel_SchillerNaumannDrag.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_SchillerNaumannDrag command :h3 +forceModel SchillerNaumannDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -18,9 +19,11 @@ forceModels SchillerNaumannDragProps \{ velFieldName "U"; -\}; :pre + treatForceExplicit switch1; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -36,11 +39,14 @@ SchillerNaumannDragProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The SchillerNaumannDrag model is a model that calculates the particle based drag force following the correlation of Schiller and Naumann. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {SchillerNaumannDrag} model +is a model that calculates the particle based drag force following the +correlation of Schiller and Naumann. [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_ShirgaonkarIB.html b/doc/forceModel_ShirgaonkarIB.html deleted file mode 100644 index 27e0ddc4..00000000 --- a/doc/forceModel_ShirgaonkarIB.html +++ /dev/null @@ -1,60 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- ShirgaonkarIB
-);
-ShirgaonkarIBProps
-{
- velFieldName "U";
- pressureFieldName "pressure";
-};
-
-Examples: -
-forceModels
-(
- ShirgaonkarIB
-);
-ShirgaonkarIBProps
-{
- velFieldName "U";
- pressureFieldName "p";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): "A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion", Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method. -
-References: -
-SHIRGAONKAR, A.A., MACIVER, M.A. and PATANKAR, N.A., (2009), “A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion”, J. Comput. Phys., 228, 2366-2390. -
-Restrictions: -
-Only for immersed boundary solvers. -
-Related commands: -
- - diff --git a/doc/forceModel_ShirgaonkarIB.txt b/doc/forceModel_ShirgaonkarIB.txt index 87cae6ce..313b18c3 100644 --- a/doc/forceModel_ShirgaonkarIB.txt +++ b/doc/forceModel_ShirgaonkarIB.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_ShirgaonkarIB command :h3 +forceModel ShirgaonkarIB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,12 +18,16 @@ forceModels ); ShirgaonkarIBProps \{ - velFieldName "U"; + velFieldName "U"; pressureFieldName "pressure"; -\}; :pre + twoDimensional; + treatForceExplicit switch1; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l {pressure} = name of the finite volume pressure field :l +{twoDimensional} = optional keyword for conducting a two dimensional calculation :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -39,11 +44,12 @@ ShirgaonkarIBProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): "A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion", Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method. - -[References:] - -SHIRGAONKAR, A.A., MACIVER, M.A. and PATANKAR, N.A., (2009), “A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion”, J. Comput. Phys., 228, 2366-2390. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {ShirgaonkarIB} model +calculates the drag force (viscous and pressure force) acting on each particle +in a resolved manner (see "Shirgaonkar et al. (2009)"_#Shirgaonkar2009). +This model is only suited for resolved CFD-DEM simulations where +the particle is represented by immersed boundary method. [Restrictions:] @@ -53,3 +59,11 @@ Only for immersed boundary solvers. "forceModel"_forceModel.html +:line + +:link(Shirgaonkar2009) +[(Shirgaonkar, 2009)] Shirgaonkar, A. A., MacIver, M. A. and Patankar, N. A., (2009), +"A new mathematical formulation and fast algorithm for fully resolved simulation +of self-propulsion", J. Comput. Phys., 228, pp. 2366-2390. + + diff --git a/doc/forceModel_dSauter.html b/doc/forceModel_dSauter.html deleted file mode 100644 index 4f8050e3..00000000 --- a/doc/forceModel_dSauter.html +++ /dev/null @@ -1,47 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- dSauter
-);
-dSauterProps
-{
- coarseGrainingFactors
- (
- X Y Z
- );
-};
-
-Description: -
-This "forceModel" does not influence the particles or the flow - it calculates the Sauter diameter -
-
-. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_dSauter.txt b/doc/forceModel_dSauter.txt index 478c8dbd..298d0eb7 100644 --- a/doc/forceModel_dSauter.txt +++ b/doc/forceModel_dSauter.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_dSauter command :h3 +forceModel dSauter command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -21,15 +22,16 @@ dSauterProps ( X Y Z ); -\}; :pre - -{coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l +\} :pre +{coarseGrainingFactors} = list of coarse graining factors by type, separated by +whitespace, optional :ulb,l :ule [Description:] -This "forceModel" does not influence the particles or the flow - it calculates the Sauter diameter +This "force model" does not influence the particles or the flow - it calculates +the Sauter diameter :c,image(Eqs/d32.png) . @@ -37,8 +39,9 @@ This "forceModel" does not influence the particles or the flow - it calculates t [Restrictions:] -none. +none [Related commands:] -"forceModel"_forceModel.html \ No newline at end of file +"forceModel"_forceModel.html + diff --git a/doc/forceModel_fieldStore.html b/doc/forceModel_fieldStore.html deleted file mode 100644 index d21cbcb9..00000000 --- a/doc/forceModel_fieldStore.html +++ /dev/null @@ -1,68 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- fieldStore
-);
-fieldStoreProps
-{
- scalarFieldNames
- (
- "scalarField"
- );
- vectorFieldNames
- (
- "vectorField"
- );
-};
-
-Examples: -
-forceModels
-(
- fieldStore
-);
-fieldStoreProps
-{
- scalarFieldNames
- (
- "voidfraction"
- );
- vectorFieldNames
- (
- "U"
- );
-}
-
-Description: -
-This "forceModel" does not influence the particles or the flow - it is a tool to store a scalar/vector field! This is especially useful if you use a boundary condition which cannot interpreted correctly in your postporcessor (e.g. paraview). -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_fieldStore.txt b/doc/forceModel_fieldStore.txt index 2e8af443..b52d75ee 100644 --- a/doc/forceModel_fieldStore.txt +++ b/doc/forceModel_fieldStore.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_fieldStore command :h3 +forceModel fieldStore command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -25,7 +26,7 @@ fieldStoreProps ( "vectorField" ); -\}; :pre +\} :pre {scalarField} = names of the finite volume scalar fields to be stored :ulb,l {vectorField} = names of the finite volume vector fields to be stored :l @@ -51,11 +52,13 @@ fieldStoreProps [Description:] -This "forceModel" does not influence the particles or the flow - it is a tool to store a scalar/vector field! This is especially useful if you use a boundary condition which cannot interpreted correctly in your postporcessor (e.g. paraview). +This "force model" does not influence the particles or the flow - it is a tool +to store a scalar/vector field! This is especially useful if you use a boundary +condition which cannot interpreted correctly in your post-processor (e.g. paraview). [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_fieldTimeAverage.txt b/doc/forceModel_fieldTimeAverage.txt new file mode 100644 index 00000000..e2c454f9 --- /dev/null +++ b/doc/forceModel_fieldTimeAverage.txt @@ -0,0 +1,70 @@ +"CFDEMproject Website"_lws - "Main Page"_main :c + +:link(lws,http://www.cfdem.com) +:link(main,CFDEMcoupling_Manual.html) + +:line + +forceModel fieldTimeAverage command :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + fieldTimeAverage +); +fieldTimeAverageProps +\{ + startTime time; + scalarFieldNames + ( + "scalarField" + ); + vectorFieldNames + ( + "vectorField" + ); +\} :pre + +{time} = (optional) time to start temporal averaging :ulb,l +{scalarField} = names of the finite volume scalar fields to be temporally averaged :l +{vectorField} = names of the finite volume vector fields to be temporally averaged :l +:ule + +[Examples:] + +forceModels +( + fieldTimeAverage +); +fieldTimeAverageProps +\{ + startTime 1.0; + scalarFieldNames + ( + "voidfraction" + ); + vectorFieldNames + ( + "Us" + ); +\} :pre + +[Description:] + +This "force model" does not influence the particles or the simulation - it is a +post-processing tool! Starting at start time the specified fields are temporally +averaged and written at "writeTime". They can then be probed using standard +function object probes. The output name is timeAverage_scalarField, where +scalarField is the name of the original field. + +[Restrictions:] + +none + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceModel_gradPForce.html b/doc/forceModel_gradPForce.html deleted file mode 100644 index 661b4a0e..00000000 --- a/doc/forceModel_gradPForce.html +++ /dev/null @@ -1,60 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- gradPForce;
-);
-gradPForceProps
-{
- pFieldName "pressure";
- velocityFieldName "U";
- interpolation switch1;
-};
-
-Examples: -
-forceModels
-(
- gradPForce;
-);
-gradPForceProps
-{
- pFieldName "p";
- velocityFieldName "U";
- interpolation true;
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The gradPForce model is a model that calculates the particle based pressure gradient force -(grad(p)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability" ,JFM). -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_gradPForce.txt b/doc/forceModel_gradPForce.txt index 68a8b30c..c9db690d 100644 --- a/doc/forceModel_gradPForce.txt +++ b/doc/forceModel_gradPForce.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_gradPForce command :h3 +forceModel gradPForce command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,14 +18,20 @@ forceModels ); gradPForceProps \{ - pFieldName "pressure"; - velocityFieldName "U"; - interpolation switch1; -\}; :pre + pFieldName "pressure"; + velocityFieldName "U"; + useAddedMass scalar1; + treatForceExplicit switch1; + treatForceDEM switch2; + interpolation switch3; +\} :pre {pressure} = name of the finite volume fluid pressure field :ulb,l {U} = name of the finite volume fluid velocity field :l -{switch1} = flag to use interpolated pressure values (normally off) :l +{scalar1} = (optional, default 0) coefficient of added mass accounted for :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) flag to use interpolated pressure values :l :ule [Examples:] @@ -35,18 +42,22 @@ forceModels ); gradPForceProps \{ - pFieldName "p"; + pFieldName "p"; velocityFieldName "U"; - interpolation true; + interpolation true; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The gradPForce model is a model that calculates the particle based pressure gradient force -(grad(p)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability" ,JFM). +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {gradPForce} model is a +model that calculates the particle based pressure gradient force -(grad(p)) * +Vparticle (see Zhou et al. (2010): "Discrete particle simulation of +particle-fluid flow: model formulations and their applicability", J. Fluid Mech.). [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_interface.txt b/doc/forceModel_interface.txt new file mode 100644 index 00000000..45e07755 --- /dev/null +++ b/doc/forceModel_interface.txt @@ -0,0 +1,85 @@ +"CFDEMproject Website"_lws - "Main Page"_main :c + +:link(lws,http://www.cfdem.com) +:link(main,CFDEMcoupling_Manual.html) + +:line + +forceModel interface command :h3 + +[Syntax:] + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +forceModels +( + interface +); +interfaceProps +\{ + VOFvoidfractionFieldName "alpha"; + gradAlphaName "gradAlpha"; + alphaThreshold scalar1; + sigma scalar2; + theta scalar3; + deltaAlphaIn scalar4; + deltaAlphaOut scalar5; + C scalar6; + treatForceExplicit switch1; +\} :pre + +{alpha} = name of the finite volume fluid volume fraction field in a VOF simulation :ulb,l +{gradAlpha} = name of gradient fluid volume fraction field :l +{scalar1} = parameter used to define the distance of influence of the model :l +{scalar2} = fluid gas surface tension :l +{scalar3} = Three-phase contact angle for interface force :l +{scalar4} = delta value subtracted from alphaThreshold :l +{scalar5} = delta value added to alphaThreshold :l +{scalar6} = (optional, default 1.0) factor to scale interfacial force :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule + +[Examples:] + +forceModels +( + interface +); +interfaceProps +\{ + VOFvoidfractionFieldName "alpha"; + gradAlphaName "gradAlpha"; + alphaThreshold 0.55; + sigma 0.07; + theta 1.12; + deltaAlphaIn 0.05; + deltaAlphaOut 0.05; +\} :pre + +[Description:] + +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {interface} model is a +model that calculates the particle-fluid-gas interfacial force. +(see "Wierink et al. (2011)"_#Wierink2011) + +[Restrictions:] + +Only for VOF simulations. + +[Related commands:] + +"forceModel"_forceModel.html + +:line + +:link(Wierink2011) +[(Wierink 2011)] +"Mechanistic modelling of particle interface interaction in three phase flows", +Wierink G., Goniva C., Niceno B., Heiskanen K., +Proc. of the 8th Int. Conf. on CFD in Oil and Gas, Metallurgical and Process Industries, +Trondheim, Norway. + + + diff --git a/doc/forceModel_noDrag.html b/doc/forceModel_noDrag.html deleted file mode 100644 index 9baaa53f..00000000 --- a/doc/forceModel_noDrag.html +++ /dev/null @@ -1,45 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels -( - noDrag -); --
Examples: -
-forceModels -( - noDrag -); --
noDragProps (optional)
-{
- noDEMForce; (optional)
-};
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The noDrag model sets the forces acting on the particle to zero. If several force models are selected and noDrag is the last model being executed, the fluid particle force will be set to zero. If the variable noDEMForce is set, then the forces communicated to the DEM solver are also set to zero. -
-Restrictions: -
-None. -
-Related commands: -
- - diff --git a/doc/forceModel_noDrag.txt b/doc/forceModel_noDrag.txt index ec43c191..9e5d995b 100644 --- a/doc/forceModel_noDrag.txt +++ b/doc/forceModel_noDrag.txt @@ -1,40 +1,57 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_noDrag command :h3 +forceModel noDrag command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( noDrag ); :pre +noDragProps (optional) +\{ + noDEMForce; + keepCFDForce; + treatForceExplicit switch1; +\} :pre + +{noDEMForce} = (optional, default false) do not apply the previously calculated forces in DEM integration :ulb,l +{keepCFDForce} = (optional, default false) do not delete the previously calculated forces and use them in CFD source terms :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +:ule [Examples:] forceModels ( noDrag -); :pre - -noDragProps (optional) +) +noDragProps \{ - noDEMForce; (optional) -\}; :pre + noDEMForce; +\} :pre + [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The noDrag model sets the forces acting on the particle to zero. If several force models are selected and noDrag is the last model being executed, the fluid particle force will be set to zero. If the variable noDEMForce is set, then the forces communicated to the DEM solver are also set to zero. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {noDrag} model sets the +forces acting on the particle to zero. If several force models are selected and +noDrag is the last model being executed, the fluid particle force will be set to +zero. If the variable {noDEMForce} is set, then the forces communicated to the +DEM solver are also set to zero. [Restrictions:] -None. +none [Related commands:] diff --git a/doc/forceModel_particleCellVolume.html b/doc/forceModel_particleCellVolume.html deleted file mode 100644 index c34aa71e..00000000 --- a/doc/forceModel_particleCellVolume.html +++ /dev/null @@ -1,59 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- particleCellVolume
-);
-particleCellVolumeProps
-{
- upperThreshold value;
- lowerThreshold value2;
- verbose;
-};
-
-Examples: -
-forceModels
-(
- particleCellVolume
-);
-particleCellVolumeProps
-{
- upperThreshold 0.999;
- lowerThreshold 0;
- verbose;
-}
-
-Description: -
-This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles as they are represented on the CFD mesh is calculated. Further the total volume of the cells particles are in is calculated. -At "writeTime" a field named particleCellVolume , where scalarField is the name of the original field, is written. This can then be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given. -
-Restrictions: -
-None. -
-Related commands: -
- - diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt index 93b1dbfb..08162efb 100644 --- a/doc/forceModel_particleCellVolume.txt +++ b/doc/forceModel_particleCellVolume.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_particleCellVolume command :h3 +forceModel particleCellVolume command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,13 +18,15 @@ forceModels ); particleCellVolumeProps \{ - upperThreshold value; - lowerThreshold value2; + upperThreshold scalar1; + lowerThreshold scalar2; + startTime scalar3; verbose; -\}; :pre +\} :pre -{value} = only cells with a field value (magnitude) lower than this upper threshold are considered :l -{value2} = only cells with a field value (magnitude) greater than this lower threshold are considered :l +{scalar1} = only cells with a field value (magnitude) lower than this upper threshold are considered :l +{scalar2} = only cells with a field value (magnitude) greater than this lower threshold are considered :l +{scalar3} = (optional, default 0) start time of volume calculation and output :l :ule [Examples:] @@ -41,12 +44,19 @@ particleCellVolumeProps [Description:] -This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles as they are represented on the CFD mesh is calculated. Further the total volume of the cells particles are in is calculated. -At "writeTime" a field named particleCellVolume , where scalarField is the name of the original field, is written. This can then be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given. +This "force model" does not influence the particles or the simulation - it is a +post-processing tool! The total volume of the particles as they are represented +on the CFD mesh is calculated. Further the total volume of the cells particles +are in is calculated. + +At "writeTime" a field named particleCellVolume, where scalarField is the name +of the original field, is written. This can then be probed using standard +function object probes. Analogously a field named cellVolume is written. Using +the {verbose} option a screen output is given. [Restrictions:] -None. +none [Related commands:] diff --git a/doc/forceModel_pdCorrelation.html b/doc/forceModel_pdCorrelation.html deleted file mode 100644 index c838e5e2..00000000 --- a/doc/forceModel_pdCorrelation.html +++ /dev/null @@ -1,58 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- pdCorrelation
-);
-pdCorrelationProps
-{
- coarseGrainingFactors
- (
- X Y Z
- );
- particleDensities
- (
- A B C
- );
- runOnWriteOnly true;
-};
-
-Description: -
-This "forceModel" does not influence the particles or the flow - it calculates the particle momentum-diameter correlation -
-
-where delta is the type-specific coarsegraining factor. -
-This model is sensitive to additionally pulled particle type info, and can either use the type-specific densities from the dict or those pulled from LIGGGHTS. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_pdCorrelation.txt b/doc/forceModel_pdCorrelation.txt index 34049c96..f390b0b7 100644 --- a/doc/forceModel_pdCorrelation.txt +++ b/doc/forceModel_pdCorrelation.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_pdCorrelation :h3 +forceModel pdCorrelation :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -26,7 +27,7 @@ pdCorrelationProps A B C ); runOnWriteOnly true; -\}; :pre +\} :pre {coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l {particleDensities} = list of particle densities by type, separated by whitespace, optional :l @@ -37,17 +38,21 @@ pdCorrelationProps [Description:] -This "forceModel" does not influence the particles or the flow - it calculates the particle momentum-diameter correlation +This "forceModel" does not influence the particles or the flow - it calculates +the particle momentum-diameter correlation :c,image(Eqs/pdCorrelation.png) -where delta is the type-specific coarsegraining factor. +where delta is the type-specific coarse-graining factor. -This model is sensitive to additionally pulled particle type info, and can either use the type-specific densities from the dict or those pulled from LIGGGHTS. +This model is sensitive to additionally pulled particle type info, and can +either use the type-specific densities from the dictionary or those pulled from +LIGGGHTS. [Restrictions:] -none. +none [Related commands:] -"forceModel"_forceModel.html \ No newline at end of file +"forceModel"_forceModel.html + diff --git a/doc/forceModel_virtualMassForce.html b/doc/forceModel_virtualMassForce.html deleted file mode 100644 index 8c7499fc..00000000 --- a/doc/forceModel_virtualMassForce.html +++ /dev/null @@ -1,52 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- virtualMassForce
-);
-virtualMassForceProps
-{
- velFieldName "U";
-};
-
-Examples: -
-forceModels
-(
- virtualMassForce
-);
-virtualMassForceProps
-{
- velFieldName "U";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The virtualMassForce model calculates the virtual mass force for each particle. -
-Restrictions: -
-Model not validated! -
-Related commands: -
- - diff --git a/doc/forceModel_virtualMassForce.txt b/doc/forceModel_virtualMassForce.txt index 084371fe..537818a3 100644 --- a/doc/forceModel_virtualMassForce.txt +++ b/doc/forceModel_virtualMassForce.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_virtualMassForce command :h3 +forceModel virtualMassForce command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -18,9 +19,19 @@ forceModels virtualMassForceProps \{ velFieldName "U"; -\}; :pre + phiFieldName "phi"; + splitUrelCalculation switch1; + Cadd scalar1; + treatForceExplicit switch2; + interpolation switch3; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l +{phi} = name of the finite volume flux field :l +{switch1} = (optional, default false) indicator to split calculation of Urel between CFDEM and LIGGGHTS :l +{scalar1} = (optional, default 0.5) virtual mass coefficient :l +{switch2} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -32,15 +43,16 @@ forceModels virtualMassForceProps \{ velFieldName "U"; + phiFieldName "phi"; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The virtualMassForce model calculates the virtual mass force for each particle. +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {virtualMassForce} model +calculates the virtual mass force for each particle. -[Restrictions:] - -Model not validated! +IMPORTANT NOTE: Model not validated! [Related commands:] diff --git a/doc/forceModel_viscForce.html b/doc/forceModel_viscForce.html deleted file mode 100644 index cb233bf1..00000000 --- a/doc/forceModel_viscForce.html +++ /dev/null @@ -1,55 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-forceModels
-(
- viscForce;
-);
-viscForceProps
-{
- velocityFieldName "U";
- interpolation "switch";
-};
-
-Examples: -
-forceModels
-(
- viscForce;
-);
-viscForceProps
-{
- velocityFieldName "U";
-}
-
-Description: -
-The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM). -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceModel_viscForce.txt b/doc/forceModel_viscForce.txt index 6bcd3cbb..08baea2f 100644 --- a/doc/forceModel_viscForce.txt +++ b/doc/forceModel_viscForce.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceModel_viscForce command :h3 +forceModel viscForce command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. forceModels ( @@ -17,12 +18,20 @@ forceModels ); viscForceProps \{ - velocityFieldName "U"; - interpolation "switch"; -\}; :pre + velocityFieldName "U"; + useAddedMass scalar1; + treatForceExplicit switch1; + treatForceDEM switch2; + interpolation switch3; + scalarViscosity switch4; +\} :pre {U} = name of the finite volume fluid velocity field :ulb,l -{switch} = flag to use interpolated stress values (normally off) :l +{scalar1} = (optional, default 0) coefficient of added mass accounted for :l +{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l +{switch3} = (optional, default false) flag to use interpolated stress values :l +{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l :ule [Examples:] @@ -38,11 +47,15 @@ viscForceProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM). +The force model performs the calculation of forces (e.g. fluid-particle +interaction forces) acting on each DEM particle. The {viscForce} model +calculates the particle based viscous force, -(grad(tau)) * Vparticle +(see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: +model formulations and their applicability", J. Fluid Mech.). [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceModel_volWeightedAverage.txt b/doc/forceModel_volWeightedAverage.txt new file mode 100644 index 00000000..a5773317 --- /dev/null +++ b/doc/forceModel_volWeightedAverage.txt @@ -0,0 +1,80 @@ +"CFDEMproject Website"_lws - "Main Page"_main :c + +:link(lws,http://www.cfdem.com) +:link(main,CFDEMcoupling_Manual.html) + +:line + +forceModel volWeightedAverage command :h3 + +[Syntax:] + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +forceModels +( + volWeightedAverage +); +volWeightedAverageProps +\{ + startTime time; + scalarFieldNames + ( + scalarField + ); + vectorFieldNames + ( + vectorField + ); + upperThreshold scalar1; + lowerThreshold scalar2; + verbose; +\} :pre + +{time} = (optional, default 0.) time to start the averaging :ulb,l +{scalarField} = names of the finite volume scalar fields to be temporally averaged :l +{vectorField} = names of the finite volume vector fields to be temporally averaged :l +{scalar1} = only cells with a field value (magnitude) lower than this upper threshold are considered :l +{scalar2} = only cells with a field value (magnitude) greater than this lower threshold are considered :l +{verbose} = (optional, default false) keyword only (mostly used for debugging) :l +:ule + +[Examples:] + +forceModels +( + volWeightedAverage +); +volWeightedAverageProps +\{ + startTime 0.1; + scalarFieldNames + ( + voidfraction + ); + vectorFieldNames + ( + ); + upperThreshold 0.999; + lowerThreshold 0; +\} :pre + +[Description:] + +This "forceModel" does not influence the particles or the simulation - it is a +post-processing tool! Starting at start time the volume weighted averages of +those cells of the fields within the threshold are calculated. + +At "writeTime" a field named volAverage_field, where scalarField is the name of +the original field, is written. This can then be probed using standard function +object probes. + +[Restrictions:] + +Currently all fields have the same threshold value! + +[Related commands:] + +"forceModel"_forceModel.html + diff --git a/doc/forceSubModel.html b/doc/forceSubModel.html deleted file mode 100644 index 090c1c98..00000000 --- a/doc/forceSubModel.html +++ /dev/null @@ -1,49 +0,0 @@ - -Syntax: -
-Defined in couplingProperties sub-dictionary of the force model in use. If no force sub-model is applied ImEx is used as default. If the keyword "forceSubModels" is provided, a choice of sub model is demanded. -
-forceSubModels -( - model_x - model_y -); --
Examples: -
-forceSubModels -( - ImEx -); --
Note: This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation. -
-Description: -
-The force sub model is designed to hold the settings a force model can have. For now it handles the treatExplicit, treatDEM and implDEM option. -
-Restrictions: -
-None. -
-Related commands: -
-ImEx -
-Note: This examples list may be incomplete - please look for other models (forceSubModel_XY) in this documentation. -
-Default: none. -
- diff --git a/doc/forceSubModel.txt b/doc/forceSubModel.txt index 8d150a90..a6c8cc01 100644 --- a/doc/forceSubModel.txt +++ b/doc/forceSubModel.txt @@ -1,15 +1,18 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceSubModel command :h3 +forceSubModels command :h3 [Syntax:] -Defined in couplingProperties sub-dictionary of the force model in use. If no force sub-model is applied ImEx is used as default. If the keyword "forceSubModels" is provided, a choice of sub model is demanded. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +sub-dictionary of the force model in use. If no force sub-model is applied, ImEx +is used as default. If the keyword "forceSubModels" is provided, a choice of +sub-model is demanded. forceSubModels ( @@ -26,20 +29,53 @@ forceSubModels ImEx ); :pre -Note: This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(forceSubModel XY) in this documentation. [Description:] -The force sub model is designed to hold the settings a force model can have. For now it handles the treatExplicit, treatDEM and implDEM option. +The force sub model is designed to hold the settings a force model can have. +Depending on the availability within the respective force model, the following +options are handled: + +{treatForceExplicit} - switch for the purely explicit consideration of the force +term in the equation of motion on the CFD side (off -> the force is considered +semi-implicitly; default off) :ulb,l +{treatForceDEM} - switch for the consideration of the forces on the DEM side only +(off -> calculate forces for DEM and CFD; default off) :l +{implForceDEM} - If true, the fluid velocity and drag coefficient are communicated +to the DEM calculation at each coupling time step and the drag force is +calculated at each DEM time step, using the current particle velocity. +If false, a force term is communicated to the DEM calculation at each coupling +time step, the term is constant for one coupling interval. +(on -> DEM forces are updated every DEM step; default off) :l +{verbose} - switch for debug output to screen (on -> enable debug output; default +off) :l +{interpolation} - switch for the usage of interpolation models when getting data +for the Lagrangian calculation from Eulerian fields; +f false, the cell centre values are used. (default off) :l +{useFilteredDragModel} - switch for using a coarse-grid version of the Beetstra +drag model (takes grid-size effects into account; default = off) :l +{useParcelSizeDependentFilteredDrag} - switch for using a coarse-grid version of +the Beetstra drag model (takes parcel-size effects into account, will force the +switch useFilteredDragModel to "on"; default = off) :l +{implForceDEMaccumulated} - Can only be used in combination with implForceDEM +switch, drag force values of each DEM time step are accumulated and passed on to +the CFD-calculation. (default off) :l +{scalarViscosity} - switch for the usage of a user-defined viscosity nu for the +calculation of the drag force; The CFD calculation always uses the value of the +transport model. (off -> use transportProperties nu; default off) :l +:ule [Restrictions:] -None. +none [Related commands:] "ImEx"_forceSubModel_ImEx.html -Note: This examples list may be incomplete - please look for other models (forceSubModel_XY) in this documentation. +[Default:] + +none -[Default:] none. diff --git a/doc/forceSubModel_ImEx.html b/doc/forceSubModel_ImEx.html deleted file mode 100644 index 43b92d46..00000000 --- a/doc/forceSubModel_ImEx.html +++ /dev/null @@ -1,45 +0,0 @@ - -Syntax: -
-Defined in couplingProperties sub-dictionary of the force model in use. -
-forceSubModels -( - ImEx; -); -
-treatExplicit true; // optional for some force models. -treatDEM true; // optional for some force models. -implDEM true; // optional for some force models. -
-Examples: -
-forceSubModels -( - ImEx; -); -treatExplicit true; // optional for some force models. -
-Description: -
-If no force sub-model is applied ImEx is used as default. If the keyword "forceSubModels" is provided, a choice of sub model is demanded. Depending on the force model different keywords are read and can therefrore be set (see the log file). If the keyword is provided, its value is used. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceSubModel_ImEx.txt b/doc/forceSubModel_ImEx.txt index e81f55e1..ebbdac82 100644 --- a/doc/forceSubModel_ImEx.txt +++ b/doc/forceSubModel_ImEx.txt @@ -1,24 +1,33 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceSubModel_ImEx command :h3 +forceSubModel ImEx command :h3 [Syntax:] -Defined in couplingProperties sub-dictionary of the force model in use. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +sub-dictionary of the force model in use. forceSubModels ( ImEx; -); +); :pre -treatExplicit true; // optional for some force models. -treatDEM true; // optional for some force models. -implDEM true; // optional for some force models. +Optional for some force models: + +treatForceExplicit true; +treatForceDEM true; +implForceDEM true; +verbose true; +interpolation true; +useFilteredDragModel true; +useParcelSizeDependentFilteredDrag true; +implForceDEMaccumulated true; +scalarViscosity true; :pre [Examples:] @@ -26,15 +35,18 @@ forceSubModels ( ImEx; ); -treatExplicit true; // optional for some force models. +treatForceExplicit true; // optional for some force models. :pre [Description:] - If no force sub-model is applied ImEx is used as default. If the keyword "forceSubModels" is provided, a choice of sub model is demanded. Depending on the force model different keywords are read and can therefrore be set (see the log file). If the keyword is provided, its value is used. +If no force sub-model is applied {ImEx} is used as default. If the keyword +"forceSubModels" is provided, a choice of sub model is demanded. Depending on +the force model different keywords are read and can therefore be set +(see the log file). If the keyword is provided, its value is used. [Restrictions:] -none. +none [Related commands:] diff --git a/doc/forceSubModel_ImExCorr.html b/doc/forceSubModel_ImExCorr.html deleted file mode 100644 index 215cb415..00000000 --- a/doc/forceSubModel_ImExCorr.html +++ /dev/null @@ -1,46 +0,0 @@ - -Syntax: -
-Defined in couplingProperties sub-dictionary of the force model in use. -
-forceSubModels -( - ImExCorr; -); -
-treatExplicit true; // optional for some force models. -treatDEM true; // optional for some force models. -implDEM true; // optional for some force models. -explicitInterpCorr true; // optional for some force models. -
-Examples: -
-forceSubModels -( - ImExCorr; -); -treatExplicit true; // optional for some force models. -
-Description: -
-Same as ImEx, but it additionally reads "explicitInterpCorr" to correct the error steming from interpolation of Ufluid and averaging of Uparticles. -
-Restrictions: -
-none. -
-Related commands: -
- - diff --git a/doc/forceSubModel_ImExCorr.txt b/doc/forceSubModel_ImExCorr.txt index 666ffe11..85f6645c 100644 --- a/doc/forceSubModel_ImExCorr.txt +++ b/doc/forceSubModel_ImExCorr.txt @@ -1,25 +1,25 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -forceSubModel_ImExCorr command :h3 +forceSubModel ImExCorr command :h3 [Syntax:] -Defined in couplingProperties sub-dictionary of the force model in use. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +sub-dictionary of the force model in use. forceSubModels ( ImExCorr; ); - treatExplicit true; // optional for some force models. treatDEM true; // optional for some force models. implDEM true; // optional for some force models. -explicitInterpCorr true; // optional for some force models. +explicitInterpCorr true; // optional for some force models. :pre [Examples:] @@ -27,15 +27,17 @@ forceSubModels ( ImExCorr; ); -treatExplicit true; // optional for some force models. +treatExplicit true; // optional for some force models. :pre [Description:] - Same as ImEx, but it additionally reads "explicitInterpCorr" to correct the error steming from interpolation of Ufluid and averaging of Uparticles. +Same as "ImEx"_forceSubModel_ImEx.html, but it additionally reads +"explicitInterpCorr" to correct the error steming from interpolation of Ufluid +and averaging of Uparticles. [Restrictions:] -none. +none [Related commands:] diff --git a/doc/githubAccess_public.html b/doc/githubAccess_public.html deleted file mode 100644 index b27e7093..00000000 --- a/doc/githubAccess_public.html +++ /dev/null @@ -1,186 +0,0 @@ - -Description: -
-This routine describes how to set up a github account and pull repositories of the CFDEM(R)project. -After setting some environment variables LIGGGHTS(R) and CFDEM(R)coupling can be compiled -
-Procedure: -
-Basically the following steps have to be performed: -
-git clone the desired repository: -
-If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME: -
-cd --
mkdir LIGGGHTS --
cd LIGGGHTS --
To clone the public LIGGGHTS repository, open a terminal and execute: -
--git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC -
If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME: -
-cd --
mkdir CFDEM --
cd CFDEM --
Make sure that OpenFOAM(R) is already set up correctly! -
-To clone the public CFDEM(R)coupling repository, open a terminal and execute: -
--git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION -
Troubles? See Troubleshooting section below. -
-Update your repositories by git pull: -
-To get the latest version, open a terminal, go to the location of your local installation and type: -Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION ! -
-cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION -git stash -git pull --
Set Environment Variables: -
-Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc -
-gedit ~/.bashrc & --
add the lines (you find them also in .../cfdemParticle/etc/bashrc and cshrc respectively): -
-#================================================# -#- source cfdem env vars -export CFDEM_VERSION=PUBLIC -export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION -export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src -export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers -export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc -export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities -export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials -export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION -export CFDEM_bashrc=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc -export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src -export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic -export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src -export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src -. $CFDEM_bashrc -#================================================# --
Save the ~/.bashrc, open a new terminal and test the settings. The commands: -
-$CFDEM_PROJECT_DIR -$CFDEM_SRC_DIR -$CFDEM_LIGGGHTS_SRC_DIR --
should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly. -
-To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc. -
-If $CFDEM_SRC_DIR is set correctly, you can type -
-cfdemSysTest --
to get some information if the paths are set correctly. -
-Compile LIGGGHTS(R) and CFDEM(R)coupling: -
-If above settings were done correctly, you can compile LIGGGHTS(R) by typing: -
-cfdemCompLIG --
and you can then compile CFDEM(R)coupling by typing: -
-cfdemCompCFDEM --
You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias cfdemTestTUT. -Alternatively you can run each tutorial using the Allrun.sh scripts in the tutorial directories. -
-In case questions concerning the installation arise, please feel free to contact our forum at www.cfdem.com. -
-Run Your Own Cases: -
-If you want to run your own cases, please do so in $CFDEM_PROJECT_USER_DIR/run which is automatically being generated. E.g. copy one of the tutorial cases there, adapt it to your needs. -Changes in $CFDEM_TUT_DIR will be lost after every git stash! -
-Additional Installations: -
-Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: -
-sudo apt-get install python-numpy --
You can pull the latest version of lpp with: -
-cd $HOME/LIGGGHTS --
git clone git://cfdem.git.sourceforge.net/gitroot/cfdem/lpp mylpp --
Backwards Compatibility: -
-Basically CFDEM(R)coupling supports one OpenFOAM(R) version therefore all settings are prepared for that. Nevertheless we try to maintain backwards compatibility as long as it works with reasonable effort. -
-The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: -src/lagrangian/cfdemParticle/cfdTools/versionInfo.H -
-For using other versions you can manipulate: -src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H -(still not all functionality might work then!) -
-Troubleshooting: -
-a) The git protocol will not work if your computer is behind a firewall which blocks the relevant TCP port, you can use alternatively (write command in one line): -
-git clone https://user@github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git -CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION -
-b) If you face the error: "error: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed while accessing https://github.com/...", -
-please use: env GIT_SSL_NO_VERIFY=true git clone https://github... -
-(see http://stackoverflow.com/questions/3777075/https-github-access) -
-c) If you face the error: "Agent admitted failure to sign using the key. Permission denied (publickey).", after ssh -T git@github.com -
-please type: "ssh-add" -
-(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign) -
- diff --git a/doc/githubAccess_public.pdf b/doc/githubAccess_public.pdf deleted file mode 100644 index 13f6bb53..00000000 Binary files a/doc/githubAccess_public.pdf and /dev/null differ diff --git a/doc/githubAccess_public.txt b/doc/githubAccess_public.txt deleted file mode 100644 index f72df624..00000000 --- a/doc/githubAccess_public.txt +++ /dev/null @@ -1,169 +0,0 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c - -:link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) -:link(github,http://github.com) -:link(gitHelp,http://help.github.com/linux-set-up-git) - -:line -githubAccess_public :h3 -:line - -[Description:] - -This routine describes how to set up a github account and pull repositories of the CFDEM(R)project. -After setting some environment variables LIGGGHTS(R) and CFDEM(R)coupling can be compiled - -[Procedure:] - -Basically the following steps have to be performed: - -{git clone} the desired repository :ulb,l -update your repositories by {git pull} :l -set environment variables :l -compile LIGGGHTS(R) and CFDEM(R)coupling :l -run your own cases :l -:ule - -[{git clone} the desired repository:] - -If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME: - -cd :pre -mkdir LIGGGHTS :pre -cd LIGGGHTS :pre - -To clone the public LIGGGHTS repository, open a terminal and execute: - -git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC :pre,h6 - -If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME: - -cd :pre -mkdir CFDEM :pre -cd CFDEM :pre - -Make sure that OpenFOAM(R) is already set up correctly! - -To clone the public CFDEM(R)coupling repository, open a terminal and execute: - -git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION :pre,h6 - -Troubles? See Troubleshooting section below. - - -[Update your repositories by {git pull}:] - -To get the latest version, open a terminal, go to the location of your local installation and type: -{Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION !} - -cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION -git stash -git pull :pre - -[Set Environment Variables:] - -Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc - -gedit ~/.bashrc & :pre - -add the lines (you find them also in .../cfdemParticle/etc/bashrc and cshrc respectively): - -#================================================# -#- source cfdem env vars -export CFDEM_VERSION=PUBLIC -export CFDEM_PROJECT_DIR=$HOME/CFDEM/CFDEMcoupling-$CFDEM_VERSION-$WM_PROJECT_VERSION -export CFDEM_SRC_DIR=$CFDEM_PROJECT_DIR/src -export CFDEM_SOLVER_DIR=$CFDEM_PROJECT_DIR/applications/solvers -export CFDEM_DOC_DIR=$CFDEM_PROJECT_DIR/doc -export CFDEM_UT_DIR=$CFDEM_PROJECT_DIR/applications/utilities -export CFDEM_TUT_DIR=$CFDEM_PROJECT_DIR/tutorials -export CFDEM_PROJECT_USER_DIR=$HOME/CFDEM/$LOGNAME-$CFDEM_VERSION-$WM_PROJECT_VERSION -export CFDEM_bashrc=$CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc -export CFDEM_LIGGGHTS_SRC_DIR=$HOME/LIGGGHTS/LIGGGHTS-PUBLIC/src -export CFDEM_LIGGGHTS_MAKEFILE_NAME=fedora_fpic -export CFDEM_LPP_DIR=$HOME/LIGGGHTS/mylpp/src -export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src -. $CFDEM_bashrc -#================================================# :pre - -Save the ~/.bashrc, open a new terminal and test the settings. The commands: - -$CFDEM_PROJECT_DIR -$CFDEM_SRC_DIR -$CFDEM_LIGGGHTS_SRC_DIR :pre - -should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly. - -To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc. - -If $CFDEM_SRC_DIR is set correctly, you can type - -cfdemSysTest :pre - -to get some information if the paths are set correctly. - -[Compile LIGGGHTS(R) and CFDEM(R)coupling:] - -If above settings were done correctly, you can compile LIGGGHTS(R) by typing: - -cfdemCompLIG :pre - -and you can then compile CFDEM(R)coupling by typing: - -cfdemCompCFDEM :pre - -You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias {cfdemTestTUT}. -Alternatively you can run each tutorial using the {Allrun.sh} scripts in the tutorial directories. - -In case questions concerning the installation arise, please feel free to contact our forum at www.cfdem.com. - -[Run Your Own Cases:] - -If you want to run your own cases, please do so in $CFDEM_PROJECT_USER_DIR/run which is automatically being generated. E.g. copy one of the tutorial cases there, adapt it to your needs. -Changes in $CFDEM_TUT_DIR will be lost after every {git stash}! - -[Additional Installations:] - -Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: - -sudo apt-get install python-numpy :pre - -You can pull the latest version of lpp with: - -cd $HOME/LIGGGHTS :pre -git clone git://cfdem.git.sourceforge.net/gitroot/cfdem/lpp mylpp :pre - -[Backwards Compatibility:] - -Basically CFDEM(R)coupling supports one OpenFOAM(R) version therefore all settings are prepared for that. Nevertheless we try to maintain backwards compatibility as long as it works with reasonable effort. - -The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: -src/lagrangian/cfdemParticle/cfdTools/versionInfo.H - -For using other versions you can manipulate: -src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H -(still not all functionality might work then!) - -[Troubleshooting:] - -Troubles with git clone? :ulb,l -:ule - -[a)] The git protocol will not work if your computer is behind a firewall which blocks the relevant TCP port, you can use alternatively (write command in one line): - -git clone https://user@github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git -CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION - -[b)] If you face the error: "error: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed while accessing https://github.com/...", - -please use: env GIT_SSL_NO_VERIFY=true git clone https://github... - -(see http://stackoverflow.com/questions/3777075/https-github-access) - - -[c)] If you face the error: "Agent admitted failure to sign using the key. Permission denied (publickey).", after ssh -T git@github.com - -please type: "ssh-add" - -(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign) diff --git a/doc/liggghtsCommandModel.html b/doc/liggghtsCommandModel.html deleted file mode 100644 index 2c0ca7e6..00000000 --- a/doc/liggghtsCommandModel.html +++ /dev/null @@ -1,44 +0,0 @@ - -Syntax: -
-Defined in liggghtsCommmands dictionary. -
-liggghtsCommandModels -( - model_x - model_y -); --
Examples: -
-liggghtsCommandModels -( - runLiggghts - writeLiggghts -); --
Note: This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation. -
-Description: -
-The liggghtsCommandModel is the base class to execute DEM commands within a CFD run. -
-Restrictions: -
-Works only with MPI coupling. -
-Default: none. -
- diff --git a/doc/liggghtsCommandModel.txt b/doc/liggghtsCommandModel.txt index 37fbe266..41797b98 100644 --- a/doc/liggghtsCommandModel.txt +++ b/doc/liggghtsCommandModel.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -liggghtsCommandModel command :h3 +liggghtsCommandModels command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( @@ -27,14 +28,19 @@ liggghtsCommandModels writeLiggghts ); :pre -Note: This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(liggghtsCommandModel XY) in this documentation. [Description:] -The liggghtsCommandModel is the base class to execute DEM commands within a CFD run. +The liggghtsCommandModel is the base class to execute DEM commands within a CFD +run. -[Restrictions:] +[Restrictions:] Works only with MPI coupling. -[Default:] none. +[Default:] + +none + diff --git a/doc/liggghtsCommandModel_execute.html b/doc/liggghtsCommandModel_execute.html deleted file mode 100644 index 58909fe3..00000000 --- a/doc/liggghtsCommandModel_execute.html +++ /dev/null @@ -1,97 +0,0 @@ - -Syntax: -
-Defined in liggghtsCommmands dictionary. -
-liggghtsCommandModels
-(
- execute
-);
-executeProps0
-{
- command
- (
- run
- $couplingInterval
- );
- runFirst switch1;
- runLast switch2;
- runEveryCouplingStep switch3;
- runEveryWriteStep switch4;
- verbose;
-}
-
-Examples: -
-liggghtsCommandModels
-(
- execute
- execute
-);
-executeProps0
-{
- command
- (
- run
- $couplingInterval
- );
- runFirst off;
- runLast off;
- runEveryCouplingStep on;
-}
-executeProps1
-{
- command
- (
- write_restart
- noBlanks
- dotdot
- slash
- DEM
- slash
- liggghts.restart_
- timeStamp
- );
- runFirst off;
- runLast off;
- runEveryCouplingStep off;
- runEveryWriteStep on;
-}
-
-Description: -
-The execute liggghtsCommand Model can be used to execute a LIGGGHTS command during a CFD run. In above example execute_0 for instance executes "run $couplingInterval" every coupling step. $couplingInterval is automatically replaced by the correct number of DEM steps. Additionally execute_1 executes "write_restart ../DEM/liggghts.restart_$timeStamp" every writing step, where $timeStamp is automatically set. -
-Restrictions: None. -
-Related commands: -
- - diff --git a/doc/liggghtsCommandModel_execute.txt b/doc/liggghtsCommandModel_execute.txt index 5db5f2af..7e61c19f 100644 --- a/doc/liggghtsCommandModel_execute.txt +++ b/doc/liggghtsCommandModel_execute.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -liggghtsCommandModel_execute command :h3 +liggghtsCommandModel execute command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( @@ -22,18 +23,18 @@ executeProps0 run $couplingInterval ); - runFirst switch1; - runLast switch2; + runFirst switch1; + runLast switch2; runEveryCouplingStep switch3; - runEveryWriteStep switch4; + runEveryWriteStep switch4; verbose; \} :pre -{command} = LIGGGHTS command to be executed. Each word in a new line, numbers and symbols need special treatment (e.g. $couplingInterval will be replaced by correct coupling interval in the simulation) :ulb,l -{switch1} = switch (choose on/off) if the command is executed only at first time step :l -{switch2} = switch (choose on/off) if the command is executed only at last time step :l -{switch3} = switch (choose on/off) if the command is executed at every coupling step :l -{switch4} = switch (choose on/off) if the command is executed at every writing step :l +{command} = LIGGGHTS command to be executed. Each word in a new line, numbers and symbols need special treatment (e.g. $couplingInterval will be replaced by correct coupling interval in the simulation) :ulb,l +{switch1} = (optional, default off) if the command is executed only at first time step :l +{switch2} = (optional, default off) if the command is executed only at last time step (requires {switch1} to be off) :l +{switch3} = (optional, default off) if the command is executed at every coupling step (requires {switch1} and {switch2} to be off) :l +{switch4} = (optional, default off) if the command is executed at every writing step (requires {switch1} to {switch3} to be off) :l {verbose} = (normally off) for verbose run :l :ule @@ -51,8 +52,8 @@ executeProps0 run $couplingInterval ); - runFirst off; - runLast off; + runFirst off; + runLast off; runEveryCouplingStep on; \} executeProps1 @@ -68,19 +69,27 @@ executeProps1 liggghts.restart_ timeStamp ); - runFirst off; - runLast off; + runFirst off; + runLast off; runEveryCouplingStep off; - runEveryWriteStep on; + runEveryWriteStep on; \} :pre [Description:] -The execute liggghtsCommand Model can be used to execute a LIGGGHTS command during a CFD run. In above example execute_0 for instance executes "run $couplingInterval" every coupling step. $couplingInterval is automatically replaced by the correct number of DEM steps. Additionally execute_1 executes "write_restart ../DEM/liggghts.restart_$timeStamp" every writing step, where $timeStamp is automatically set. +The {execute} liggghtsCommandModel can be used to execute a LIGGGHTS command +during a CFD run. In above example {execute_0} for instance executes +"run $couplingInterval" every coupling step. {$couplingInterval} is automatically +replaced by the correct number of DEM steps. Additionally, {execute_1} executes +"write_restart ../DEM/liggghts.restart_$timeStamp" every writing step, where +{$timeStamp} is automatically set. -These rather complex execute commands can be replaced by the "readLiggghts" and "writeLiggghts" commands! :h4 +NOTE: These rather complex execute commands can be replaced by the +{runLiggghts} and {writeLiggghts} commands! -[Restrictions:] None. +[Restrictions:] + +none [Related commands:] diff --git a/doc/liggghtsCommandModel_readLiggghtsData.html b/doc/liggghtsCommandModel_readLiggghtsData.html deleted file mode 100644 index 1981d499..00000000 --- a/doc/liggghtsCommandModel_readLiggghtsData.html +++ /dev/null @@ -1,49 +0,0 @@ - -Syntax: -
-Defined in liggghtsCommmands dictionary. -
-liggghtsCommandModels
-(
- readLiggghtsData
-);
-readLiggghtsDataProps0
-{
- ???
-}
-
-Examples: -
-liggghtsCommandModels
-(
- readLiggghtsData
- readLiggghtsData
-);
-readLiggghtsDataProps0
-{
- ???
-}
-
-Description: -
-The readLiggghtsData liggghtsCommand Model can be used to ??? -
-Restrictions: -
-Note: Model is not up to date. -
-Related commands: -
- - diff --git a/doc/liggghtsCommandModel_readLiggghtsData.txt b/doc/liggghtsCommandModel_readLiggghtsData.txt index 510ab556..29e9d71c 100644 --- a/doc/liggghtsCommandModel_readLiggghtsData.txt +++ b/doc/liggghtsCommandModel_readLiggghtsData.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -liggghtsCommandModel_readLiggghtsData command :h3 +liggghtsCommandModel readLiggghtsData command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( @@ -17,30 +18,58 @@ liggghtsCommandModels ); readLiggghtsDataProps0 \{ - ??? + startIndex scalar1; + verbose; + exactTiming; + filePath + ( + "word" + ); + startTime scalar2; + endTime scalar3; + timeInterval scalar4; \} :pre +{scalar1} = start index of data file to be read; the index is appended to {filePath} :ulb,l +{verbose} = (default off) flag for verbose run :l +{exactTiming} = flag indicating that start time should be kept even during a coupling interval :l +{filePath} = path to LIGGGHTS data file. Each word starts in a new line; special characters, i.e. dots and slashes, need special treatment (e.g. dotdot will be replaced by "..") :l +{scalar2} = start reading at this time :l +{scalar3} = end reading at this time :l +{scalar4} = repeat reading at this time interval while increasing the data file index :l +:ule [Examples:] liggghtsCommandModels ( readLiggghtsData - readLiggghtsData ); readLiggghtsDataProps0 \{ - ??? + startIndex 0; + exactTiming; + filePath + ( + dotdot + slash + DEM + slash + packing.data + ); + startTime 0.002; + endTime 0.012; + timeInterval 0.001; \} :pre [Description:] -The readLiggghtsData liggghtsCommand Model can be used to ??? +The {readLiggghtsData} liggghtsCommandModel can be used to read LIGGGHTS data +files into LIGGGHTS during runtime of a coupled simulation. This corresponds to +the {read_data} command in LIGGGHTS with the {add} option, i.e. read in +particles are added to existing particles. - -[Restrictions:] - -Note: Model is not up to date. +IMPORTANT NOTE: Model is outdated. [Related commands:] diff --git a/doc/liggghtsCommandModel_runLiggghts.html b/doc/liggghtsCommandModel_runLiggghts.html deleted file mode 100644 index b9ad8864..00000000 --- a/doc/liggghtsCommandModel_runLiggghts.html +++ /dev/null @@ -1,44 +0,0 @@ - -Syntax: -
-Defined in liggghtsCommmands dictionary. -
-liggghtsCommandModels
-(
- runLiggghts
-);
-//- optional
-runLiggghtsProps
-{
- preNo true;
- verbose; (optional)
-}
-
-Examples: -
-liggghtsCommandModels -( - runLiggghts -); --
Description: -
-The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD run. The "runLiggghts" command executes the command "run $nrDEMsteps", where $nrDEMsteps is automatically set according to the coupling intervals, every coupling step. Optionally a dictionary called runLiggghtsProps can be specified where the "preNo" switch can be set, which uses the command "run $nrDEMsteps pre no" for every time step except the first. -
-Restrictions: Warning: the "pre no" option can cause troubles (dump data of particles changing the domain might be erroneous)! -
-Related commands: -
- - diff --git a/doc/liggghtsCommandModel_runLiggghts.txt b/doc/liggghtsCommandModel_runLiggghts.txt index a1f0ef41..48a9e12f 100644 --- a/doc/liggghtsCommandModel_runLiggghts.txt +++ b/doc/liggghtsCommandModel_runLiggghts.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -liggghtsCommandModel_runLiggghts command :h3 +liggghtsCommandModel runLiggghts command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( @@ -31,9 +32,19 @@ liggghtsCommandModels [Description:] -The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD run. The "runLiggghts" command executes the command "run $nrDEMsteps", where $nrDEMsteps is automatically set according to the coupling intervals, every coupling step. Optionally a dictionary called runLiggghtsProps can be specified where the "preNo" switch can be set, which uses the command "run $nrDEMsteps pre no" for every time step except the first. +The LIGGGHTS command models can be used to execute a LIGGGHTS command during a +CFD run. The {runLiggghts} command executes the command "run $nrDEMsteps", where +$nrDEMsteps is automatically set according to the coupling intervals, every +coupling step. -[Restrictions:] Warning: the "pre no" option can cause troubles (dump data of particles changing the domain might be erroneous)! +Optionally a dictionary called runLiggghtsProps can be specified where the +"preNo" switch can be set, which uses the command "run $nrDEMsteps pre no" for +every time step except the first. + +[Restrictions:] + +IMPORTANT NOTE: the "pre no" option can cause troubles (dump data of particles +changing the domain might be erroneous)! [Related commands:] diff --git a/doc/liggghtsCommandModel_writeLiggghts.html b/doc/liggghtsCommandModel_writeLiggghts.html deleted file mode 100644 index 1fa64a67..00000000 --- a/doc/liggghtsCommandModel_writeLiggghts.html +++ /dev/null @@ -1,56 +0,0 @@ - -Syntax: -
-Defined in liggghtsCommmands dictionary. -
-liggghtsCommandModels
-(
- writeLiggghts
-);
-//- optional
-writeLiggghtsProps
-{
- writeLast switch1;
- writeName "name";
- overwrite switch2;
- verbose;
-}
-
-Examples: -
-liggghtsCommandModels -( - runLiggghts - writeLiggghts -); --
Description: -
-The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD write. The "writeLiggghts" command executes the command "write_restart $name", where $name is the name of the restart file, every write step. -
-Restrictions: None. -
-Related commands: -
- - diff --git a/doc/liggghtsCommandModel_writeLiggghts.txt b/doc/liggghtsCommandModel_writeLiggghts.txt index 7bd7a3d1..a1e0e204 100644 --- a/doc/liggghtsCommandModel_writeLiggghts.txt +++ b/doc/liggghtsCommandModel_writeLiggghts.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -liggghtsCommandModel_writeLiggghts command :h3 +liggghtsCommandModel writeLiggghts command :h3 [Syntax:] -Defined in liggghtsCommmands dictionary. +Defined in "liggghtsCommmands"_CFDEMcoupling_dicts.html#liggghtsCommands +dictionary. liggghtsCommandModels ( @@ -19,15 +20,17 @@ liggghtsCommandModels writeLiggghtsProps \{ writeLast switch1; + path "path"; writeName "name"; overwrite switch2; verbose; \} :pre -{switch1} = switch (choose on/off) to select if only last step is stored or every write step (default on). :ulb,l -{name} = name of the restart file to be written in /$caseDir/DEM/ default (default "liggghts.restartCFDEM") :l -{switch2} = switch (choose on/off) to select if only one restart file $name or many files $name_$timeStamp are written (default off):l -{verbose} = (default off) for verbose run :l +{switch1} = (optional, default on) select if only last step is stored or every write step :ulb,l +{path} = (optional, default "../DEM") alternative path (relative to execution directory) for saving the restart file :l +{name} = (optional, default "liggghts.restartCFDEM") name of the restart file to be written in ../DEM/ :l +{switch2} = (optional, default off) select if only one restart file $name or multiple files $name_$timeStamp are written :l +{verbose} = (optional, default off) for verbose run :l :ule [Examples:] @@ -40,9 +43,14 @@ liggghtsCommandModels [Description:] -The liggghtsCommand models can be used to execute a LIGGGHTS command during a CFD write. The "writeLiggghts" command executes the command "write_restart $name", where $name is the name of the restart file, every write step. +The LIGGGHTS command models can be used to execute a LIGGGHTS command during a +CFD write. The {writeLiggghts} command executes the command +"write_restart $name" - where $name is the name of the restart file - every +write step. -[Restrictions:] None. +[Restrictions:] + +none [Related commands:] diff --git a/doc/locateModel.html b/doc/locateModel.html deleted file mode 100644 index 58c59a0f..00000000 --- a/doc/locateModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-locateModel model; --
Examples: -
-locateModel engine; --
Note: This examples list might not be complete - please look for other models (locateModel_XY) in this documentation. -
-Description: -
-The locateModel is the base class for models which search for the CFD cell and cellID corresponding to a position. In general it is used to find the cell a particle is located in. -
-Restrictions: none. -
-Default: none. -
- diff --git a/doc/locateModel.txt b/doc/locateModel.txt index b18b9e46..ca02400b 100644 --- a/doc/locateModel.txt +++ b/doc/locateModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ locateModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel model; :pre @@ -19,12 +20,20 @@ model = name of the locateModel to be applied :ul locateModel engine; :pre -Note: This examples list might not be complete - please look for other models (locateModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(locateModel XY) in this documentation. [Description:] -The locateModel is the base class for models which search for the CFD cell and cellID corresponding to a position. In general it is used to find the cell a particle is located in. +The locateModel is the base class for models which search for the CFD cell and +cellID corresponding to a position. In general it is used to find the cell a +particle is located in. -[Restrictions:] none. +[Restrictions:] + +none + +[Default:] + +none -[Default:] none. diff --git a/doc/locateModel_engineSearch.html b/doc/locateModel_engineSearch.html deleted file mode 100644 index c68e36f2..00000000 --- a/doc/locateModel_engineSearch.html +++ /dev/null @@ -1,51 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-locateModel engine;
-engineProps
-{
- treeSearch switch1;
-}
-
-Examples: -
-locateModel engine;
-engineProps
-{
- treeSearch true;
-}
-
-Description: -
-The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. -The engineSearch locate Model can be used with different settings to use different algorithms: -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/locateModel_engineSearch.txt b/doc/locateModel_engineSearch.txt index fce11bff..7f14f086 100644 --- a/doc/locateModel_engineSearch.txt +++ b/doc/locateModel_engineSearch.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -locateModel_engineSearch command :h3 +locateModel engine command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel engine; engineProps @@ -30,14 +31,18 @@ engineProps [Description:] -The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. -The engineSearch locate Model can be used with different settings to use different algorithms: +The locateModel {engine} locates the CFD cell and cellID corresponding to a +given position. +The {engine} locate Model can be used with different settings to use different +algorithms: -treeSearch false; will execute some geometric (linear) search using the last known cellID :ulb,l -treeSearch true; will use a recursive tree structure to find the cell (recommended). :l +treeSearch false; will execute some geometric (linear) search using the last known cellID :ulb,l +treeSearch true; will use a recursive tree structure to find the cell (recommended). :l :ule -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] diff --git a/doc/locateModel_engineSearchIB.html b/doc/locateModel_engineSearchIB.html deleted file mode 100644 index 16ec8ce5..00000000 --- a/doc/locateModel_engineSearchIB.html +++ /dev/null @@ -1,70 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-locateModel engineIB;
-engineIBProps
-{
- engineProps
- {
- treeSearch switch1;
- }
- zSplit value1;
- xySplit value2;
-}
-
-Examples: -
-locateModel engineIB;
-engineIBProps
-{
- engineProps
- {
- treeSearch false;
- }
- zSplit 8;
- xySplit 16;
-}
-
-Description: -
-The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. This locate model is especially designed for parallel immersed boundary method. Each particle is represented by "satellite points" if it is distributed over several processors. -
-The engineSearchIB locate Model can be used with different settings to use different algorithms: -
-This model is a modification of the engine search model. Instead of using the centre-cell as starting point for the engine search, further satellite points located on the surface of the sphere are checked. This ensures that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another. -
-Restrictions: -
-Only for immersed boundary solvers! -
-Related commands: -
- - diff --git a/doc/locateModel_engineSearchIB.txt b/doc/locateModel_engineSearchIB.txt index 08b66a1b..fcfeabf9 100644 --- a/doc/locateModel_engineSearchIB.txt +++ b/doc/locateModel_engineSearchIB.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -locateModel_engineSearchIB command :h3 +locateModel engineIB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel engineIB; engineIBProps @@ -18,7 +19,7 @@ engineIBProps \{ treeSearch switch1; \} - zSplit value1; + zSplit value1; xySplit value2; \} :pre @@ -36,21 +37,30 @@ engineIBProps \{ treeSearch false; \} - zSplit 8; + zSplit 8; xySplit 16; \} :pre [Description:] -The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. This locate model is especially designed for parallel immersed boundary method. Each particle is represented by "satellite points" if it is distributed over several processors. +The locateModel {engineIB} locates the CFD cell and cellID corresponding to a +given position. This locate model is especially designed for parallel immersed +boundary method. Each particle is represented by "satellite points" if it is +distributed over several processors. -The engineSearchIB locate Model can be used with different settings to use different algorithms: +The {engineIB} locate Model can be used with different settings to use different +algorithms: -treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) :ulb,l -treeSearch true; will use a recursive tree structure to find the cell. :l +treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) :ulb,l +treeSearch true; will use a recursive tree structure to find the cell. :l :ule -This model is a modification of the engine search model. Instead of using the centre-cell as starting point for the engine search, further satellite points located on the surface of the sphere are checked. This ensures that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another. +This model is a modification of the {engine} search model. Instead of using the +centre-cell as starting point for the engine search, further satellite points +located on the surface of the sphere are checked. This ensures that (parts of) +spheres can be located even when their centre is on another processor. This is +especially important for parallel computations, when a sphere is about to move +from one processor to another. [Restrictions:] diff --git a/doc/locateModel_engineSearchMany2Many.html b/doc/locateModel_engineSearchMany2Many.html deleted file mode 100644 index fba74cd4..00000000 --- a/doc/locateModel_engineSearchMany2Many.html +++ /dev/null @@ -1,59 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-locateModel engineSearchMany2Many;
-engineSearchMany2ManyProps
-{
- engineProps
- {
- treeSearch switch1;
- }
-}
-
-switch1 = switch to use tree search algorithm
-
-
-Examples: -
-locateModel engineSearchMany2Many;
-engineSearchMany2ManyProps
-{
- engineProps
- {
- treeSearch true;
- }
-}
-
-Description: -
-The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. This model is a dummy for the "twoWayMany2Many" dataExchangeModel which locates using the specified "engine" during coupling. Using this model with any other dataExchangeModel will cause problems. -
-The engineSearchMany2Many locateModel can be used with different settings to use different algorithms: -
-Restrictions: -
-Use only with the twoWayMany2Many dataExchangeModel! -
-Related commands: -
- - diff --git a/doc/locateModel_engineSearchMany2Many.txt b/doc/locateModel_engineSearchMany2Many.txt index b171c315..a39aba99 100644 --- a/doc/locateModel_engineSearchMany2Many.txt +++ b/doc/locateModel_engineSearchMany2Many.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -locateModel_engineSearchMany2Many command :h3 +locateModel engineSearchMany2Many command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel engineSearchMany2Many; engineSearchMany2ManyProps @@ -36,12 +37,20 @@ engineSearchMany2ManyProps [Description:] -The locateModel "engine" locates the CFD cell and cellID corresponding to a given position. This model is a dummy for the "twoWayMany2Many" dataExchangeModel which locates using the specified "engine" during coupling. Using this model with any other dataExchangeModel will cause problems. +The locateModel "engine" locates the CFD cell and cellID corresponding to a +given position. +This model is a dummy for the +"twoWayMany2Many dataExchangeModel"_dataExchangeModel_twoWayMany2Many.html which +locates using the specified "engine" during coupling. -The engineSearchMany2Many locateModel can be used with different settings to use different algorithms: +NOTE: Using this model with any other dataExchangeModel will cause problems. -treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended) :ulb,l -treeSearch true; will use a recursive tree structure to find the cell. :l +The {engineSearchMany2Many} locateModel can be used with different settings to +use different algorithms: + +treeSearch false; will execute some geometric (linear) search using the last +known cellID (recommended) :ulb,l +treeSearch true; will use a recursive tree structure to find the cell. :l :ule [Restrictions:] diff --git a/doc/locateModel_standardSearch.html b/doc/locateModel_standardSearch.html deleted file mode 100644 index d5e37a0a..00000000 --- a/doc/locateModel_standardSearch.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-locateModel standard; --
Examples: -
-locateModel standard; --
Description: -
-The locateModel "standard" locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/locateModel_standardSearch.txt b/doc/locateModel_standardSearch.txt index 84fb1db8..3afd6324 100644 --- a/doc/locateModel_standardSearch.txt +++ b/doc/locateModel_standardSearch.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -locateModel_standardSearch command :h3 +locateModel standard command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel standard; :pre @@ -19,10 +20,13 @@ locateModel standard; :pre [Description:] -The locateModel "standard" locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used. +The locateModel {standard} locates the CFD cell and cellID corresponding to a +given position. A very straight-forward (robust!) locate algorithm is used. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] diff --git a/doc/locateModel_turboEngineSearch.html b/doc/locateModel_turboEngineSearch.html deleted file mode 100644 index 7adacd7b..00000000 --- a/doc/locateModel_turboEngineSearch.html +++ /dev/null @@ -1,51 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-locateModel turboEngine;
-turboEngineProps
-{
- treeSearch switch1;
-}
-
-Examples: -
-locateModel turboEngine;
-turboEngineProps
-{
- treeSearch true;
-}
-
-Description: -
-The locateModel "turboEngine" locates the CFD cell and cellID corresponding to a given position. The algorithm is improved compared to engine search to show better parallel performance. -
-The turboEngineSearch locate Model can be used with different settings to use different algorithms: -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/locateModel_turboEngineSearch.txt b/doc/locateModel_turboEngineSearch.txt index 6e79ead4..73836d85 100644 --- a/doc/locateModel_turboEngineSearch.txt +++ b/doc/locateModel_turboEngineSearch.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -locateModel_turboEngineSearch command :h3 +locateModel turboEngine command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. locateModel turboEngine; turboEngineProps @@ -30,15 +31,22 @@ turboEngineProps [Description:] -The locateModel "turboEngine" locates the CFD cell and cellID corresponding to a given position. The algorithm is improved compared to engine search to show better parallel performance. +The locateModel {turboEngine} locates the CFD cell and cellID corresponding to a +given position. The algorithm is improved compared to engine search to show +better parallel performance. -The turboEngineSearch locate Model can be used with different settings to use different algorithms: +The turboEngineSearch locate Model can be used with different settings to use +different algorithms: -faceDecomp false; treeSearch false; will execute some geometric (linear) search using the last known cellID :ulb,l -faceDecomp false; treeSearch true; will use a recursive tree structure to find the cell. (recommended):l +faceDecomp false; treeSearch false; will execute some geometric (linear) search +using the last known cellID :ulb,l +faceDecomp false; treeSearch true; will use a recursive tree structure to find +the cell. (recommended) :l :ule -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] diff --git a/doc/meshMotionModel.html b/doc/meshMotionModel.html deleted file mode 100644 index c056b6b4..00000000 --- a/doc/meshMotionModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-meshMotionModel model; --
Examples: -
-meshMotionModel noMeshMotion; --
Note: This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation. -
-Description: -
-The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion. -
-Restrictions: none. -
-Default: none. -
- diff --git a/doc/meshMotionModel.txt b/doc/meshMotionModel.txt index 60410ed0..569870d6 100644 --- a/doc/meshMotionModel.txt +++ b/doc/meshMotionModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ meshMotionModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. meshMotionModel model; :pre @@ -19,12 +20,19 @@ model = name of the meshMotionModel to be applied :ul meshMotionModel noMeshMotion; :pre -Note: This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(meshMotionModel XY) in this documentation. [Description:] -The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion. +The {meshMotionModel} is the base class for models which manipulate the CFD mesh +according to the DEM mesh motion. -[Restrictions:] none. +[Restrictions:] + +none + +[Default:] + +none -[Default:] none. diff --git a/doc/meshMotionModel_noMeshMotion.html b/doc/meshMotionModel_noMeshMotion.html deleted file mode 100644 index 5f166bd4..00000000 --- a/doc/meshMotionModel_noMeshMotion.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-meshMotionModel noMeshMotion; --
Examples: -
-meshMotionModel noMeshMotion; --
Description: -
-The noMeshMotion-model is a dummy meshMotion model. -
-Restrictions: None. -
-Related commands: -
- - diff --git a/doc/meshMotionModel_noMeshMotion.txt b/doc/meshMotionModel_noMeshMotion.txt index ca47a35b..f8ab98b7 100644 --- a/doc/meshMotionModel_noMeshMotion.txt +++ b/doc/meshMotionModel_noMeshMotion.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -meshMotionModel_noMeshMotion command :h3 +meshMotionModel noMeshMotion command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. meshMotionModel noMeshMotion; :pre @@ -19,9 +20,11 @@ meshMotionModel noMeshMotion; :pre [Description:] -The noMeshMotion-model is a dummy meshMotion model. +The {noMeshMotion} model is a dummy mesh motion model. -[Restrictions:] None. +[Restrictions:] + +none [Related commands:] diff --git a/doc/momCoupleModel.html b/doc/momCoupleModel.html deleted file mode 100644 index 3a37c23a..00000000 --- a/doc/momCoupleModel.html +++ /dev/null @@ -1,45 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-momCoupleModels -( - model -); --
Examples: -
-momCoupleModels -( - implicitCouple -); --
Note: This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation. -
-Forces can be coupled in an implicit way to the fluid solver (i.e., when solving the Navier-Stokes equations, the fluid velocity at the new time will be considered for the coupling force). This implicit coupling is typically done for the drag forces (look for "impForces()" in the implementation of the drag model). Implicit coupling is more stable (especially important for dense flows), but conflicts Newton's third law. Explicit forces are imposed on the flow solver in an explicit fashion (look for "expForces()" in the implementation of the drag model), which is less stable, but does not conflict Newton's third law. -
-Note that the variable "imExSplitFactor" can be set in the couplingProperties in order to treat implicitly defined forces (in the implementation of the force model) as explicit ones. "imExSplitFactor 1.0;" is set by default, meaning that all implicit forces will be considered implicitly, whereas "imExSplitFactor 0.0;" would mean that implicitly defined forces will be treated in an explicit fashion. -
-Note that the switch "treatVoidCellsAsExplicitForce true;" can be set in the couplingProperties in order to change the treatment of cells which are void of particles. This is only relevant if (i) smoothing is used, and (ii) implicit force coupling is performed. By default, the particle veloctiy field (Us) will be smoothed to obtain a meaningful reference quantity for the implicit force coupling. In case "treatVoidCellsAsExplicitForce true;" is set, however, Us will not be smoothed and implicit forces (after the smoothing has been performed) in cells void of particles be treated as explicit ones. This avoids the problem of defining Us in cells that are void of particles, but for which an implicit coupling force is obtained in the smoothing process. -Description: -
-The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation. -
-Restrictions: none. -
-Default: none. -
- diff --git a/doc/momCoupleModel.txt b/doc/momCoupleModel.txt index 0a7dbf2f..c0c6ca15 100644 --- a/doc/momCoupleModel.txt +++ b/doc/momCoupleModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ momCoupleModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( @@ -25,17 +26,46 @@ momCoupleModels implicitCouple ); :pre -Note: This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(momCoupleModel XY) in this documentation. -Forces can be coupled in an implicit way to the fluid solver (i.e., when solving the Navier-Stokes equations, the fluid velocity at the new time will be considered for the coupling force). This implicit coupling is typically done for the drag forces (look for "impForces()" in the implementation of the drag model). Implicit coupling is more stable (especially important for dense flows), but conflicts Newton's third law. Explicit forces are imposed on the flow solver in an explicit fashion (look for "expForces()" in the implementation of the drag model), which is less stable, but does not conflict Newton's third law. - -Note that the variable "imExSplitFactor" can be set in the couplingProperties in order to treat implicitly defined forces (in the implementation of the force model) as explicit ones. "imExSplitFactor 1.0;" is set by default, meaning that all implicit forces will be considered implicitly, whereas "imExSplitFactor 0.0;" would mean that implicitly defined forces will be treated in an explicit fashion. - -Note that the switch "treatVoidCellsAsExplicitForce true;" can be set in the couplingProperties in order to change the treatment of cells which are void of particles. This is only relevant if (i) smoothing is used, and (ii) implicit force coupling is performed. By default, the particle veloctiy field (Us) will be smoothed to obtain a meaningful reference quantity for the implicit force coupling. In case "treatVoidCellsAsExplicitForce true;" is set, however, Us will not be smoothed and implicit forces (after the smoothing has been performed) in cells void of particles be treated as explicit ones. This avoids the problem of defining Us in cells that are void of particles, but for which an implicit coupling force is obtained in the smoothing process. [Description:] -The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation. +Forces can be coupled in an implicit way to the fluid solver (i.e., when solving +the Navier-Stokes equations, the fluid velocity at the new time will be +considered for the coupling force). This implicit coupling is typically done for +the drag forces (look for "impForces()" in the implementation of the drag model). +Implicit coupling is more stable (especially important for dense flows), but +conflicts Newton's third law. Explicit forces are imposed on the flow solver in +an explicit fashion (look for "expForces()" in the implementation of the drag +model), which is less stable, but does not conflict Newton's third law. -[Restrictions:] none. +Note that the variable {imExSplitFactor} can be set in the couplingProperties in +order to treat implicitly defined forces (in the implementation of the force +model) as explicit ones. {imExSplitFactor 1.0;} is set by default, meaning that +all implicit forces will be considered implicitly, whereas +{imExSplitFactor 0.0;} would mean that implicitly defined forces will be treated +in an explicit fashion. + +Note that the switch {treatVoidCellsAsExplicitForce true;} can be set in the +couplingProperties in order to change the treatment of cells which are void of +particles. This is only relevant if (i) smoothing is used, and (ii) implicit +force coupling is performed. By default, the particle velocity field (Us) will +be smoothed to obtain a meaningful reference quantity for the implicit force +coupling. In case {treatVoidCellsAsExplicitForce true;} is set, however, Us will +not be smoothed and implicit forces (after the smoothing has been performed) in +cells void of particles be treated as explicit ones. This avoids the problem of +defining Us in cells that are void of particles, but for which an implicit +coupling force is obtained in the smoothing process. + +The {momCoupleModel} is the base class for momentum exchange between DEM and CFD +simulation. + +[Restrictions:] + +none + +[Default:] + +none -[Default:] none. diff --git a/doc/momCoupleModel_explicitCouple.html b/doc/momCoupleModel_explicitCouple.html deleted file mode 100644 index ac6b5ba5..00000000 --- a/doc/momCoupleModel_explicitCouple.html +++ /dev/null @@ -1,52 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-momCoupleModels
-(
- explicitCouple
-);
-explicitCoupleProps
-{
- fLimit vector;
-}
-
-Examples: -
-momCoupleModels
-(
- explicitCouple
-);
-explicitCoupleProps
-{
- fLimit (1e3 1e2 1e4);
-}
-
-Description: -
-The explicitCouple-model is a momCoupleModel model providing an explicit momentum source term for the CFD solver. -
-Restrictions: -
-Only for solvers that include explicit momentum exchange. -
-Related commands: -
- - diff --git a/doc/momCoupleModel_explicitCouple.txt b/doc/momCoupleModel_explicitCouple.txt index bdcb4655..4a3fe422 100644 --- a/doc/momCoupleModel_explicitCouple.txt +++ b/doc/momCoupleModel_explicitCouple.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -momCoupleModel_explicitCouple command :h3 +momCoupleModel explicitCouple command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( @@ -36,7 +37,8 @@ explicitCoupleProps [Description:] -The explicitCouple-model is a momCoupleModel model providing an explicit momentum source term for the CFD solver. +The {explicitCouple} model is a momCoupleModel model providing an explicit +momentum source term for the CFD solver. [Restrictions:] diff --git a/doc/momCoupleModel_implicitCouple.html b/doc/momCoupleModel_implicitCouple.html deleted file mode 100644 index f2b1a00a..00000000 --- a/doc/momCoupleModel_implicitCouple.html +++ /dev/null @@ -1,62 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-momCoupleModels
-(
- implicitCouple
-);
-implicitCoupleProps
-{
- velFieldName "U";
- granVelFieldName "Us";
- voidfractionFieldName "voidfraction";
- minAlphaP number;
-}
-
-Examples: -
-momCoupleModels
-(
- implicitCouple
-);
-implicitCoupleProps
-{
- velFieldName "U";
- granVelFieldName "Us";
- voidfractionFieldName "voidfraction";
-}
-
-Description: -
-The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver. -
-Restrictions: -
-Only for solvers that include implicit momentum exchange. -
-Related commands: -
- - diff --git a/doc/momCoupleModel_implicitCouple.txt b/doc/momCoupleModel_implicitCouple.txt index 08433eec..c1b4bf84 100644 --- a/doc/momCoupleModel_implicitCouple.txt +++ b/doc/momCoupleModel_implicitCouple.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -momCoupleModel_implicitCouple command :h3 +momCoupleModel implicitCouple command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( @@ -17,16 +18,18 @@ momCoupleModels ); implicitCoupleProps \{ - velFieldName "U"; - granVelFieldName "Us"; + velFieldName "U"; + granVelFieldName "Us"; voidfractionFieldName "voidfraction"; - minAlphaP number; + KslLimit scalar1; + minAlphaP scalar2; \} :pre {U} = name of the finite volume fluid velocity field :ulb,l {Us} = name of the finite volume granular velocity field :l -{voidfraction} = name of the finite volume voidfraction field :l -{number} = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l +{voidfraction} = name of the finite volume void fraction field :l +{scalar1} = (optional, default 1e10) limit implicit momentum exchange field :l +{scalar2} = (optional, default SMALL) minimum value for local particle volume fraction to calculate the exchange field :l :ule [Examples:] @@ -37,14 +40,15 @@ momCoupleModels ); implicitCoupleProps \{ - velFieldName "U"; - granVelFieldName "Us"; + velFieldName "U"; + granVelFieldName "Us"; voidfractionFieldName "voidfraction"; \} :pre [Description:] -The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver. +The {implicitCouple} model is a momCoupleModel model providing an implicit +momentum source term for the CFD solver. [Restrictions:] diff --git a/doc/momCoupleModel_noCouple.html b/doc/momCoupleModel_noCouple.html deleted file mode 100644 index 0ec1e601..00000000 --- a/doc/momCoupleModel_noCouple.html +++ /dev/null @@ -1,40 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-momCoupleModels -( - off -); --
Examples: -
-momCoupleModels -( - off -); --
Description: -
-The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver. -
-Restrictions: -
-Only for solvers that include no momentum exchange, e.g. immersed boundary. -
-Related commands: -
- - diff --git a/doc/momCoupleModel_noCouple.txt b/doc/momCoupleModel_noCouple.txt index 6972d30c..22bcfcdd 100644 --- a/doc/momCoupleModel_noCouple.txt +++ b/doc/momCoupleModel_noCouple.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -momCoupleModel_noCouple command :h3 +momCoupleModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. momCoupleModels ( @@ -26,7 +27,8 @@ momCoupleModels [Description:] -The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver. +The {off} model is a dummy momCoupleModel model providing a no momentum source +term for the CFD solver. [Restrictions:] diff --git a/doc/probeModel.html b/doc/probeModel.html deleted file mode 100644 index 72309a36..00000000 --- a/doc/probeModel.html +++ /dev/null @@ -1,42 +0,0 @@ - -Syntax: -
-To be activated via couplingProperties dictionary. -
-probeModel myProbeModel; --
Use probe model "off" to disable this feature. -
-myProbeModelProps --
{
-
-}; --
Examples: -
-See particleProbe -
-Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. -
-Description: -
-The probeModel feature allows to implement various probing features in CFDEM. Currently, only the particleProbe model is implemented, that performs probing of particle forces. -
-Restrictions: -
-None. -
-Default: none. -
- diff --git a/doc/probeModel.txt b/doc/probeModel.txt index 64826ed1..75882da1 100644 --- a/doc/probeModel.txt +++ b/doc/probeModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,30 +9,41 @@ probeModel command :h3 [Syntax:] -To be activated via couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -probeModel myProbeModel; :pre - -Use probe model "off" to disable this feature. - -myProbeModelProps :pre -\{ :pre - -\}; :pre +probeModel model; +modelProps +\{ +\} :pre +model = name of the probeModel to be applied :ul [Examples:] -See "particleProbe"_probeModel_particleProbe.html +probeModel off; :pre -Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. +NOTE: This examples list might not be complete - please check below for the list +of probe models that can perform particle probing. [Description:] -The probeModel feature allows to implement various probing features in CFDEM. Currently, only the "particleProbe"_probeModel_particleProbe.html model is implemented, that performs probing of particle forces. +The {probeModel} feature allows to implement various probing features in CFDEM. +Currently, only the "particleProbe"_probeModel_particleProbe.html model is +implemented, that performs probing of particle forces. + +Use probe model {off} to disable this feature. [Restrictions:] -None. +none + +[Related commands:] + +"probeModel off"_probeModel_noProbe.html, +"probeModel particleProbe"_probeModel_particleProbe.html + +[Default:] + +none -[Default:] none. diff --git a/doc/probeModel_noProbe.html b/doc/probeModel_noProbe.html deleted file mode 100644 index 63021115..00000000 --- a/doc/probeModel_noProbe.html +++ /dev/null @@ -1,43 +0,0 @@ - -Syntax: -
-To be activated via couplingProperties dictionary. -
-forceModels
-{
- myForceModel1
- myForceModel2
- myForceModel3
-};
-
-Examples: -
-probeModel off; --
Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. -
-Description: -
-Does not perform any probing. -
-Restrictions: -
-None. -
-Related commands which are currently enabled for particle probing: -
- -Default: none. -
- diff --git a/doc/probeModel_noProbe.txt b/doc/probeModel_noProbe.txt index b36c75e0..0b806f8d 100644 --- a/doc/probeModel_noProbe.txt +++ b/doc/probeModel_noProbe.txt @@ -1,39 +1,39 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -probeModel_noProbe command :h3 +probeModel off command :h3 [Syntax:] -To be activated via couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -forceModels -\{ - myForceModel1 - myForceModel2 - myForceModel3 -\}; :pre +probeModel off; :pre [Examples:] probeModel off; :pre -Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing. +NOTE: This examples list might not be complete - please check below for the list +of models that can perform particle probing. [Description:] -Does not perform any probing. +This model does not perform any probing. [Restrictions:] -None. +none -[Related commands which are currently enabled for particle probing:] +[Related commands:] "particleProbe"_probeModel_particleProbe.html -[Default:] none. +[Default:] + +none + diff --git a/doc/probeModel_particleProbe.txt b/doc/probeModel_particleProbe.txt new file mode 100644 index 00000000..0d664b46 --- /dev/null +++ b/doc/probeModel_particleProbe.txt @@ -0,0 +1,102 @@ +"CFDEMproject Website"_lws - "Main Page"_main :c + +:link(lws,http://www.cfdem.com) +:link(main,CFDEMcoupling_Manual.html) + +:line + +probeModel particleProbe command :h3 + +[Syntax:] + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +forceModels +( + forceModel1 + forceModel2 + forceModel3 +); :pre + +probeModel particleProbe; :pre + +particleProbeProps +\{ + particleIDsToSample (ID1 ID2 ID3 ...); // list of particleIDs to sample + verboseToFile; // main switch + verbose; // currently not used + printEvery xEvery; // print every this many CFD time steps + sampleAll; // Activate sampling for all particles + probeDebug; // probes additional fields + includePosition; // will include particle position in the output file + writePrecision xPrecision; // number of significant digits to print +\} :pre + +{forceModeli} = list of force models in the simulation, the particleProbe will be applied to all of these models! :ulb,l +{particleIDsToSample} = list of particle IDs to be sampled. :l +{verboseToFile} = main switch to activate the particle probe (default = off). :l +{verbose} = main switch to activate output to Info (currently not implemented). :l +{xEvery} = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step). :l +{sampleAll} = switch to activate sampling of all particles. Otherwise (default) only particles specified via "particleIDsToSample" in the couplingProperties dictionary will be sampled. :l + +{probeDebug} = switch to activate probing of debug properties of secondary importance (specific for each force model). :l +{includePosition} = switch to add the particle position in the log file (default = off). :l +{xPrecision} = number of significant digits of the text output (default = 3). :l +:ule + +[Examples:] + +forceModels +( + gradPForce +); :pre + +probeModel particleProbe; :pre + +particleProbeProps +\{ + particleIDsToSample (0 1 2 3); + verboseToFile; // main switch + verbose; // currently not used + printEvery 100; // print every this many CFD time steps + sampleAll; // activate sampling for all particles + probeDebug; // probes additional fields + includePosition; // will include particle position in the output file + writePrecision 4; // number of significant digits to print +\}; :pre + +NOTE: This examples list might not be complete - please check below for the list +of models that can perform particle probing. + +[Description:] + +The {particleProbe} feature keeps track of per-particle quantities (e.g., the +fluid-particle interaction forces) acting on each DEM particle, and handles its +storage during the simulation. Data is saved in the +$caseDir/CFD/particleProbes/startTime directory, where {startTime} is the time +at which the simulation is started (this avoids unwanted deletion of +particleProbe data). + +[Restrictions:] + +none + +[Related commands:] + +The following force models are currently enabled for particle probing: + +Archimedes, ArchimedesIB, BeetstraDrag, DiFeliceDrag, GidaspowDrag, +KochHillDrag, SchillerNaumannDrag, ShirgaonkarIB, virtualMassForce, +"gradPForce"_forceModel_gradPForce.html, "viscForce"_forceModel_viscForce.html, +"MeiLift"_forceModel_MeiLift.html, that is most of the forceModels, see the +{src} directory for details, i.e. use + +grep -r 'probeM(' ./ :pre + +in a CLI terminal. + +[Default:] + +none + diff --git a/doc/regionModel.html b/doc/regionModel.html deleted file mode 100644 index 7d2304f6..00000000 --- a/doc/regionModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. -
-regionModel model; --
Examples: -
-regionModel allRegion; --
Note: This examples list might not be complete - please look for other models (regionModel_XY) in this documentation. -
-Description: -
-The regionModel is the base class for region models to select a certain region for coupled simulation. -
-Restrictions: none. -
-Default: none. -
- diff --git a/doc/regionModel.txt b/doc/regionModel.txt index e83d0132..880d09f3 100644 --- a/doc/regionModel.txt +++ b/doc/regionModel.txt @@ -1,15 +1,18 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line regionModel command :h3 -[Syntax:] +NOTE: In the current CFDEMcoupling version, this model is no longer used. -Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. + +[Syntax:] regionModel model; :pre @@ -19,12 +22,19 @@ model = name of the regionModel to be applied :ul regionModel allRegion; :pre -Note: This examples list might not be complete - please look for other models (regionModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(regionModel XY) in this documentation. [Description:] -The regionModel is the base class for region models to select a certain region for coupled simulation. +The {regionModel} is the base class for region models to select a certain region +for coupled simulation. -[Restrictions:] none. +[Restrictions:] + +none + +[Default:] + +none -[Default:] none. diff --git a/doc/regionModel_allRegion.html b/doc/regionModel_allRegion.html deleted file mode 100644 index 048c863e..00000000 --- a/doc/regionModel_allRegion.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. -
-regionModel allRegion; --
Examples: -
-regionModel allRegion; --
Description: -
-The allRegion-model is a region model including the whole CFD region for the coupling. -
-Restrictions: None. -
-Related commands: -
- - diff --git a/doc/regionModel_allRegion.txt b/doc/regionModel_allRegion.txt index c0e37441..92e88a7c 100644 --- a/doc/regionModel_allRegion.txt +++ b/doc/regionModel_allRegion.txt @@ -1,15 +1,18 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -regionModel_allRegion command :h3 +regionModel allRegion command :h3 [Syntax:] -Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary. +NOTE: In the current CFDEMcoupling version, this model is no longer used. + +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. regionModel allRegion; :pre @@ -19,9 +22,11 @@ regionModel allRegion; :pre [Description:] -The allRegion-model is a region model including the whole CFD region for the coupling. +The {allRegion} model is a region model including the whole CFD region for the coupling. -[Restrictions:] None. +[Restrictions:] + +none [Related commands:] diff --git a/doc/smoothingModel.html b/doc/smoothingModel.html deleted file mode 100644 index 78e8f23e..00000000 --- a/doc/smoothingModel.html +++ /dev/null @@ -1,38 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-smoothingModel model; --
Examples: -
-smoothingModel off; --
smoothingModel constDiffSmoothing; --
Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation. -
-ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. -
-Description: -
-The smoothingModel is the base class for models that smoothen the exchange fields (i.e., voidfraction and the Ksl field in case of implicit force coupling). This is relevant in case one uses a small grid resolution compared to the local particle diameter (or parcel diameter in case one uses a parcel approach). -
-Restrictions: These models are in beta testing. -
-Default: none. -
- diff --git a/doc/smoothingModel.txt b/doc/smoothingModel.txt index 903a4771..b190a273 100644 --- a/doc/smoothingModel.txt +++ b/doc/smoothingModel.txt @@ -1,7 +1,7 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line @@ -9,7 +9,8 @@ smoothingModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. smoothingModel model; :pre @@ -17,17 +18,30 @@ model = name of the smoothingModel to be applied :ul [Examples:] -smoothingModel off; :pre -smoothingModel constDiffSmoothing; :pre +smoothingModel off; +smoothingModel constDiffSmoothing; :pre -Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(smoothingModel XY) in this documentation. -ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. +IMPORTANT NOTE: In case a smoothing model is used in conjunction with +"PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial +time directory! This is because zeroGradient boundary conditions for the fields +"f" and "fSmooth" must be specified, otherwise the smoothing operation will give +an error. [Description:] -The smoothingModel is the base class for models that smoothen the exchange fields (i.e., voidfraction and the Ksl field in case of implicit force coupling). This is relevant in case one uses a small grid resolution compared to the local particle diameter (or parcel diameter in case one uses a parcel approach). +The {smoothingModel} is the base class for models that smoothen the exchange +fields (i.e., void fraction and the Ksl field in case of implicit force coupling). +This is relevant in case one uses a small grid resolution compared to the local +particle diameter (or parcel diameter in case one uses a parcel approach). -[Restrictions:] These models are in beta testing. +[Restrictions:] + +These models are in beta testing. + +[Default:] + +none -[Default:] none. diff --git a/doc/smoothingModel_constDiffSmoothing.html b/doc/smoothingModel_constDiffSmoothing.html deleted file mode 100644 index cf5904ab..00000000 --- a/doc/smoothingModel_constDiffSmoothing.html +++ /dev/null @@ -1,58 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-smoothingModel constDiffSmoothing;
-constDiffSmoothingProps
-{
- lowerLimit number1;
- upperLimit number2;
- smoothingLength lengthScale;
- smoothingLengthReferenceField lengthScaleRefField;
-}
-
-Examples: -
-constDiffSmoothingProps
-{
- lowerLimit 0.1;
- upperLimit 1e10;
- smoothingLength 1500e-6;
- smoothingLengthReferenceField 9000e-6;
-}
-
-Description: -
-The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothing the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit force coupling algorithms. -Smoothing for reference fields is performed to "fill in" values in cells in which these reference fields are not specified. Values calculated in the cells (via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, e.g., the average particle velocity, which are not specified in all cells in case the flow is rather dilute. -
-Restrictions: This model is tested in a limited number of flow situations. -
-ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. -
-Related commands: -
- - diff --git a/doc/smoothingModel_constDiffSmoothing.txt b/doc/smoothingModel_constDiffSmoothing.txt index 54f75cfd..9ff82ecd 100644 --- a/doc/smoothingModel_constDiffSmoothing.txt +++ b/doc/smoothingModel_constDiffSmoothing.txt @@ -1,50 +1,65 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -smoothingModel_constDiffSmoothing command :h3 +smoothingModel constDiffSmoothing command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. smoothingModel constDiffSmoothing; constDiffSmoothingProps \{ - lowerLimit number1; - upperLimit number2; - smoothingLength lengthScale; + lowerLimit number1; + upperLimit number2; + smoothingLength lengthScale; smoothingLengthReferenceField lengthScaleRefField; + verbose; \} :pre {number1} = scalar fields will be bound to this lower value :ulb,l {number2} = scalar fields will be bound to this upper value :l {lengthScale} = length scale over which the exchange fields will be smoothed out :l {lengthScaleRefField} = length scale over which reference fields (e.g., the average particle velocity) will be smoothed out. Should be always larger than lengthScale. If not specified, will be equal to lengthScale. :l +{verbose} = (optional, default false) flag for debugging output :l :ule [Examples:] constDiffSmoothingProps \{ - lowerLimit 0.1; - upperLimit 1e10; - smoothingLength 1500e-6; + lowerLimit 0.1; + upperLimit 1e10; + smoothingLength 1500e-6; smoothingLengthReferenceField 9000e-6; \} :pre [Description:] -The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothing the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit force coupling algorithms. -Smoothing for reference fields is performed to "fill in" values in cells in which these reference fields are not specified. Values calculated in the cells (via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, e.g., the average particle velocity, which are not specified in all cells in case the flow is rather dilute. +The {constDiffSmoothing} model is a basic smoothingModel model which reads a +smoothing length scale being used for smoothing the exchange fields +(void fraction, Ksl, f if present). This model can be used for smoothing explicit +force coupling fields, as well as implicit force coupling algorithms. +Smoothing for reference fields is performed to "fill in" values in cells in +which these reference fields are not specified. Values calculated in the cells +(via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, +e.g. the average particle velocity, which are not specified in all cells in case +the flow is rather dilute. -[Restrictions:] This model is tested in a limited number of flow situations. +[Restrictions:] -ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. +This model is tested in a limited number of flow situations. +IMPORTANT NOTE: In case a smoothing model is used in conjunction with +"PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial +time directory! This is because zeroGradient boundary conditions for the fields +"f" and "fSmooth" must be specified, otherwise the smoothing operation will give +an error. [Related commands:] diff --git a/doc/smoothingModel_noSmoothing.html b/doc/smoothingModel_noSmoothing.html deleted file mode 100644 index 40081ed7..00000000 --- a/doc/smoothingModel_noSmoothing.html +++ /dev/null @@ -1,32 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-smoothingModel off; --
Examples: -
-smoothingModel off; --
Description: -
-The "noSmoothing" model is a dummy smoothingModel model which does no smoothing. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/smoothingModel_noSmoothing.txt b/doc/smoothingModel_noSmoothing.txt index 827748e2..6b5bf89a 100644 --- a/doc/smoothingModel_noSmoothing.txt +++ b/doc/smoothingModel_noSmoothing.txt @@ -1,15 +1,16 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -smoothingModel_noSmoothing command :h3 +smoothingModel off command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. smoothingModel off; :pre @@ -19,9 +20,11 @@ smoothingModel off; :pre [Description:] -The "noSmoothing" model is a dummy smoothingModel model which does no smoothing. +The {off} model is a dummy smoothingModel model which performs no smoothing. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] diff --git a/doc/voidFractionModel.html b/doc/voidFractionModel.html deleted file mode 100644 index 0dd37937..00000000 --- a/doc/voidFractionModel.html +++ /dev/null @@ -1,34 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-voidfractionModel model; --
Examples: -
-voidfractionModel centre; --
Note: This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation. -
-Description: -
-The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field. -
-Restrictions: none. -
-Default: none. -
- diff --git a/doc/voidFractionModel.txt b/doc/voidFractionModel.txt index c4310692..d08db44f 100644 --- a/doc/voidFractionModel.txt +++ b/doc/voidFractionModel.txt @@ -1,30 +1,38 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -voidfractionModel command :h3 +voidFractionModel command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -voidfractionModel model; :pre +voidFractionModel model; :pre -model = name of the voidfractionModel to be applied :ul +model = name of the voidFractionModel to be applied :ul [Examples:] -voidfractionModel centre; :pre +voidFractionModel centre; :pre -Note: This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation. +NOTE: This examples list might not be complete - please look for other models +(voidFractionModel XY) in this documentation. [Description:] -The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field. +The {voidFractionModel} is the base class for models to represent the DEM +particle's volume in the CFD domain via a void fraction field. -[Restrictions:] none. +[Restrictions:] + +none + +[Default:] + +none -[Default:] none. diff --git a/doc/voidFractionModel_GaussVoidFraction.html b/doc/voidFractionModel_GaussVoidFraction.html deleted file mode 100644 index 2ad4fd92..00000000 --- a/doc/voidFractionModel_GaussVoidFraction.html +++ /dev/null @@ -1,60 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-voidfractionModel Gauss;
-GaussProps
-{
- maxCellsPerParticle number1;
- alphaMin number2;
- weight number3;
- porosity number4;
-}
-
-Examples: -
-voidfractionModel Gauss;
-GaussProps
-{
- maxCellsPerParticle 1000;
- alphaMin 0.10;
- weight 1.;
- porosity 1.;
-}
-
-Description: -
-The Gauss voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle. The volume is here distributed according to a Gaussian distribution. -
-The region of influence of a particle can be increased artificially by "porosity", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. -
-The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -
-Restrictions: none. -
-Related commands: -
-voidfractionModel , bigParticle -
- diff --git a/doc/voidFractionModel_GaussVoidFraction.txt b/doc/voidFractionModel_GaussVoidFraction.txt index ceca74b2..3468c000 100644 --- a/doc/voidFractionModel_GaussVoidFraction.txt +++ b/doc/voidFractionModel_GaussVoidFraction.txt @@ -1,53 +1,63 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -voidfractionModel_GaussVoidFraction command :h3 +voidFractionModel Gauss command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -voidfractionModel Gauss; +voidFractionModel Gauss; GaussProps \{ maxCellsPerParticle number1; - alphaMin number2; - weight number3; - porosity number4; + alphaMin number2; + weight number3; + porosity number4; \} :pre {number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l -{number2} = minimum limit for voidfraction :l -{number3} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l -{number4} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l +{number2} = minimum limit for void fraction :l +{number3} = (optional, default 1.0) scaling of the particle volume to account for porosity or agglomerations. :l +{number4} = (optional, default 1.0) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l :ule [Examples:] -voidfractionModel Gauss; +voidFractionModel Gauss; GaussProps \{ maxCellsPerParticle 1000; - alphaMin 0.10; - weight 1.; - porosity 1.; + alphaMin 0.10; + weight 1.0; + porosity 1.0; \} :pre [Description:] -The Gauss voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle. The volume is here distributed according to a Gaussian distribution. +The {Gauss} void fraction model is supposed to be used when a particle (or its +representation) is bigger than a CFD cell. The void fraction field is set in +those cell whose centres are inside the particle. The volume is here distributed +according to a Gaussian distribution. -The region of influence of a particle can be increased artificially by "porosity", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. +The region of influence of a particle can be increased artificially by +"porosity", which blows up the particles, but keeps their volume (for +void fraction calculation) constant. -The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. +The particle volume occupied in the CFD domain can be adjusted by the parameter +"weight", using Vparticle=dsphere^3*pi/6*weight. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] -"voidfractionModel"_voidfractionModel.html , "bigParticle"_voidFractionModel_bigParticleVoidFraction.html +"voidFractionModel"_voidFractionModel.html, +"bigParticle"_voidFractionModel_bigParticleVoidFraction.html diff --git a/doc/voidFractionModel_IBVoidFraction.html b/doc/voidFractionModel_IBVoidFraction.html deleted file mode 100644 index bdb61e78..00000000 --- a/doc/voidFractionModel_IBVoidFraction.html +++ /dev/null @@ -1,56 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-voidfractionModel IB;
-IBProps
-{
- maxCellsPerParticle number1;
- alphaMin number2;
- scaleUpVol number3;
-}
-
-Examples: -
-voidfractionModel IB;
-IBProps
-{
- maxCellsPerParticle 1000;
- alphaMin 0.10;
- scaleUpVol 5.0;
-}
-
-Description: -
-The IB voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle. The model is specially designed for cfdemSolverIB and creates a smooth transition of the voidfraction at the particle surface. Cells which are only partially covered by solid are marked by voidfraction values between 0 and 1 respectively. -
-The region of influence of a particle can be increased artificially by "scaleUpVol", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. -
-Code of this sub-model contributed by Alice Hager, JKU. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/voidFractionModel_IBVoidFraction.txt b/doc/voidFractionModel_IBVoidFraction.txt index d300c8b9..753e26ec 100644 --- a/doc/voidFractionModel_IBVoidFraction.txt +++ b/doc/voidFractionModel_IBVoidFraction.txt @@ -1,50 +1,62 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -voidfractionModel_IBVoidFraction command :h3 +voidFractionModel IB command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -voidfractionModel IB; +voidFractionModel IB; IBProps \{ maxCellsPerParticle number1; - alphaMin number2; - scaleUpVol number3; + alphaMin number2; + scaleUpVol number3; \} :pre -{number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l -{number2} = minimum limit for voidfraction :l -{number3} = diameter of the particle's representation is artificially increased according to {number3} * Vparticle, volume remains unaltered! :l +{number1} = maximum number of cells covered by a particle (search will fail when +more than {number1} cells are covered by the particle) :ulb,l +{number2} = minimum limit for void fraction :l +{number3} = diameter of the particle's representation is artificially increased +according to {number3} * Vparticle, volume remains unaltered! :l :ule [Examples:] -voidfractionModel IB; +voidFractionModel IB; IBProps \{ maxCellsPerParticle 1000; - alphaMin 0.10; - scaleUpVol 5.0; + alphaMin 0.10; + scaleUpVol 5.0; \} :pre [Description:] -The IB voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle. The model is specially designed for cfdemSolverIB and creates a smooth transition of the voidfraction at the particle surface. Cells which are only partially covered by solid are marked by voidfraction values between 0 and 1 respectively. +The {IB} void fraction model is supposed to be used when a particle (or its +representation) is bigger than a CFD cell. The void fraction field is set in +those cell whose centres are inside the particle. The model is specially +designed for cfdemSolverIB and creates a smooth transition of the void fraction +at the particle surface. Cells which are only partially covered by solid are +marked by void fraction values between 0 and 1 respectively. -The region of influence of a particle can be increased artificially by "scaleUpVol", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. +The region of influence of a particle can be increased artificially by +"scaleUpVol", which blows up the particles, but keeps their volume (for +void fraction calculation) constant. -Code of this sub-model contributed by Alice Hager, JKU. +Code of this sub-model was contributed by Alice Hager, JKU. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] -"voidfractionModel"_voidfractionModel.html +"voidFractionModel"_voidFractionModel.html diff --git a/doc/voidFractionModel_bigParticleVoidFraction.html b/doc/voidFractionModel_bigParticleVoidFraction.html deleted file mode 100644 index ad0b0c05..00000000 --- a/doc/voidFractionModel_bigParticleVoidFraction.html +++ /dev/null @@ -1,62 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-voidfractionModel bigParticle;
-bigParticleProps
-{
- maxCellsPerParticle number1;
- alphaMin number2;
- weight number3;
- porosity number4;
-}
-
-Examples: -
-voidfractionModel bigParticle;
-bigParticleProps
-{
- maxCellsPerParticle 1000;
- alphaMin 0.10;
- weight 1.;
- porosity 5.0;
-}
-
-Description: -
-The bigParticle voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle which results in a stairstep representation of the bodies within the mesh (i.e. voidfraction is either 1 (fluid) of zero (solid)). For archiving accurate results, approx. 8 cells per particle diameter are necessary. -
-The region of influence of a particle can be increased artificially by "porosity", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. -
-The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -
-Parts of this sub-model contributed by Alice Hager, JKU. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/voidFractionModel_bigParticleVoidFraction.txt b/doc/voidFractionModel_bigParticleVoidFraction.txt index d6d43299..5e05b4b0 100644 --- a/doc/voidFractionModel_bigParticleVoidFraction.txt +++ b/doc/voidFractionModel_bigParticleVoidFraction.txt @@ -1,55 +1,66 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -voidfractionModel_bigParticleVoidFraction command :h3 +voidFractionModel bigParticle command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -voidfractionModel bigParticle; +voidFractionModel bigParticle; bigParticleProps \{ maxCellsPerParticle number1; - alphaMin number2; - weight number3; - porosity number4; + alphaMin number2; + weight number3; + porosity number4; \} :pre {number1} = maximum number of cells covered by a particle (search will fail when more than {number1} cells are covered by the particle) :ulb,l -{number2} = minimum limit for voidfraction :l -{number3} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l -{number4} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l +{number2} = minimum limit for void fraction :l +{number3} = (optional, default 1.0) scaling of the particle volume to account for porosity or agglomerations. :l +{number4} = (optional, default 1.0) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l :ule [Examples:] -voidfractionModel bigParticle; +voidFractionModel bigParticle; bigParticleProps \{ maxCellsPerParticle 1000; - alphaMin 0.10; - weight 1.; - porosity 5.0; + alphaMin 0.10; + weight 1.0; + porosity 5.0; \} :pre [Description:] -The bigParticle voidFraction model is supposed to be used when a particle (or its representation) is bigger than a CFD cell. The voidfraction field is set in those cell whose centres are inside the particle which results in a stairstep representation of the bodies within the mesh (i.e. voidfraction is either 1 (fluid) of zero (solid)). For archiving accurate results, approx. 8 cells per particle diameter are necessary. +The {bigParticle} void fraction model is supposed to be used when a particle (or +its representation) is bigger than a CFD cell. The void fraction field is set in +those cell whose centres are inside the particle which results in a stairstep +representation of the bodies within the mesh (i.e. void fraction is either 1 +(fluid) of zero (solid)). For archiving accurate results, approx. 8 cells per +particle diameter are necessary. -The region of influence of a particle can be increased artificially by "porosity", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. +The region of influence of a particle can be increased artificially by +"porosity", which blows up the particles, but keeps their volume (for +void fraction calculation) constant. -The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. +The particle volume occupied in the CFD domain can be adjusted by the parameter +"weight", using Vparticle=dsphere^3*pi/6*weight. -Parts of this sub-model contributed by Alice Hager, JKU. +Parts of this sub-model were contributed by Alice Hager, JKU. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] -"voidfractionModel"_voidfractionModel.html +"voidFractionModel"_voidFractionModel.html diff --git a/doc/voidFractionModel_centreVoidFraction.html b/doc/voidFractionModel_centreVoidFraction.html deleted file mode 100644 index 94ccd154..00000000 --- a/doc/voidFractionModel_centreVoidFraction.html +++ /dev/null @@ -1,50 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-voidfractionModel centre;
-centreProps
-{
- alphaMin number1;
- weight number2;
-}
-
-Examples: -
-voidfractionModel centre;
-centreProps
-{
- alphaMin 0.1;
- weight 1.;
-}
-
-Description: -
-The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell. -
-The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/voidFractionModel_centreVoidFraction.txt b/doc/voidFractionModel_centreVoidFraction.txt index 60141f57..597293fd 100644 --- a/doc/voidFractionModel_centreVoidFraction.txt +++ b/doc/voidFractionModel_centreVoidFraction.txt @@ -1,45 +1,50 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -voidfractionModel_centreVoidFraction command :h3 +voidFractionModel centre command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -voidfractionModel centre; +voidFractionModel centre; centreProps \{ alphaMin number1; - weight number2; + weight number2; \} :pre -{number1} = minimum limit for voidfraction :ulb,l +{number1} = minimum limit for void fraction :ulb,l {number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l :ule [Examples:] -voidfractionModel centre; +voidFractionModel centre; centreProps \{ alphaMin 0.1; - weight 1.; + weight 1.0; \} :pre [Description:] -The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell. +The {centre} void fraction model calculates the void fraction in a CFD cell +accounting for the volume of the particles whose centres are inside the cell. -The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. +The particle volume occupied in the CFD domain can be adjusted by the parameter +"weight", using Vparticle=dsphere^3*pi/6*weight. -[Restrictions:] none. +[Restrictions:] + +none [Related commands:] -"voidfractionModel"_voidfractionModel.html +"voidFractionModel"_voidFractionModel.html diff --git a/doc/voidFractionModel_dividedVoidFraction.html b/doc/voidFractionModel_dividedVoidFraction.html deleted file mode 100644 index b6cbc2f6..00000000 --- a/doc/voidFractionModel_dividedVoidFraction.html +++ /dev/null @@ -1,60 +0,0 @@ - -Syntax: -
-Defined in couplingProperties dictionary. -
-voidfractionModel divided;
-dividedProps
-{
- alphaMin number1;
- interpolation;
- weight number2;
- porosity number3;
-}
-
-Examples: -
-voidfractionModel divided;
-dividedProps
-{
- alphaMin 0.2;
-}
-
-Description: -
-The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. Satellite points are used to divide the particle's volume to the touched cells. -
-The region of influence of a particle can be increased artificially by "porosity", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. -
-The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. -
-In the basic implementation of solvers, the void fraction is calculated based on all particles. Depending on the solver used, the void fraction calculation is also performed for a certain type of particles. -The void fraction calculation is based on a three-step approach (reset, set and interpolate), i.e., the void fraction is time interpolated from a previous and a next void fraction field. Appropriate names for these fields have to be specified in the sub-dictionaries voidFracFieldNamesPrev and voidFracFieldNamesNext in the couplingProperties dictionary. -
-Restrictions: none. -
-Related commands: -
- - diff --git a/doc/voidFractionModel_dividedVoidFraction.txt b/doc/voidFractionModel_dividedVoidFraction.txt index b2ce76f5..1922ef3f 100644 --- a/doc/voidFractionModel_dividedVoidFraction.txt +++ b/doc/voidFractionModel_dividedVoidFraction.txt @@ -1,34 +1,39 @@ -"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c +"CFDEMproject Website"_lws - "Main Page"_main :c :link(lws,http://www.cfdem.com) -:link(lc,CFDEMcoupling_Manual.html#comm) +:link(main,CFDEMcoupling_Manual.html) :line -voidfractionModel_dividedVoidFraction command :h3 +voidFractionModel divided command :h3 [Syntax:] -Defined in couplingProperties dictionary. +Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties +dictionary. -voidfractionModel divided; +voidFractionModel divided; dividedProps \{ - alphaMin number1; + alphaMin number1; interpolation; - weight number2; - porosity number3; + weight number2; + porosity number3; + procBoundaryCorrection switch1; + verbose; \} :pre -{number1} = minimum limit for voidfraction :ulb,l -{interpolation} = flag to interpolate voidfraction to particle positions (normally off) :l +{number1} = minimum limit for void fraction :ulb,l +{interpolation} = flag to interpolate void fraction to particle positions (normally off) :l {number2} = (optional) scaling of the particle volume to account for porosity or agglomerations. :l {number3} = (optional) diameter of the particle's representation is artificially increased according to {number2} * Vparticle, volume remains unaltered! :l +{switch1} = (optional, default false) allow for correction at processor boundaries. This requires the use of engineIB and vice versa. :l +{verbose} = (optional, default false) flag for debugging output :l :ule [Examples:] -voidfractionModel divided; +voidFractionModel divided; dividedProps \{ alphaMin 0.2; @@ -36,18 +41,57 @@ dividedProps [Description:] -The divided voidFraction model is supposed to be used when a particle (or its representation) is in the size range of a CFD cell. Satellite points are used to divide the particle's volume to the touched cells. +The {divided} void fraction model is supposed to be used when a particle (or its +representation) is in the size range of a CFD cell. Satellite points are used to +divide the particle's volume to the touched cells. -The region of influence of a particle can be increased artificially by "porosity", which blows up the particles, but keeps their volume (for voidfraction calculation) constant. +The particle has radius R and its volume is divided into 29 non-overlapping +regions of equal volume. The centroids of these volumes are then used to +reproduce each volume. The first volume is a sphere with the center coinciding +with the particle center. The radius of this subsphere can be found as follows: -The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight. +:c,image(Eqs/voidfractionModel_divided_pic2.png) -In the basic implementation of solvers, the void fraction is calculated based on all particles. Depending on the solver used, the void fraction calculation is also performed for a certain type of particles. -The void fraction calculation is based on a three-step approach (reset, set and interpolate), i.e., the void fraction is time interpolated from a previous and a next void fraction field. Appropriate names for these fields have to be specified in the sub-dictionaries voidFracFieldNamesPrev and voidFracFieldNamesNext in the couplingProperties dictionary. +The rest of the volume is a spherical layer that is divided into 2 layers of +equal volume. Position of the border between these two spherical layers in +radial direction can be easily obtained: -[Restrictions:] none. +:c,image(Eqs/voidfractionModel_divided_pic3.png) + +Each of these spherical layers is later divided into 14 elements of equal volume. +Position of the centroid point in radial direction of each volume in the first +spherical layer is as follows + +:c,image(Eqs/voidfractionModel_divided_pic4.png) + +Similarly, for the second spherical layer remembering that the external radius +is the particle radius: + +:c,image(Eqs/voidfractionModel_divided_pic5.png) + +The region of influence of a particle can be increased artificially by +{porosity}, which blows up the particles, but keeps their volume (for +void fraction calculation) constant. + +The particle volume occupied in the CFD domain can be adjusted by the parameter +{weight}, using + +:c,image(Eqs/voidfractionModel_divided_pic6.png). + +In the basic implementation of solvers, the void fraction is calculated based on +all particles. Depending on the solver used, the void fraction calculation is +also performed for a certain type of particles. +The void fraction calculation is based on a three-step approach (reset, set and +interpolate), i.e. the void fraction is time interpolated from a previous and a +next void fraction field. Appropriate names for these fields have to be +specified in the sub-dictionaries voidFracFieldNamesPrev and +voidFracFieldNamesNext in the couplingProperties dictionary. + +[Restrictions:] + +none [Related commands:] -"voidfractionModel"_voidfractionModel.html +"voidFractionModel"_voidFractionModel.html