zhyang-dev/CFDEMcoupling-PFM
1
0
Fork 0
mirror of https://github.com/ParticulateFlow/CFDEMcoupling-PFM.git synced 2025-12-08 06:37:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[DOC] delete old html files

Browse Source
This commit is contained in:
danielque
2018-07-17 09:23:22 +02:00
parent ea9ccabeee
commit a1e1fa8f16
79 changed files with 0 additions and 4073 deletions
Download Patch File Download Diff File Expand all files Collapse all files

244
doc/CFDEMcoupling_Manual.html
View File

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

40
doc/IOModel.html
View File

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

32
doc/IOModel_basicIO.html
View File

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

32
doc/IOModel_noIO.html
View File

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

32
doc/IOModel_sophIO.html
View File

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

32
doc/IOModel_trackIO.html
View File

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

4
doc/SCcontent/individual_commands.txt
View File

@ -1,4 +0,0 @@
1.6 Models/Solvers :h4,link(cmd_5),link(comm)
This section lists all CFDEMcoupling sub-models and solvers alphabetically, with a separate
listing below of styles within certain commands.

41
doc/averagingModel.html
View File

@ -1,41 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>averagingModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>averagingModel model;
</PRE>
<UL><LI>model = name of averaging model to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>averagingModel dense;
averagingModel dilute;
</PRE>
<P>Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The averaging model performs the Lagrangian->Eulerian mapping of data (e.g. particle velocities).
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "averagingModel_dense.html">dense</A>, <A HREF = "averagingModel_dilute.html">dilute</A>
</P>
<P><B>Default:</B> none
</P>
</HTML>

34
doc/averagingModel_dense.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>averagingModel_dense command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>averagingModel dense;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>averagingModel dense;
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>No known restrictions.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "averagingModel.html">averagingModel</A>, <A HREF = "averagingModel_dilute.html">dilute</A>
</P>
</HTML>

35
doc/averagingModel_dilute.html
View File

@ -1,35 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>averagingModel_dilute command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>averagingModel dilute;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>averagingModel dilute;
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>This model is computationally efficient, but should only be used when only one particle is inside one CFD cell.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "averagingModel.html">averagingModel</A>, <A HREF = "averagingModel_dense.html">dense</A>
</P>
</HTML>

53
doc/cfdemSolverIB.html
View File

@ -1,53 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>cfdemSolverIB command
</H3>
<P><B>Description:</B>
</P>
<P>"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.
</P>
<P>Code of this solver contributions by Alice Hager, JKU.
</P>
<P><B>Algorithm:</B>
</P>
<P>For each time step ...
</P>
<UL><LI>the motion of the spheres is calculated (position, velocity, angular velocity, force...) with LIGGGHTS using the velocity and pressure-field from the previous time step (initial condition for t=0).
<LI>the Navier-Stokes equations are solved on the whole computational domain, disregarding the solid phase.
<LI>the spheres are located within the mesh: each sphere is represented by a cluster of cells, which are either totally or partially covered by the body, depending on its exact position.
<LI>the correction of the velocity and pressure field of the fluid phase takes place, using the information about the location of the spheres and their (angular) velocity.
</UL>
<P><B>Use:</B>
</P>
<P>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:
</P>
<P><A HREF = "locateModel_engineSearchIB.html">engineSearchIB</A>, <A HREF = "forceModel_ArchimedesIB.html">ArchimedesIB</A>, <A HREF = "forceModel_ShirgaonkarIB.html">ShirgaonkarIB</A>, <A HREF = "voidFractionModel_IBVoidFraction.html">IBVoidfraction</A>
</P>
<P><B>References:</B>
</P>
<P>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
</P>
<P>and
</P>
<P>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
</P>
<HR>
<P>(*) <A HREF = "of">OpenFOAM(R)</A> 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.
</P>
<HR>
</HTML>

26
doc/cfdemSolverPiso.html
View File

@ -1,26 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>cfdemSolverPiso command
</H3>
<P><B>Description:</B>
</P>
<P>"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.
</P>
<P>see:
</P>
<P>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.
</P>
<HR>
<P>(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group.
</P>
<HR>
</HTML>

28
doc/cfdemSolverPisoScalar.html
View File

@ -1,28 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>cfdemSolverPisoScalar command
</H3>
<P><B>Description:</B>
</P>
<P>"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".
</P>
<P>see:
</P>
<P>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.
</P>
<P>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
</P>
<HR>
<P>(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group.
</P>
<HR>
</HTML>

51
doc/chemistrModel.html
View File

@ -1,51 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>chemistryModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>chemistryModels
(
model_x
model_y
);
</PRE>
<UL><LI>model = name of chemistry model to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>chemistryModels
(
species
diffusionCoefficients
massTransferCoeff
);
</PRE>
<P>Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "chemistryModel_species.html">species</A>, <A HREF = "chemistryModel_diffusionCoefficient.html">diffusionCoefficient</A>, <A HREF = "chemistryModel_massTransferCoeffs.html">massTransferCoeff</A>
</P>
<P>Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

62
doc/chemistryModel_diffusionCoefficients.html
View File

@ -1,62 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>chemistryModel_diffusionCoefficients command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>chemistryModels
(
diffusionCoefficients
);
diffusionCoefficientsProps
{
verbose switch1;
ChemistryFile "$casePath/CFD/constant/foam.inp";
diffusantGasNames ( speciesNames );
};
</PRE>
<LI><I>switch1</I> = (optional, normally off) flag to give information
<UL><LI><I>ChemistryFile</I> = path to file, where the reacting species are listed
<LI><I>diffusantGasNames</I> = list of gas field names that are the reactant gases
</UL>
<P><B>Examples:</B>
</P>
<PRE>chemistryModels
(
diffusionCoefficients
);
speciesProps
{
verbose false;
ChemistryFile "$casePath/CFD/constant/foam.inp";
diffusantGasNames ( CO
H2
);
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Species model needs to be active.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "chemistryModel.html">chemistryModel</A>
</P>
</HTML>

52
doc/chemistryModel_massTransferCoeff.html
View File

@ -1,52 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>chemistryModel_massTransferCoeff command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>chemistryModels
(
massTransferCoeff
);
diffusionCoefficientsProps
{
verbose switch1;
};
</PRE>
<LI><I>switch1</I> = (optional, normally off) flag to give information
</UL>
<P><B>Examples:</B>
</P>
<PRE>chemistryModels
(
massTransferCoeff
);
massTransferCoeffProps
{
verbose false;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Species model needs to be active.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "chemistryModel.html">chemistryModel</A>
</P>
</HTML>

74
doc/chemistryModel_species.html
View File

@ -1,74 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>chemistryModel_species command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>chemistryModels
(
species
);
speciesProps
{
ChemistryFile "$casePath/CFD/constant/foam.inp";
verbose switch1;
tempFieldName "T";
densityFieldName "rho"
voidfractionFieldName "voidfraction"
totalMoleFieldName "molarConc"
partTempName "partTemp"
partRhoName "partRho"
};
</PRE>
<UL><LI><I>ChemistryFile</I> = path to file, where the reacting species are listed
<LI><I>T</I> = 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
<LI><I>rho</I> = 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
<LI><I>voidfraction</I> = 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
<LI><I>molarConc</I> = 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
<LI><I>partTemp</I> = 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
<LI><I>partRho</I> = 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
<LI><I>switch1</I> = (optional, normally off) flag to give information
</UL>
<P><B>Examples:</B>
</P>
<PRE>chemistryModels
(
species
);
speciesProps
{
ChemistryFile "$casePath/CFD/constant/foam.inp";
verbose false;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "chemistryModel.html">chemistryModel</A>
</P>
</HTML>

36
doc/clockModel.html
View File

@ -1,36 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>clockModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>clockModel model;
</PRE>
<UL><LI>model = name of the clockModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>clockModel standardClock;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (clockModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The clockModel is the base class for models to examine the code/algorithm with respect to run time.
</P>
<P>Main parts of the clockModel classes are written by Josef Kerbl, JKU.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

32
doc/clockModel_noClock.html
View File

@ -1,32 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>clockModel_noClock command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>clockModel off;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>clockModel off;
</PRE>
<P><B>Description:</B>
</P>
<P>The "noClock" model is a dummy clockModel model which does not measure/evaluate the run time.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "clockModel.html">clockModel</A>
</P>
</HTML>

34
doc/clockModel_standardClock.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>clockModel_standardClock command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>clockModel standardClock;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>clockModel standardClock;
</PRE>
<P><B>Description:</B>
</P>
<P>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 <I>arrayPos</I> (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 <I>arrayPos</I> is out of bounds, the array size will be doubled. The stop command does not need <I>arrayPos</I>, 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.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "clockModel.html">clockModel</A>
</P>
</HTML>

41
doc/dataExchangeModel.html
View File

@ -1,41 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>dataExchangeModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>dataExchangeModel model;
</PRE>
<UL><LI>model = name of data exchange model to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>dataExchangeModel twoWayFiles;
dataExchangeModel twoWayMPI;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (dataExchangeModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The data exchange model performs the data exchange between the DEM code and the CFD code.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "dataExchangeModel_noDataExchange.html">noDataExchange</A>, <A HREF = "dataExchangeModel_oneWayVTK.html">oneWayVTK</A>, <A HREF = "dataExchangeModel_twoWayFiles.html">twoWayFiles</A>, <A HREF = "dataExchangeModel_twoWayMPI.html">twoWayMPI</A>
</P>
<P><B>Default:</B> none
</P>
</HTML>

34
doc/dataExchangeModel_noDataExchange.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>dataExchangeModel_noDataExchange command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>dataExchangeModel noDataExchange;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>dataExchangeModel noDataExchange;
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "dataExchangeModel.html">dataExchangeModel</A>
</P>
</HTML>

58
doc/dataExchangeModel_oneWayVTK.html
View File

@ -1,58 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>dataExchangeModel_oneWayVTK command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>dataExchangeModel oneWayVTK;
oneWayVTKProps
{
DEMts timeStep;
relativePath "path";
couplingFilename "filename";
maxNumberOfParticles number;
};
</PRE>
<UL><LI><I>timeStep</I> = time step size of stored DEM data
<LI><I>path</I> = path to the VTK data files relative do simulation directory
<LI><I>filename</I> = filename of the VTK file series
<LI><I>number</I> = maximum number of particles in DEM simulation
</UL>
<P><B>Examples:</B>
</P>
<PRE>dataExchangeModel oneWayVTK;
oneWayVTKProps
{
DEMts 0.0001;
relativePath "../DEM/post";
couplingFilename "vtk_out%4.4d.vtk";
maxNumberOfParticles 30000;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "dataExchangeModel.html">dataExchangeModel</A>
</P>
</HTML>

50
doc/dataExchangeModel_twoWayFiles.html
View File

@ -1,50 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>dataExchangeModel_twoWayFiles command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>dataExchangeModel twoWayFiles;
twoWayFilesProps
{
couplingFilename "filename";
maxNumberOfParticles number;
};
</PRE>
<UL><LI><I>filename</I> = filename of the VTK file series
<LI><I>number</I> = maximum number of particles in DEM simulation
</UL>
<P><B>Examples:</B>
</P>
<PRE>dataExchangeModel twoWayFiles;
twoWayFilesProps
{
couplingFilename "vtk_out%4.4d.vtk";
maxNumberOfParticles 30000;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Developed only for two processors, one for DEM and one for CFD run.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "dataExchangeModel.html">dataExchangeModel</A>
</P>
</HTML>

46
doc/dataExchangeModel_twoWayMPI.html
View File

@ -1,46 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>dataExchangeModel_twoWayMPI command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>dataExchangeModel twoWayMPI;
twoWayMPIProps
{
liggghtsPath "path";
};
</PRE>
<UL><LI><I>path</I> = path to the DEM simulation input file
</UL>
<P><B>Examples:</B>
</P>
<PRE>dataExchangeModel twoWayMPI;
twoWayMPIProps
{
liggghtsPath "../DEM/in.liggghts_init";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "dataExchangeModel.html">dataExchangeModel</A>
</P>
</HTML>

46
doc/dataExchangeModel_twoWayMany2Many.html
View File

@ -1,46 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>dataExchangeModel_twoWayMany2Many command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>dataExchangeModel twoWayMany2Many;
twoWayMany2ManyProps
{
liggghtsPath "path";
};
</PRE>
<UL><LI><I>path</I> = path to the DEM simulation input file
</UL>
<P><B>Examples:</B>
</P>
<PRE>dataExchangeModel twoWayMany2Many;
twoWayMany2ManyProps
{
liggghtsPath "../DEM/in.liggghts_init";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Must be used in combination with the engineSearchMany2Many locate model!
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "dataExchangeModel.html">dataExchangeModel</A>
</P>
</HTML>

50
doc/forceModel.html
View File

@ -1,50 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
model_x
model_y
);
</PRE>
<UL><LI>model = name of force model to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
Archimedes
DiFeliceDrag
);
</PRE>
<P>Note: This examples list might not be complete - please look for other models (forceModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel_Archimedes.html">Archimedes</A>, <A HREF = "forceModel_DiFeliceDrag.html">DiFeliceDrag</A>, <A HREF = "forceModel_gradPForce.html">gradPForce</A>, <A HREF = "forceModel_viscForce.html,<A HREF = "forceModel_dSauter.html">viscForce</A>">dSauter</A>
</P>
<P>Note: This examples list may be incomplete - please look for other models (forceModel_XY) in this documentation.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

52
doc/forceModel_Archimedes.html
View File

@ -1,52 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_Archimedes command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
Archimedes
);
ArchimedesProps
{
gravityFieldName "gravity";
};
</PRE>
<UL><LI><I>gravity</I> = name of the finite volume gravity field
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
Archimedes
);
ArchimedesProps
{
gravityFieldName "g";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

56
doc/forceModel_ArchimedesIB.html
View File

@ -1,56 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_ArchimedesIB command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
ArchimedesIB
);
ArchimedesIBProps
{
gravityFieldName "gravity";
voidfractionFieldName "voidfraction";
};
</PRE>
<UL><LI><I>gravity</I> = name of the finite volume gravity field
<LI><I>voidfraction</I> = name of the finite volume voidfraction field
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
ArchimedesIB
);
ArchimedesIBProps
{
gravityFieldName "g";
voidfractionFieldName "voidfractionNext";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Only for immersed boundary solvers.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

56
doc/forceModel_DiFeliceDrag.html
View File

@ -1,56 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_DiFeliceDrag command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
DiFeliceDrag
);
DiFeliceDragProps
{
velFieldName "U";
interpolation switch1;
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>switch1</I> = flag to use interpolated voidfraction and velocity values (normally off)
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
DiFeliceDrag
);
DiFeliceDragProps
{
velFieldName "U";
interpolation true;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

68
doc/forceModel_GidaspowDrag.html
View File

@ -1,68 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_GidaspowDrag command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
GidaspowDrag
);
GidaspowDragProps
{
velFieldName "U";
voidfractionFieldName "voidfraction";
granVelFieldName "Us";
phi "scalar";
interpolation switch1;
implForceDEM switch2;
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>voidfraction</I> = name of the finite volume voidfraction field
<LI><I>Us</I> = name of the finite volume cell averaged particle velocity field
<LI><I>phi</I> = drag correction factor (in doubt 1)
<LI><I>switch1</I> = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
<I>switch2</I> = (optional, normally off) flag to use implicit formulation of drag on DEM side:l
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
GidaspowDrag
);
GidaspowDragProps
{
velFieldName "U";
voidfractionFieldName "voidfraction";
granVelFieldName "Us";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

61
doc/forceModel_KochHillDrag.html
View File

@ -1,61 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_KochHillDrag command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
KochHillDrag
);
KochHillDragProps
{
velFieldName "U";
voidfractionFieldName "voidfraction";
interpolation "bool1";
implForceDEM "bool2";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>voidfraction</I> = name of the finite volume voidfraction field
<LI><I>bool1</I> = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
<I>bool2</I> = (optional, normally off) flag to use implicit formulation of drag on DEM side:l
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
KochHillDrag
);
KochHillDragProps
{
velFieldName "U";
voidfractionFieldName "voidfraction";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

82
doc/forceModel_LaEuScalarTemp.html
View File

@ -1,82 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_LaEuScalarTemp command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
LaEuScalarTemp
);
LaEuScalarTempProps
{
velFieldName "U";
tempFieldName "T";
voidfractionFieldName "voidfraction";
partTempName "Temp";
partHeatFluxName "convectiveHeatFlux";
lambda value;
Cp value1;
interpolation "switch1";
verbose "switch2";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>T</I> = name of the finite volume scalar temperature field
<LI><I>voidfraction</I> = name of the finite volume voidfraction field
<LI><I>Temp</I> = name of the DEM data representing the particles temperature
<LI><I>convectiveHeatFlux</I> = name of the DEM data representing the particle-fluid convective heat flux
<LI><I>value</I> = fluid thermal conductivity [W/(m*K)]
<LI><I>value1</I> = fluid specific heat capacity [W*s/(kg*K)]
<LI><I>switch1</I> = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
<LI><I>switch2</I> = (normally off) for verbose run
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
LaEuScalarTemp
);
LaEuScalarTempProps
{
velFieldName "U";
tempFieldName "T";
voidfractionFieldName "voidfraction";
partTempName "Temp";
partHeatFluxName "convectiveHeatFlux";
lambda 0.0256;
Cp 1007;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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
</P>
<P><B>Restrictions:</B>
</P>
<P>Goes only with cfdemSolverScalar. The force model has to be the second (!!!) model in the forces list.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

64
doc/forceModel_MeiLift.html
View File

@ -1,64 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_MeiLift command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
MeiLift
);
MeiLiftProps
{
velFieldName "U";
useSecondOrderTerms;
interpolation "switch1";
verbose "switch2";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>useSecondOrderTerms</I> = switch to activate second order terms in the lift force model
<LI><I>switch1</I> = switch to activate tri-linear interpolation of the flow quantities at the particle position
<LI><I>switch2</I> = switch to activate the report of per-particle quantities to the screen
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
MeiLift
);
MeiLiftProps
{
velFieldName "U";
useSecondOrderTerms;
interpolation true;
verbose true;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

52
doc/forceModel_SchillerNaumannDrag.html
View File

@ -1,52 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_SchillerNaumannDrag command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
SchillerNaumannDrag
);
SchillerNaumannDragProps
{
velFieldName "U";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
SchillerNaumannDrag
);
SchillerNaumannDragProps
{
velFieldName "U";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

60
doc/forceModel_ShirgaonkarIB.html
View File

@ -1,60 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_ShirgaonkarIB command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
ShirgaonkarIB
);
ShirgaonkarIBProps
{
velFieldName "U";
pressureFieldName "pressure";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>pressure</I> = name of the finite volume pressure field
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
ShirgaonkarIB
);
ShirgaonkarIBProps
{
velFieldName "U";
pressureFieldName "p";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>References:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Only for immersed boundary solvers.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

47
doc/forceModel_dSauter.html
View File

@ -1,47 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_dSauter command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
dSauter
);
dSauterProps
{
coarseGrainingFactors
(
X Y Z
);
};
</PRE>
<UL><LI><I>coarseGrainingFactors</I> = list of coarse graining factors by type, separated by whitespace, optional
</UL>
<P><B>Description:</B>
</P>
<P>This "forceModel" does not influence the particles or the flow - it calculates the Sauter diameter
</P>
<CENTER><IMG SRC = "Eqs/d32.png">
</CENTER>
<P>.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A></P>
</HTML>

68
doc/forceModel_fieldStore.html
View File

@ -1,68 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_fieldStore command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
fieldStore
);
fieldStoreProps
{
scalarFieldNames
(
"scalarField"
);
vectorFieldNames
(
"vectorField"
);
};
</PRE>
<UL><LI><I>scalarField</I> = names of the finite volume scalar fields to be stored
<LI><I>vectorField</I> = names of the finite volume vector fields to be stored
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
fieldStore
);
fieldStoreProps
{
scalarFieldNames
(
"voidfraction"
);
vectorFieldNames
(
"U"
);
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

60
doc/forceModel_gradPForce.html
View File

@ -1,60 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_gradPForce command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
gradPForce;
);
gradPForceProps
{
pFieldName "pressure";
velocityFieldName "U";
interpolation switch1;
};
</PRE>
<UL><LI><I>pressure</I> = name of the finite volume fluid pressure field
<LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>switch1</I> = flag to use interpolated pressure values (normally off)
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
gradPForce;
);
gradPForceProps
{
pFieldName "p";
velocityFieldName "U";
interpolation true;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

45
doc/forceModel_noDrag.html
View File

@ -1,45 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_noDrag command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
noDrag
);
</PRE>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
noDrag
);
</PRE>
<PRE>noDragProps (optional)
{
noDEMForce; (optional)
};
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

59
doc/forceModel_particleCellVolume.html
View File

@ -1,59 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_particleCellVolume command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
particleCellVolume
);
particleCellVolumeProps
{
upperThreshold value;
lowerThreshold value2;
verbose;
};
</PRE>
<LI><I>value</I> = only cells with a field value (magnitude) lower than this upper threshold are considered
<LI><I>value2</I> = only cells with a field value (magnitude) greater than this lower threshold are considered
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
particleCellVolume
);
particleCellVolumeProps
{
upperThreshold 0.999;
lowerThreshold 0;
verbose;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

58
doc/forceModel_pdCorrelation.html
View File

@ -1,58 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_pdCorrelation
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
pdCorrelation
);
pdCorrelationProps
{
coarseGrainingFactors
(
X Y Z
);
particleDensities
(
A B C
);
runOnWriteOnly true;
};
</PRE>
<UL><LI><I>coarseGrainingFactors</I> = list of coarse graining factors by type, separated by whitespace, optional
<LI><I>particleDensities</I> = list of particle densities by type, separated by whitespace, optional
<LI><I>runOnWriteOnly</I> = switch if this should be executed on write, optional (default: false - execute every coupling step).
</UL>
<P><B>Description:</B>
</P>
<P>This "forceModel" does not influence the particles or the flow - it calculates the particle momentum-diameter correlation
</P>
<CENTER><IMG SRC = "Eqs/pdCorrelation.png">
</CENTER>
<P>where delta is the type-specific coarsegraining factor.
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A></P>
</HTML>

52
doc/forceModel_virtualMassForce.html
View File

@ -1,52 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_virtualMassForce command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
virtualMassForce
);
virtualMassForceProps
{
velFieldName "U";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
virtualMassForce
);
virtualMassForceProps
{
velFieldName "U";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Model not validated!
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

55
doc/forceModel_viscForce.html
View File

@ -1,55 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceModel_viscForce command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>forceModels
(
viscForce;
);
viscForceProps
{
velocityFieldName "U";
interpolation "switch";
};
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>switch</I> = flag to use interpolated stress values (normally off)
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceModels
(
viscForce;
);
viscForceProps
{
velocityFieldName "U";
}
</PRE>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceModel.html">forceModel</A>
</P>
</HTML>

49
doc/forceSubModel.html
View File

@ -1,49 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceSubModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>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.
</P>
<PRE>forceSubModels
(
model_x
model_y
);
</PRE>
<UL><LI>model = name of force sub-model to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>forceSubModels
(
ImEx
);
</PRE>
<P>Note: This examples list might not be complete - please look for other models (forceSubModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceSubModel_ImEx.html">ImEx</A>
</P>
<P>Note: This examples list may be incomplete - please look for other models (forceSubModel_XY) in this documentation.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

45
doc/forceSubModel_ImEx.html
View File

@ -1,45 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceSubModel_ImEx command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties sub-dictionary of the force model in use.
</P>
<P>forceSubModels
(
ImEx;
);
</P>
<P>treatExplicit true; // optional for some force models.
treatDEM true; // optional for some force models.
implDEM true; // optional for some force models.
</P>
<P><B>Examples:</B>
</P>
<P>forceSubModels
(
ImEx;
);
treatExplicit true; // optional for some force models.
</P>
<P><B>Description:</B>
</P>
<P> 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.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceSubModel.html">forceSubModel</A>
</P>
</HTML>

46
doc/forceSubModel_ImExCorr.html
View File

@ -1,46 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>forceSubModel_ImExCorr command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties sub-dictionary of the force model in use.
</P>
<P>forceSubModels
(
ImExCorr;
);
</P>
<P>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.
</P>
<P><B>Examples:</B>
</P>
<P>forceSubModels
(
ImExCorr;
);
treatExplicit true; // optional for some force models.
</P>
<P><B>Description:</B>
</P>
<P> Same as ImEx, but it additionally reads "explicitInterpCorr" to correct the error steming from interpolation of Ufluid and averaging of Uparticles.
</P>
<P><B>Restrictions:</B>
</P>
<P>none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "forceSubModel.html">forceSubModel</A>
</P>
</HTML>

186
doc/githubAccess_public.html
View File

@ -1,186 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>githubAccess_public
</H3>
<HR>
<P><B>Description:</B>
</P>
<P>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
</P>
<P><B>Procedure:</B>
</P>
<P>Basically the following steps have to be performed:
</P>
<UL><LI><I>git clone</I> the desired repository
<LI>update your repositories by <I>git pull</I>
<LI>set environment variables
<LI>compile LIGGGHTS(R) and CFDEM(R)coupling
<LI>run your own cases
</UL>
<P><B><I>git clone</I> the desired repository:</B>
</P>
<P>If not already done, open a terminal and create a directory for LIGGGHTS(R) in $HOME:
</P>
<PRE>cd
</PRE>
<PRE>mkdir LIGGGHTS
</PRE>
<PRE>cd LIGGGHTS
</PRE>
<P>To clone the public LIGGGHTS repository, open a terminal and execute:
</P>
<PRE><H6>git clone git://github.com/CFDEMproject/LIGGGHTS-PUBLIC.git LIGGGHTS-PUBLIC
</H6></PRE>
<P>If not already done, open a terminal and create a directory for CFDEM(R)coupling in $HOME:
</P>
<PRE>cd
</PRE>
<PRE>mkdir CFDEM
</PRE>
<PRE>cd CFDEM
</PRE>
<P>Make sure that OpenFOAM(R) is already set up correctly!
</P>
<P>To clone the public CFDEM(R)coupling repository, open a terminal and execute:
</P>
<PRE><H6>git clone git://github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
</H6></PRE>
<P>Troubles? See Troubleshooting section below.
</P>
<P><B>Update your repositories by <I>git pull</I>:</B>
</P>
<P>To get the latest version, open a terminal, go to the location of your local installation and type:
<I>Warning: git stash will remove your changes in $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION !</I>
</P>
<PRE>cd $HOME/CFDEM/CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
git stash
git pull
</PRE>
<P><B>Set Environment Variables:</B>
</P>
<P>Now you need to set some environment variables in ~/.bashrc (if you use c-shell, manipulate ~/.cshrc accordingly). Open ~/.bashrc
</P>
<PRE>gedit ~/.bashrc &
</PRE>
<P>add the lines (you find them also in .../cfdemParticle/etc/bashrc and cshrc respectively):
</P>
<PRE>#================================================#
#- 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>
<P>Save the ~/.bashrc, open a new terminal and test the settings. The commands:
</P>
<PRE>$CFDEM_PROJECT_DIR
$CFDEM_SRC_DIR
$CFDEM_LIGGGHTS_SRC_DIR
</PRE>
<P>should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly.
</P>
<P>To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc.
</P>
<P>If $CFDEM_SRC_DIR is set correctly, you can type
</P>
<PRE>cfdemSysTest
</PRE>
<P>to get some information if the paths are set correctly.
</P>
<P><B>Compile LIGGGHTS(R) and CFDEM(R)coupling:</B>
</P>
<P>If above settings were done correctly, you can compile LIGGGHTS(R) by typing:
</P>
<PRE>cfdemCompLIG
</PRE>
<P>and you can then compile CFDEM(R)coupling by typing:
</P>
<PRE>cfdemCompCFDEM
</PRE>
<P>You can run the tutorial cases by executing .../etc/testTutorial.sh through the alias <I>cfdemTestTUT</I>.
Alternatively you can run each tutorial using the <I>Allrun.sh</I> scripts in the tutorial directories.
</P>
<P>In case questions concerning the installation arise, please feel free to contact our forum at www.cfdem.com.
</P>
<P><B>Run Your Own Cases:</B>
</P>
<P>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 <I>git stash</I>!
</P>
<P><B>Additional Installations:</B>
</P>
<P>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:
</P>
<PRE>sudo apt-get install python-numpy
</PRE>
<P>You can pull the latest version of lpp with:
</P>
<PRE>cd $HOME/LIGGGHTS
</PRE>
<PRE>git clone git://cfdem.git.sourceforge.net/gitroot/cfdem/lpp mylpp
</PRE>
<P><B>Backwards Compatibility:</B>
</P>
<P>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.
</P>
<P>The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in:
src/lagrangian/cfdemParticle/cfdTools/versionInfo.H
</P>
<P>For using other versions you can manipulate:
src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H
(still not all functionality might work then!)
</P>
<P><B>Troubleshooting:</B>
</P>
<UL><LI>Troubles with git clone?
</UL>
<P><B>a)</B> 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):
</P>
<P>git clone https://user@github.com/CFDEMproject/CFDEMcoupling-PUBLIC.git
CFDEMcoupling-PUBLIC-$WM_PROJECT_VERSION
</P>
<P><B>b)</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/...",
</P>
<P>please use: env GIT_SSL_NO_VERIFY=true git clone https://github...
</P>
<P>(see http://stackoverflow.com/questions/3777075/https-github-access)
</P>
<P><B>c)</B> If you face the error: "Agent admitted failure to sign using the key. Permission denied (publickey).", after ssh -T git@github.com
</P>
<P>please type: "ssh-add"
</P>
<P>(see: https://help.github.com/articles/error-agent-admitted-failure-to-sign)
</P>
</HTML>

BIN
doc/githubAccess_public.pdf
View File

Binary file not shown.

44
doc/liggghtsCommandModel.html
View File

@ -1,44 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>liggghtsCommandModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in liggghtsCommmands dictionary.
</P>
<PRE>liggghtsCommandModels
(
model_x
model_y
);
</PRE>
<UL><LI>model = name of the liggghtsCommandModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>liggghtsCommandModels
(
runLiggghts
writeLiggghts
);
</PRE>
<P>Note: This examples list might not be complete - please look for other models (liggghtsCommandModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The liggghtsCommandModel is the base class to execute DEM commands within a CFD run.
</P>
<P><B>Restrictions:</B>
</P>
<P>Works only with MPI coupling.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

97
doc/liggghtsCommandModel_execute.html
View File

@ -1,97 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>liggghtsCommandModel_execute command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in liggghtsCommmands dictionary.
</P>
<PRE>liggghtsCommandModels
(
execute
);
executeProps0
{
command
(
run
$couplingInterval
);
runFirst switch1;
runLast switch2;
runEveryCouplingStep switch3;
runEveryWriteStep switch4;
verbose;
}
</PRE>
<UL><LI><I>command</I> = 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)
<LI><I>switch1</I> = switch (choose on/off) if the command is executed only at first time step
<LI><I>switch2</I> = switch (choose on/off) if the command is executed only at last time step
<LI><I>switch3</I> = switch (choose on/off) if the command is executed at every coupling step
<LI><I>switch4</I> = switch (choose on/off) if the command is executed at every writing step
<LI><I>verbose</I> = (normally off) for verbose run
</UL>
<P><B>Examples:</B>
</P>
<PRE>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;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<H4>These rather complex execute commands can be replaced by the "readLiggghts" and "writeLiggghts" commands!
</H4>
<P><B>Restrictions:</B> None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "liggghtsCommandModel.html">liggghtsCommandModel</A>
</P>
</HTML>

49
doc/liggghtsCommandModel_readLiggghtsData.html
View File

@ -1,49 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>liggghtsCommandModel_readLiggghtsData command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in liggghtsCommmands dictionary.
</P>
<PRE>liggghtsCommandModels
(
readLiggghtsData
);
readLiggghtsDataProps0
{
???
}
</PRE>
<P><B>Examples:</B>
</P>
<PRE>liggghtsCommandModels
(
readLiggghtsData
readLiggghtsData
);
readLiggghtsDataProps0
{
???
}
</PRE>
<P><B>Description:</B>
</P>
<P>The readLiggghtsData liggghtsCommand Model can be used to ???
</P>
<P><B>Restrictions:</B>
</P>
<P>Note: Model is not up to date.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "liggghtsCommandModel.html">liggghtsCommandModel</A>
</P>
</HTML>

44
doc/liggghtsCommandModel_runLiggghts.html
View File

@ -1,44 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>liggghtsCommandModel_runLiggghts command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in liggghtsCommmands dictionary.
</P>
<PRE>liggghtsCommandModels
(
runLiggghts
);
//- optional
runLiggghtsProps
{
preNo true;
verbose; (optional)
}
</PRE>
<P><B>Examples:</B>
</P>
<PRE>liggghtsCommandModels
(
runLiggghts
);
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B> Warning: the "pre no" option can cause troubles (dump data of particles changing the domain might be erroneous)!
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "liggghtsCommandModel.html">liggghtsCommandModel</A>
</P>
</HTML>

56
doc/liggghtsCommandModel_writeLiggghts.html
View File

@ -1,56 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>liggghtsCommandModel_writeLiggghts command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in liggghtsCommmands dictionary.
</P>
<PRE>liggghtsCommandModels
(
writeLiggghts
);
//- optional
writeLiggghtsProps
{
writeLast switch1;
writeName "name";
overwrite switch2;
verbose;
}
</PRE>
<UL><LI><I>switch1</I> = switch (choose on/off) to select if only last step is stored or every write step (default on).
<LI><I>name</I> = name of the restart file to be written in /$caseDir/DEM/ default (default "liggghts.restartCFDEM")
<LI><I>switch2</I> = switch (choose on/off) to select if only one restart file $name or many files $name_$timeStamp are written (default off):l
<I>verbose</I> = (default off) for verbose run
</UL>
<P><B>Examples:</B>
</P>
<PRE>liggghtsCommandModels
(
runLiggghts
writeLiggghts
);
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B> None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "liggghtsCommandModel.html">liggghtsCommandModel</A>
</P>
</HTML>

34
doc/locateModel.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>locateModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>locateModel model;
</PRE>
<UL><LI>model = name of the locateModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>locateModel engine;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (locateModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

51
doc/locateModel_engineSearch.html
View File

@ -1,51 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>locateModel_engineSearch command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>locateModel engine;
engineProps
{
treeSearch switch1;
}
</PRE>
<UL><LI><I>switch1</I> = switch to use tree search algorithm
</UL>
<P><B>Examples:</B>
</P>
<PRE>locateModel engine;
engineProps
{
treeSearch true;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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:
</P>
<UL><LI>treeSearch false; will execute some geometric (linear) search using the last known cellID
<LI>treeSearch true; will use a recursive tree structure to find the cell (recommended).
</UL>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "locateModel.html">locateModel</A>
</P>
</HTML>

70
doc/locateModel_engineSearchIB.html
View File

@ -1,70 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>locateModel_engineSearchIB command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>locateModel engineIB;
engineIBProps
{
engineProps
{
treeSearch switch1;
}
zSplit value1;
xySplit value2;
}
</PRE>
<UL><LI><I>switch1</I> = names of the finite volume scalar fields to be temporally averaged
<LI><I>value1</I> = number of z-normal layers for satellite points
<LI><I>value2</I> = number of satellite points in each layer
</UL>
<P><B>Examples:</B>
</P>
<PRE>locateModel engineIB;
engineIBProps
{
engineProps
{
treeSearch false;
}
zSplit 8;
xySplit 16;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>The engineSearchIB locate Model can be used with different settings to use different algorithms:
</P>
<UL><LI>treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended)
<LI>treeSearch true; will use a recursive tree structure to find the cell.
</UL>
<P>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.
</P>
<P><B>Restrictions:</B>
</P>
<P>Only for immersed boundary solvers!
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "locateModel.html">locateModel</A>
</P>
</HTML>

59
doc/locateModel_engineSearchMany2Many.html
View File

@ -1,59 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>locateModel_engineSearchMany2Many command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>locateModel engineSearchMany2Many;
engineSearchMany2ManyProps
{
engineProps
{
treeSearch switch1;
}
}
</PRE>
<I>switch1</I> = switch to use tree search algorithm
</UL>
<P><B>Examples:</B>
</P>
<PRE>locateModel engineSearchMany2Many;
engineSearchMany2ManyProps
{
engineProps
{
treeSearch true;
}
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>The engineSearchMany2Many locateModel can be used with different settings to use different algorithms:
</P>
<UL><LI>treeSearch false; will execute some geometric (linear) search using the last known cellID (recommended)
<LI>treeSearch true; will use a recursive tree structure to find the cell.
</UL>
<P><B>Restrictions:</B>
</P>
<P>Use only with the twoWayMany2Many dataExchangeModel!
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "locateModel.html">locateModel</A>
</P>
</HTML>

32
doc/locateModel_standardSearch.html
View File

@ -1,32 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>locateModel_standardSearch command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>locateModel standard;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>locateModel standard;
</PRE>
<P><B>Description:</B>
</P>
<P>The locateModel "standard" locates the CFD cell and cellID corresponding to a given position. A very straight-forward (robust!) locate algorithm is used.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "locateModel.html">locateModel</A>
</P>
</HTML>

51
doc/locateModel_turboEngineSearch.html
View File

@ -1,51 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>locateModel_turboEngineSearch command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>locateModel turboEngine;
turboEngineProps
{
treeSearch switch1;
}
</PRE>
<UL><LI><I>switch1</I> = switch to use tree search algorithm
</UL>
<P><B>Examples:</B>
</P>
<PRE>locateModel turboEngine;
turboEngineProps
{
treeSearch true;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>The turboEngineSearch locate Model can be used with different settings to use different algorithms:
</P>
<UL><LI>faceDecomp false; treeSearch false; will execute some geometric (linear) search using the last known cellID
faceDecomp false; treeSearch true; will use a recursive tree structure to find the cell. (recommended):l
</UL>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "locateModel.html">locateModel</A>
</P>
</HTML>

34
doc/meshMotionModel.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>meshMotionModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>meshMotionModel model;
</PRE>
<UL><LI>model = name of the meshMotionModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>meshMotionModel noMeshMotion;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (meshMotionModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The meshMotionModel is the base class for models which manipulate the CFD mesh according to the DEM mesh motion.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

32
doc/meshMotionModel_noMeshMotion.html
View File

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

45
doc/momCoupleModel.html
View File

@ -1,45 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>momCoupleModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>momCoupleModels
(
model
);
</PRE>
<UL><LI>model = name of the momCoupleModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>momCoupleModels
(
implicitCouple
);
</PRE>
<P>Note: This examples list might not be complete - please look for other models (momCoupleModel_XY) in this documentation.
</P>
<P>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.
</P>
<P>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.
</P>
<P>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.
<B>Description:</B>
</P>
<P>The momCoupleModel is the base class for momentum exchange between DEM and CFD simulation.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

52
doc/momCoupleModel_explicitCouple.html
View File

@ -1,52 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>momCoupleModel_explicitCouple command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>momCoupleModels
(
explicitCouple
);
explicitCoupleProps
{
fLimit vector;
}
</PRE>
<UL><LI><I>vector</I> = limiter vector for explicit force term (default (1e10,1e10,1e10) )
</UL>
<P><B>Examples:</B>
</P>
<PRE>momCoupleModels
(
explicitCouple
);
explicitCoupleProps
{
fLimit (1e3 1e2 1e4);
}
</PRE>
<P><B>Description:</B>
</P>
<P>The explicitCouple-model is a momCoupleModel model providing an explicit momentum source term for the CFD solver.
</P>
<P><B>Restrictions:</B>
</P>
<P>Only for solvers that include explicit momentum exchange.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "momCoupleModel.html">momCoupleModel</A>
</P>
</HTML>

62
doc/momCoupleModel_implicitCouple.html
View File

@ -1,62 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>momCoupleModel_implicitCouple command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>momCoupleModels
(
implicitCouple
);
implicitCoupleProps
{
velFieldName "U";
granVelFieldName "Us";
voidfractionFieldName "voidfraction";
minAlphaP number;
}
</PRE>
<UL><LI><I>U</I> = name of the finite volume fluid velocity field
<LI><I>Us</I> = name of the finite volume granular velocity field
<LI><I>voidfraction</I> = name of the finite volume voidfraction field
<I>number</I> = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l
</UL>
<P><B>Examples:</B>
</P>
<PRE>momCoupleModels
(
implicitCouple
);
implicitCoupleProps
{
velFieldName "U";
granVelFieldName "Us";
voidfractionFieldName "voidfraction";
}
</PRE>
<P><B>Description:</B>
</P>
<P>The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver.
</P>
<P><B>Restrictions:</B>
</P>
<P>Only for solvers that include implicit momentum exchange.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "momCoupleModel.html">momCoupleModel</A>
</P>
</HTML>

40
doc/momCoupleModel_noCouple.html
View File

@ -1,40 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>momCoupleModel_noCouple command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>momCoupleModels
(
off
);
</PRE>
<P><B>Examples:</B>
</P>
<PRE>momCoupleModels
(
off
);
</PRE>
<P><B>Description:</B>
</P>
<P>The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver.
</P>
<P><B>Restrictions:</B>
</P>
<P>Only for solvers that include no momentum exchange, e.g. immersed boundary.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "momCoupleModel.html">momCoupleModel</A>
</P>
</HTML>

42
doc/probeModel.html
View File

@ -1,42 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>probeModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>To be activated via couplingProperties dictionary.
</P>
<PRE>probeModel myProbeModel;
</PRE>
<P>Use probe model "off" to disable this feature.
</P>
<PRE>myProbeModelProps
</PRE>
<PRE>{
</PRE>
<PRE>};
</PRE>
<P><B>Examples:</B>
</P>
<P>See <A HREF = "probeModel_particleProbe.html">particleProbe</A>
</P>
<P>Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.
</P>
<P><B>Description:</B>
</P>
<P>The probeModel feature allows to implement various probing features in CFDEM. Currently, only the <A HREF = "probeModel_particleProbe.html">particleProbe</A> model is implemented, that performs probing of particle forces.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

43
doc/probeModel_noProbe.html
View File

@ -1,43 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>probeModel_noProbe command
</H3>
<P><B>Syntax:</B>
</P>
<P>To be activated via couplingProperties dictionary.
</P>
<PRE>forceModels
{
myForceModel1
myForceModel2
myForceModel3
};
</PRE>
<P><B>Examples:</B>
</P>
<PRE>probeModel off;
</PRE>
<P>Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.
</P>
<P><B>Description:</B>
</P>
<P>Does not perform any probing.
</P>
<P><B>Restrictions:</B>
</P>
<P>None.
</P>
<P><B>Related commands which are currently enabled for particle probing:</B>
</P>
<P><A HREF = "probeModel_particleProbe.html">particleProbe</A>
</P>
<P><B>Default:</B> none.
</P>
</HTML>

34
doc/regionModel.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>regionModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary.
</P>
<PRE>regionModel model;
</PRE>
<UL><LI>model = name of the regionModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>regionModel allRegion;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (regionModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The regionModel is the base class for region models to select a certain region for coupled simulation.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

32
doc/regionModel_allRegion.html
View File

@ -1,32 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>regionModel_allRegion command
</H3>
<P><B>Syntax:</B>
</P>
<P>Note: In the current CFDEMcoupling version, this model is no longer used. Defined in couplingProperties dictionary.
</P>
<PRE>regionModel allRegion;
</PRE>
<P><B>Examples:</B>
</P>
<PRE>regionModel allRegion;
</PRE>
<P><B>Description:</B>
</P>
<P>The allRegion-model is a region model including the whole CFD region for the coupling.
</P>
<P><B>Restrictions:</B> None.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "regionModel.html">regionModel</A>
</P>
</HTML>

38
doc/smoothingModel.html
View File

@ -1,38 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>smoothingModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>smoothingModel model;
</PRE>
<UL><LI>model = name of the smoothingModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>smoothingModel off;
</PRE>
<PRE>smoothingModel constDiffSmoothing;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (smoothingModel_XY) in this documentation.
</P>
<P>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.
</P>
<P><B>Description:</B>
</P>
<P>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).
</P>
<P><B>Restrictions:</B> These models are in beta testing.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

58
doc/smoothingModel_constDiffSmoothing.html
View File

@ -1,58 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>smoothingModel_constDiffSmoothing command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>smoothingModel constDiffSmoothing;
constDiffSmoothingProps
{
lowerLimit number1;
upperLimit number2;
smoothingLength lengthScale;
smoothingLengthReferenceField lengthScaleRefField;
}
</PRE>
<UL><LI><I>number1</I> = scalar fields will be bound to this lower value
<LI><I>number2</I> = scalar fields will be bound to this upper value
<LI><I>lengthScale</I> = length scale over which the exchange fields will be smoothed out
<LI><I>lengthScaleRefField</I> = 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.
</UL>
<P><B>Examples:</B>
</P>
<PRE>constDiffSmoothingProps
{
lowerLimit 0.1;
upperLimit 1e10;
smoothingLength 1500e-6;
smoothingLengthReferenceField 9000e-6;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P><B>Restrictions:</B> This model is tested in a limited number of flow situations.
</P>
<P>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.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "smoothingModel.html">smoothingModel</A>
</P>
</HTML>

32
doc/smoothingModel_noSmoothing.html
View File

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

34
doc/voidFractionModel.html
View File

@ -1,34 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>voidfractionModel command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>voidfractionModel model;
</PRE>
<UL><LI>model = name of the voidfractionModel to be applied
</UL>
<P><B>Examples:</B>
</P>
<PRE>voidfractionModel centre;
</PRE>
<P>Note: This examples list might not be complete - please look for other models (voidfractionModel_XY) in this documentation.
</P>
<P><B>Description:</B>
</P>
<P>The voidfractionModel is the base class for models to represent the DEM particle's volume in the CFD domain via a voidfraction field.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Default:</B> none.
</P>
</HTML>

60
doc/voidFractionModel_GaussVoidFraction.html
View File

@ -1,60 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>voidfractionModel_GaussVoidFraction command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>voidfractionModel Gauss;
GaussProps
{
maxCellsPerParticle number1;
alphaMin number2;
weight number3;
porosity number4;
}
</PRE>
<UL><LI><I>number1</I> = maximum number of cells covered by a particle (search will fail when more than <I>number1</I> cells are covered by the particle)
<LI><I>number2</I> = minimum limit for voidfraction
<LI><I>number3</I> = (optional) scaling of the particle volume to account for porosity or agglomerations.
<LI><I>number4</I> = (optional) diameter of the particle's representation is artificially increased according to <I>number2</I> * Vparticle, volume remains unaltered!
</UL>
<P><B>Examples:</B>
</P>
<PRE>voidfractionModel Gauss;
GaussProps
{
maxCellsPerParticle 1000;
alphaMin 0.10;
weight 1.;
porosity 1.;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>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.
</P>
<P>The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "voidfractionModel.html">voidfractionModel</A> , <A HREF = "voidFractionModel_bigParticleVoidFraction.html">bigParticle</A>
</P>
</HTML>

56
doc/voidFractionModel_IBVoidFraction.html
View File

@ -1,56 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>voidfractionModel_IBVoidFraction command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>voidfractionModel IB;
IBProps
{
maxCellsPerParticle number1;
alphaMin number2;
scaleUpVol number3;
}
</PRE>
<UL><LI><I>number1</I> = maximum number of cells covered by a particle (search will fail when more than <I>number1</I> cells are covered by the particle)
<LI><I>number2</I> = minimum limit for voidfraction
<LI><I>number3</I> = diameter of the particle's representation is artificially increased according to <I>number3</I> * Vparticle, volume remains unaltered!
</UL>
<P><B>Examples:</B>
</P>
<PRE>voidfractionModel IB;
IBProps
{
maxCellsPerParticle 1000;
alphaMin 0.10;
scaleUpVol 5.0;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>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.
</P>
<P>Code of this sub-model contributed by Alice Hager, JKU.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "voidfractionModel.html">voidfractionModel</A>
</P>
</HTML>

62
doc/voidFractionModel_bigParticleVoidFraction.html
View File

@ -1,62 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>voidfractionModel_bigParticleVoidFraction command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>voidfractionModel bigParticle;
bigParticleProps
{
maxCellsPerParticle number1;
alphaMin number2;
weight number3;
porosity number4;
}
</PRE>
<UL><LI><I>number1</I> = maximum number of cells covered by a particle (search will fail when more than <I>number1</I> cells are covered by the particle)
<LI><I>number2</I> = minimum limit for voidfraction
<LI><I>number3</I> = (optional) scaling of the particle volume to account for porosity or agglomerations.
<LI><I>number4</I> = (optional) diameter of the particle's representation is artificially increased according to <I>number2</I> * Vparticle, volume remains unaltered!
</UL>
<P><B>Examples:</B>
</P>
<PRE>voidfractionModel bigParticle;
bigParticleProps
{
maxCellsPerParticle 1000;
alphaMin 0.10;
weight 1.;
porosity 5.0;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>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.
</P>
<P>The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight.
</P>
<P>Parts of this sub-model contributed by Alice Hager, JKU.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "voidfractionModel.html">voidfractionModel</A>
</P>
</HTML>

50
doc/voidFractionModel_centreVoidFraction.html
View File

@ -1,50 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>voidfractionModel_centreVoidFraction command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>voidfractionModel centre;
centreProps
{
alphaMin number1;
weight number2;
}
</PRE>
<UL><LI><I>number1</I> = minimum limit for voidfraction
<LI><I>number2</I> = (optional) scaling of the particle volume to account for porosity or agglomerations.
</UL>
<P><B>Examples:</B>
</P>
<PRE>voidfractionModel centre;
centreProps
{
alphaMin 0.1;
weight 1.;
}
</PRE>
<P><B>Description:</B>
</P>
<P>The centre voidFraction model calculates the voidfraction in a CFD cell accounting for the volume of the particles whose centres are inside the cell.
</P>
<P>The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "voidfractionModel.html">voidfractionModel</A>
</P>
</HTML>

60
doc/voidFractionModel_dividedVoidFraction.html
View File

@ -1,60 +0,0 @@
<HTML>
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
</CENTER>
<HR>
<H3>voidfractionModel_dividedVoidFraction command
</H3>
<P><B>Syntax:</B>
</P>
<P>Defined in couplingProperties dictionary.
</P>
<PRE>voidfractionModel divided;
dividedProps
{
alphaMin number1;
interpolation;
weight number2;
porosity number3;
}
</PRE>
<UL><LI><I>number1</I> = minimum limit for voidfraction
<LI><I>interpolation</I> = flag to interpolate voidfraction to particle positions (normally off)
<LI><I>number2</I> = (optional) scaling of the particle volume to account for porosity or agglomerations.
<LI><I>number3</I> = (optional) diameter of the particle's representation is artificially increased according to <I>number2</I> * Vparticle, volume remains unaltered!
</UL>
<P><B>Examples:</B>
</P>
<PRE>voidfractionModel divided;
dividedProps
{
alphaMin 0.2;
}
</PRE>
<P><B>Description:</B>
</P>
<P>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.
</P>
<P>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.
</P>
<P>The particle volume occupied in the CFD domain can be adjusted by the parameter "weight", using Vparticle=dsphere^3*pi/6*weight.
</P>
<P>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.
</P>
<P><B>Restrictions:</B> none.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "voidfractionModel.html">voidfractionModel</A>
</P>
</HTML>