diff --git a/README b/README new file mode 100755 index 00000000..fd2ca756 --- /dev/null +++ b/README @@ -0,0 +1,81 @@ +/*---------------------------------------------------------------------------*\ + CFDEMcoupling - Open Source CFD-DEM coupling + + CFDEMcoupling is part of the CFDEMproject + www.cfdem.com + Christoph Goniva, christoph.goniva@cfdem.com + Copyright 2009-2012 JKU Linz + Copyright 2012- DCS Computing GmbH, Linz +------------------------------------------------------------------------------- +License + This file is part of CFDEMcoupling. + + CFDEMcoupling is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 3 of the License, or (at your + option) any later version. + + CFDEMcoupling is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with CFDEMcoupling; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Description + This code is designed to realize coupled CFD-DEM simulations using LIGGGHTS + and OpenFOAM. Note: this code is not part of OpenFOAM (see DISCLAIMER). +\*---------------------------------------------------------------------------*/ + + +CFDEM coupling provides an open source parallel coupled CFD-DEM framework +combining the strengths of LIGGGHTS DEM code and the Open Source +CFD package OpenFOAM(R)(*). The CFDEMcoupling toolbox allows to expand +standard CFD solvers of OpenFOAM(R)(*) to include a coupling to the DEM +code LIGGGHTS. In this toolbox the particle representation within the +CFD solver is organized by "cloud" classes. Key functionalities are organised +in sub-models (e.g. force models, data exchange models, etc.) which can easily +be selected and combined by dictionary settings. + +The coupled solvers run fully parallel on distributed-memory clusters. + +Features are: + +- its modular approach allows users to easily implement new models +- its MPI parallelization enables to use it for large scale problems +- the "forum"_lws on CFD-DEM gives the possibility to exchange with other + users / developers +- the use of GIT allows to easily update to the latest version +- basic documentation is provided + +The file structure: + +- "src" directory including the source files of the coupling toolbox and models +- "applications" directory including the solver files for coupled CFD-DEM simulations +- "doc" directory including the documentation of CFDEMcoupling +- "tutorials" directory including basic tutorial cases showing the functionality + + + +Details on installation are given on the "www.cfdem.com" + +The functionality of this CFD-DEM framwork is described via "tutorial cases" showing +how to use different solvers and models. + +CFDEMcoupling stands for Computational Fluid Dynamics (CFD) - +Discrete Element Method (DEM) coupling. + +CFDEMcoupling is an open-source code, distributed freely under the terms of the +GNU Public License (GPL). + +Core development of CFDEMcoupling is done by +Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 + + +\*---------------------------------------------------------------------------*/ +(*) "OpenFOAM(R)"_of is a registered trade mark of the ESI Group. +This offering is not affiliated, approved or endorsed by ESI Group, +the producer of the OpenFOAM® software and owner of the OpenFOAM® trade mark. +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/cfdemSolverIB/cfdemSolverIB.C b/applications/solvers/cfdemSolverIB/cfdemSolverIB.C index 2df2a46e..93f0d41d 100755 --- a/applications/solvers/cfdemSolverIB/cfdemSolverIB.C +++ b/applications/solvers/cfdemSolverIB/cfdemSolverIB.C @@ -130,9 +130,12 @@ int main(int argc, char *argv[]) volScalarField rUA = 1.0/UEqn.A(); U = rUA*UEqn.H(); + #ifdef version23 + phi = (fvc::interpolate(U) & mesh.Sf()); // there is a new version in 23x + #else phi = (fvc::interpolate(U) & mesh.Sf()) + fvc::ddtPhiCorr(rUA, U, phi); - + #endif adjustPhi(phi, U, p); #if defined(version22) diff --git a/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C b/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C index 73c97d60..76a6b58d 100644 --- a/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C +++ b/applications/solvers/cfdemSolverPiso/cfdemSolverPiso.C @@ -73,7 +73,7 @@ int main(int argc, char *argv[]) // do particle stuff particleCloud.clockM().start(2,"Coupling"); particleCloud.evolve(voidfraction,Us,U); - + Info << "update Ksl.internalField()" << endl; Ksl = particleCloud.momCoupleM(0).impMomSource(); particleCloud.smoothingM().smoothen(Ksl); @@ -88,8 +88,8 @@ int main(int argc, char *argv[]) // Momentum predictor fvVectorMatrix UEqn ( - fvm::ddt(voidfraction,U) //particleCloud.ddtVoidfractionU(U,voidfraction) // - + fvm::div(phi, U) + fvm::ddt(voidfraction,U) + fvm::Sp(fvc::ddt(voidfraction),U) + + fvm::div(phi,U) + fvm::Sp(fvc::div(phi),U) // + turbulence->divDevReff(U) + particleCloud.divVoidfractionTau(U, voidfraction) == diff --git a/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C b/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C index af3134d5..ac015944 100644 --- a/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C +++ b/applications/solvers/cfdemSolverPisoScalar/cfdemSolverPisoScalar.C @@ -133,8 +133,12 @@ int main(int argc, char *argv[]) U = rUA*UEqn.H(); + #ifdef version23 + phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ); + #else phi = ( fvc::interpolate(U*voidfraction) & mesh.Sf() ) + fvc::ddtPhiCorr(rUAvoidfraction, U, phi); + #endif surfaceScalarField phiS(fvc::interpolate(Us*voidfraction) & mesh.Sf()); surfaceScalarField phiGes = phi + rUAf*(fvc::interpolate(Ksl/rho) * phiS); if (modelType=="A") diff --git a/doc/CFDEMcoupling_Manual.html b/doc/CFDEMcoupling_Manual.html index e8dd38f1..0fc3dcb6 100644 --- a/doc/CFDEMcoupling_Manual.html +++ b/doc/CFDEMcoupling_Manual.html @@ -21,7 +21,7 @@

1. Contents

-

The CFDEMcoupling documentation is organized into the following sections. If you find errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so we can improve the CFDEMcoupling documentation. +

The CFDEMcoupling documentation is organized into the following sections. If you find any errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so the CFDEMcoupling documentation can be improved.

1.1 About CFDEMcoupling
1.2 Installation
@@ -63,11 +63,11 @@

Details on installation are given on the CFDEMproject WWW Site . -The functionality of this CFD-DEM framwork is described via tutorial cases showing how to use different solvers and models. +The functionality of this CFD-DEM framework is described via tutorial cases showing how to use different solvers and models.

CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling.

-

CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL). +

CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL).

Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012

@@ -90,7 +90,7 @@ In order to get the latest code version, please use the git repository at http:/

General:

-

Each solver of the CFDEMcoupling is comes with at least one tutorial example, showing its functionality and correct useage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization). +

Each solver of the CFDEMcoupling comes with at least one tutorial example, showing its functionality and correct usage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization).

Location:

@@ -108,7 +108,7 @@ In order to get the latest code version, please use the git repository at http:/

The main settings of a simulation are done via dictionaries:

-

The DEM setup of each case is defined by a LIGGGHTS input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the LIGGGHTS setup, please have a look in the LIGGGHTS manual. +

The DEM setup of each case is defined by a LIGGGHTS input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the LIGGGHTS setup, please have a look at the LIGGGHTS manual.

Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in OpenFOAM(R)(*) documentations (www.openFoam.com)(*).

@@ -164,16 +164,16 @@ In order to get the latest code version, please use the git repository at http:/ 

modelType
-

"modelType" refers to the formulation of the equations to be solved. Choose "A" or "B", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their appliccability", JFM. "A" requres the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". +

"modelType" refers to the formulation of the equations to be solved. Choose "A" or "B", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM. "A" requires the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". 

couplingInterval
-

The coupling interval determines the time passing between two CFD-DEM data exchanges. +

The coupling interval determines the time passing between two CFD-DEM data exchanges.

A useful procedure would be: -1) Set the DEM TS in the in.xxx according to the needs of the pure DEM problem. +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 or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!". +3) Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!".

Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s.

diff --git a/doc/CFDEMcoupling_Manual.pdf b/doc/CFDEMcoupling_Manual.pdf index e9b710f4..3e18714a 100644 Binary files a/doc/CFDEMcoupling_Manual.pdf and b/doc/CFDEMcoupling_Manual.pdf differ diff --git a/doc/CFDEMcoupling_Manual.txt b/doc/CFDEMcoupling_Manual.txt index ba1a5717..69f8f64e 100644 --- a/doc/CFDEMcoupling_Manual.txt +++ b/doc/CFDEMcoupling_Manual.txt @@ -12,7 +12,7 @@ CFDEMcoupling Documentation :h2,c :line 1. Contents :h3 -The CFDEMcoupling documentation is organized into the following sections. If you find errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so we can improve the CFDEMcoupling documentation. +The CFDEMcoupling documentation is organized into the following sections. If you find any errors or omissions in this manual or have suggestions for useful information to add, please send an email to the developers so the CFDEMcoupling documentation can be improved. 1.1 "About CFDEMcoupling"_#1_1 1.2 "Installation"_#1_2 @@ -45,11 +45,11 @@ The file structure: :ule Details on installation are given on the "CFDEMproject WWW Site"_lws . -The functionality of this CFD-DEM framwork is described via "tutorial cases"_#_1_2 showing how to use different solvers and models. +The functionality of this CFD-DEM framework is described via "tutorial cases"_#_1_2 showing how to use different solvers and models. CFDEMcoupling stands for Computational Fluid Dynamics (CFD) -Discrete Element Method (DEM) coupling. -CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL). +CFDEMcoupling is an open-source code, distributed freely under the terms of the GNU Public License (GPL). Core development of CFDEMcoupling is done by Christoph Goniva and Christoph Kloss, both at DCS Computing GmbH, 2012 @@ -71,7 +71,7 @@ In order to get the latest code version, please use the git repository at http:/ [General:] -Each solver of the CFDEMcoupling is comes with at least one tutorial example, showing its functionality and correct useage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization). +Each solver of the CFDEMcoupling comes with at least one tutorial example, showing its functionality and correct usage. Provided that the installation is correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform all necessary steps (preprocessing, run, postprocessing, visualization). [Location:] @@ -89,7 +89,7 @@ Provided that the installation is correct, the tutorials can be run via "Allrun. The main settings of a simulation are done via dictionaries: -The DEM setup of each case is defined by a "LIGGGHTS"_lig input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS"_lig setup, please have a look in the "LIGGGHTS"_lig manual. +The DEM setup of each case is defined by a "LIGGGHTS"_lig input file located in $caseDir/DEM (e.g. in.liggghts_init). For details on the "LIGGGHTS"_lig setup, please have a look at the "LIGGGHTS"_lig manual. Standard CFD settings are defined in $caseDir/CFD/constant (e.g. transportProperties, RASproperties, etc.) and $caseDir/CFD/system (e.g. fvSchemes, controlDict). You can find more information on that in "OpenFOAM(R)(*)"_of documentations (www.openFoam.com)(*). @@ -133,16 +133,16 @@ Reasonable example settings for the "couplingProperties" dictionary are given in modelType :pre -"modelType" refers to the formulation of the equations to be solved. Choose "A" or "B", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their appliccability", JFM. "A" requres the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". +"modelType" refers to the formulation of the equations to be solved. Choose "A" or "B", according to Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM. "A" requires the use of the force models gradPForce and viscForce, whereas "B" requires the force model "Archimedes". couplingInterval :pre -The coupling interval determines the time passing between two CFD-DEM data exchanges. +The coupling interval determines the time passing between two CFD-DEM data exchanges. A useful procedure would be: -1) Set the DEM TS in the in.xxx according to the needs of the pure DEM problem. +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 or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!". +3) Choose the CFD timestep in the controlDict. It must be equal to or smaller than the coupling time, otherwise you will get the error: "Error - TS bigger than coupling interval!". Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen every 0.0001s. diff --git a/doc/IOModel_basicIO.html b/doc/IOModel_basicIO.html index 3d8ff298..8152c9e9 100644 --- a/doc/IOModel_basicIO.html +++ b/doc/IOModel_basicIO.html @@ -21,7 +21,7 @@

Description:

-

The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the ceyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation. +

The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation.

Restrictions: None.

diff --git a/doc/IOModel_basicIO.txt b/doc/IOModel_basicIO.txt index d73c5168..98daa37a 100644 --- a/doc/IOModel_basicIO.txt +++ b/doc/IOModel_basicIO.txt @@ -19,7 +19,7 @@ IOModel "basicIO"; :pre [Description:] -The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the ceyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation. +The basic IO-model writes particle positions velocities and radii to files. The default output directory ($casePath/CFD/proc*/time/lagrangian). Using the keyword "serialOutput;" in couplingProperties the IO is serial to the directory ($casePath/CFD/lagrangian). In the latter case only the data on processor 0 is written! Data is written every write time of the CFD simulation. [Restrictions:] None. diff --git a/doc/IOModel_trackIO.html b/doc/IOModel_trackIO.html index 0d91e418..28d1e861 100644 --- a/doc/IOModel_trackIO.html +++ b/doc/IOModel_trackIO.html @@ -21,7 +21,7 @@

Description:

-

The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks generats tracks of the particles and writes them to a vtk file. +

The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file.

Restrictions: None.

diff --git a/doc/IOModel_trackIO.txt b/doc/IOModel_trackIO.txt index 7aa03e77..dff7906e 100644 --- a/doc/IOModel_trackIO.txt +++ b/doc/IOModel_trackIO.txt @@ -19,7 +19,7 @@ IOModel "trackIO"; :pre [Description:] -The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks generats tracks of the particles and writes them to a vtk file. +The trackIO-model is based on sophIO model and additionally writes fields necessary to use the particleTracks utility (which needs a particleTrackProperties file in the constant dir). The particleTracks utility generates tracks of the particles and writes them to a vtk file. [Restrictions:] None. diff --git a/doc/averagingModel.html b/doc/averagingModel.html index ecc7defa..5237b6d4 100644 --- a/doc/averagingModel.html +++ b/doc/averagingModel.html @@ -22,7 +22,7 @@ 
averagingModel dense;
 averagingModel dilute;
-

Note: This examples list might not be complete - please look for other averagin models (averagingModel_XY) in this documentation. +

Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation.

Description:

diff --git a/doc/averagingModel.txt b/doc/averagingModel.txt index 6ec694a0..36c327e7 100644 --- a/doc/averagingModel.txt +++ b/doc/averagingModel.txt @@ -20,7 +20,7 @@ model = name of averaging model to be applied :ul averagingModel dense; averagingModel dilute; :pre -Note: This examples list might not be complete - please look for other averagin models (averagingModel_XY) in this documentation. +Note: This examples list might not be complete - please look for other averaging models (averagingModel_XY) in this documentation. [Description:] diff --git a/doc/cfdemSolverIB.html b/doc/cfdemSolverIB.html index c1850e53..556d2441 100644 --- a/doc/cfdemSolverIB.html +++ b/doc/cfdemSolverIB.html @@ -14,7 +14,7 @@

"cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating the dynamics between immersed bodies and the surrounding fluid. Being an implementation of an immersed boundary method it allows tackling problems where the body diameter exceeds the maximal size of a fluid cell. Using the toolbox of OpenFOAM(R)(*) the governing equations of the fluid are computed and the corrections of velocity and pressure field with respect to the body-movement information, gained from LIGGGHTS, are incorporated.

-

Code of this solver contributions by Alice Hager, JKU. +

Code of this solver contributions by Alice Hager, JKU.

Algorithm:

diff --git a/doc/cfdemSolverIB.txt b/doc/cfdemSolverIB.txt index a3ed4d88..4bb7c2af 100644 --- a/doc/cfdemSolverIB.txt +++ b/doc/cfdemSolverIB.txt @@ -12,7 +12,7 @@ cfdemSolverIB command :h3 "cfdemSolverIB" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework, for calculating the dynamics between immersed bodies and the surrounding fluid. Being an implementation of an immersed boundary method it allows tackling problems where the body diameter exceeds the maximal size of a fluid cell. Using the toolbox of OpenFOAM(R)(*) the governing equations of the fluid are computed and the corrections of velocity and pressure field with respect to the body-movement information, gained from LIGGGHTS, are incorporated. -Code of this solver contributions by Alice Hager, JKU. +Code of this solver contributions by Alice Hager, JKU. [Algorithm:] diff --git a/doc/cfdemSolverPiso.html b/doc/cfdemSolverPiso.html index ebba4c7a..dda40592 100644 --- a/doc/cfdemSolverPiso.html +++ b/doc/cfdemSolverPiso.html @@ -11,7 +11,7 @@

Description:

-

"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying 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. +

"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying the PISO algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the DEM code "LIGGGHTS". The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles whose trajectories are calculated in the DEM code LIGGGHTS.

see:

diff --git a/doc/cfdemSolverPiso.txt b/doc/cfdemSolverPiso.txt index 551adaea..3885699b 100644 --- a/doc/cfdemSolverPiso.txt +++ b/doc/cfdemSolverPiso.txt @@ -9,7 +9,7 @@ cfdemSolverPiso command :h3 [Description:] -"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying 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. +"cfdemSolverPiso" is a coupled CFD-DEM solver using CFDEMcoupling, an open source parallel coupled CFD-DEM framework. Based on pisoFoam(R)(*), a finite volume based solver for turbulent Navier-Stokes equations applying the PISO algorithm, "cfdemSolverPiso" has additional functionality for a coupling to the DEM code "LIGGGHTS". The volume averaged Navier-Stokes Equations are solved accounting for momentum exchange and volume displacement of discrete particles whose trajectories are calculated in the DEM code LIGGGHTS. see: diff --git a/doc/clockModel_standardClock.html b/doc/clockModel_standardClock.html index b26c6c0d..57ec9ee9 100644 --- a/doc/clockModel_standardClock.html +++ b/doc/clockModel_standardClock.html @@ -22,7 +22,7 @@

Description:

The "standardClock" model is a basic clockModel model which measures the run time between every ".start(int arrayPos,string name)" and ".stop(string name)" statement placed in the code. If a ".start(name)" is called more than once (e.g. in a loop) the accumulated times are calculated. After the simulation has finished, the data is stored in $caseDir/CFD/clockData/$startTime/*.txt . -Since the measurements are stored in an array, it is necessary to put a variable arrayPos (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If arrayPos is out of bounds, the array size will be doubled. The stop command does not need arrayPos, since the class remembers the positions. The string name is 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. +Since the measurements are stored in an array, it is necessary to put a variable arrayPos (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If arrayPos is out of bounds, the array size will be doubled. The stop command does not need arrayPos, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like ".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a safety feature, because if the name is not equal to the started name, output will be produced for information. After the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like 'python < matPlot.py' and you have to be in the directory of the desired time step, where there is a file called "timeEvalFull.txt", which contains averaged and maximum data with respect to the number of processes.

Restrictions: none. diff --git a/doc/clockModel_standardClock.txt b/doc/clockModel_standardClock.txt index 117352d2..30d675cb 100644 --- a/doc/clockModel_standardClock.txt +++ b/doc/clockModel_standardClock.txt @@ -20,7 +20,7 @@ clockModel standardClock; :pre [Description:] The "standardClock" model is a basic clockModel model which measures the run time between every ".start(int arrayPos,string name)" and ".stop(string name)" statement placed in the code. If a ".start(name)" is called more than once (e.g. in a loop) the accumulated times are calculated. After the simulation has finished, the data is stored in $caseDir/CFD/clockData/$startTime/*.txt . -Since the measurements are stored in an array, it is necessary to put a variable {arrayPos} (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If {arrayPos} is out of bounds, the array size will be doubled. The stop command does not need {arrayPos}, since the class remembers the positions. The string name is 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. +Since the measurements are stored in an array, it is necessary to put a variable {arrayPos} (type integer) at the start command. Those do not need to be in ascending order and positions may be omitted. The standard size of this array is 30 and can be changed at the initialization of the standardClock class. If {arrayPos} is out of bounds, the array size will be doubled. The stop command does not need {arrayPos}, since the class remembers the positions. The string name is intended for easier evaluation afterwards an may be omitted like ".start(int arrayPos)" and ".stop()". The command ".stop(string name)" is a safety feature, because if the name is not equal to the started name, output will be produced for information. After the case ran you may use the matPlot.py script located in $CFDEM_UT_DIR/vizClock/ to produce a graphical output of your measurements. The usage is like 'python < matPlot.py' and you have to be in the directory of the desired time step, where there is a file called "timeEvalFull.txt", which contains averaged and maximum data with respect to the number of processes. [Restrictions:] none. diff --git a/doc/dataExchangeModel_oneWayVTK.html b/doc/dataExchangeModel_oneWayVTK.html index 800af8e2..def26192 100644 --- a/doc/dataExchangeModel_oneWayVTK.html +++ b/doc/dataExchangeModel_oneWayVTK.html @@ -28,7 +28,7 @@ oneWayVTKProps

  • filename = filename of the VTK file series -
  • number = maximum nuber of particles in DEM simulation +
  • number = maximum number of particles in DEM simulation diff --git a/doc/dataExchangeModel_oneWayVTK.txt b/doc/dataExchangeModel_oneWayVTK.txt index f3e0153a..3cf66429 100644 --- a/doc/dataExchangeModel_oneWayVTK.txt +++ b/doc/dataExchangeModel_oneWayVTK.txt @@ -23,7 +23,7 @@ oneWayVTKProps {timeStep} = time step size of stored DEM data :ulb,l {path} = path to the VTK data files relative do simulation directory :l {filename} = filename of the VTK file series :l -{number} = maximum nuber of particles in DEM simulation :l +{number} = maximum number of particles in DEM simulation :l :ule [Examples:] diff --git a/doc/dataExchangeModel_twoWayFiles.html b/doc/dataExchangeModel_twoWayFiles.html index 30a72333..46d2d891 100644 --- a/doc/dataExchangeModel_twoWayFiles.html +++ b/doc/dataExchangeModel_twoWayFiles.html @@ -22,7 +22,7 @@ twoWayFilesProps @@ -41,7 +41,7 @@ twoWayFilesProps

    Restrictions:

    -

    Developed only for two processors, one for DEM and on for CFD run. +

    Developed only for two processors, one for DEM and one for CFD run.

    Related commands:

    diff --git a/doc/dataExchangeModel_twoWayFiles.txt b/doc/dataExchangeModel_twoWayFiles.txt index 20c4d8d7..cd31b167 100644 --- a/doc/dataExchangeModel_twoWayFiles.txt +++ b/doc/dataExchangeModel_twoWayFiles.txt @@ -19,7 +19,7 @@ twoWayFilesProps \}; :pre {filename} = filename of the VTK file series :ulb,l -{number} = maximum nuber of particles in DEM simulation :l +{number} = maximum number of particles in DEM simulation :l :ule [Examples:] @@ -37,7 +37,7 @@ The data exchange model performs the data exchange between the DEM code and the [Restrictions:] -Developed only for two processors, one for DEM and on for CFD run. +Developed only for two processors, one for DEM and one for CFD run. [Related commands:] diff --git a/doc/forceModel_ArchimedesIB.html b/doc/forceModel_ArchimedesIB.html index df087d34..01468568 100644 --- a/doc/forceModel_ArchimedesIB.html +++ b/doc/forceModel_ArchimedesIB.html @@ -47,7 +47,7 @@ ArchimedesIBProps

    Description:

    -

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB' volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundrary method. +

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB' volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method.

    Restrictions:

    diff --git a/doc/forceModel_ArchimedesIB.txt b/doc/forceModel_ArchimedesIB.txt index 4b26bb38..b9aca335 100644 --- a/doc/forceModel_ArchimedesIB.txt +++ b/doc/forceModel_ArchimedesIB.txt @@ -42,7 +42,7 @@ ArchimedesIBProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB' volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundrary method. +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ArchimedesIB model is a model that calculates the ArchimedesIB' volumetric lift force stemming from density difference of fluid and particle. This model is especially suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method. [Restrictions:] diff --git a/doc/forceModel_DiFeliceDrag.html b/doc/forceModel_DiFeliceDrag.html index 1fe8dacf..9b02164b 100644 --- a/doc/forceModel_DiFeliceDrag.html +++ b/doc/forceModel_DiFeliceDrag.html @@ -28,7 +28,7 @@ DiFeliceDragProps
  • density = name of the finite volume gravity field -
  • interpolation = flag to use interolate interpolated voidfraction and velocity values (normally off) +
  • interpolation = flag to use interpolated voidfraction and velocity values (normally off) diff --git a/doc/forceModel_DiFeliceDrag.txt b/doc/forceModel_DiFeliceDrag.txt index b2e0c85a..7180d17f 100644 --- a/doc/forceModel_DiFeliceDrag.txt +++ b/doc/forceModel_DiFeliceDrag.txt @@ -24,7 +24,7 @@ DiFeliceDragProps {U} = name of the finite volume fluid velocity field :ulb,l {density} = name of the finite volume gravity field :l -{interpolation} = flag to use interolate interpolated voidfraction and velocity values (normally off) :l +{interpolation} = flag to use interpolated voidfraction and velocity values (normally off) :l :ule [Examples:] diff --git a/doc/forceModel_GidaspowDrag.html b/doc/forceModel_GidaspowDrag.html index 09861907..c31a57ce 100644 --- a/doc/forceModel_GidaspowDrag.html +++ b/doc/forceModel_GidaspowDrag.html @@ -21,8 +21,9 @@ GidaspowDragProps { velFieldName "U"; densityFieldName "density"; - voidfractionFieldName "voidfraction"; + voidfractionFieldName "voidfraction"; phi "scalar"; + interpolation; };

    Examples: @@ -45,12 +48,12 @@ GidaspowDragProps { velFieldName "U"; densityFieldName "rho"; - voidfractionFieldName "voidfraction"; + voidfractionFieldName "voidfraction"; }

    Description:

    -

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Egrun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): "Discrete particle simulation of particulate systems: Theoretical developments" ,ChemEngScience). +

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Ergun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): "Discrete particle simulation of particulate systems: Theoretical developments", ChemEngScience).

    Restrictions:

    diff --git a/doc/forceModel_GidaspowDrag.txt b/doc/forceModel_GidaspowDrag.txt index a4e5718f..5de896bf 100644 --- a/doc/forceModel_GidaspowDrag.txt +++ b/doc/forceModel_GidaspowDrag.txt @@ -19,14 +19,16 @@ GidaspowDragProps \{ velFieldName "U"; densityFieldName "density"; - voidfractionFieldName "voidfraction"; + voidfractionFieldName "voidfraction"; phi "scalar"; + interpolation; \}; :pre {U} = name of the finite volume fluid velocity field :ulb,l {density} = name of the finite volume gravity field :l {voidfraction} = name of the finite volume voidfraction field :l {phi} = drag correction factor (in doubt 1) :l +{interpolation} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l :ule [Examples:] @@ -39,12 +41,12 @@ GidaspowDragProps \{ velFieldName "U"; densityFieldName "rho"; - voidfractionFieldName "voidfraction"; + voidfractionFieldName "voidfraction"; \} :pre [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Egrun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): "Discrete particle simulation of particulate systems: Theoretical developments" ,ChemEngScience). +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The GidaspowDrag model is a model that calculates the particle based drag force following the correlation of Gidaspow which is a combination of Ergun (1952) and Wen & Yu (1966) (see Zhu et al. (2007): "Discrete particle simulation of particulate systems: Theoretical developments", ChemEngScience). [Restrictions:] diff --git a/doc/forceModel_KochHillDrag.html b/doc/forceModel_KochHillDrag.html index 94857f53..3938a881 100644 --- a/doc/forceModel_KochHillDrag.html +++ b/doc/forceModel_KochHillDrag.html @@ -31,7 +31,7 @@ KochHillDragProps
  • voidfraction = name of the finite volume voidfraction field -
  • interpolation = flag to use interpolated voidfraction and fluid velocity values (normally off) +
  • interpolation = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values
  • implDEM = flag to use implicit formulation of drag on DEM side (normally off) @@ -52,7 +52,7 @@ KochHillDragProps

    Description:

    -

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental study on multiple-spout fluidized beds" ,ChemEngScience). +

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental study on multiple-spout fluidized beds", ChemEngScience).

    Restrictions:

    diff --git a/doc/forceModel_KochHillDrag.txt b/doc/forceModel_KochHillDrag.txt index 565c8202..d8ab7eb8 100644 --- a/doc/forceModel_KochHillDrag.txt +++ b/doc/forceModel_KochHillDrag.txt @@ -26,7 +26,7 @@ KochHillDragProps {U} = name of the finite volume fluid velocity field :ulb,l {density} = name of the finite volume gravity field :l {voidfraction} = name of the finite volume voidfraction field :l -{interpolation} = flag to use interpolated voidfraction and fluid velocity values (normally off) :l +{interpolation} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l {implDEM} = flag to use implicit formulation of drag on DEM side (normally off) :l :ule @@ -45,7 +45,7 @@ KochHillDragProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental study on multiple-spout fluidized beds" ,ChemEngScience). +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The KochHillDrag model is a model that calculates the particle based drag force following the correlation of Koch & Hill (2001) (see van Buijtenen et al. (2011): "Numerical and experimental study on multiple-spout fluidized beds", ChemEngScience). [Restrictions:] diff --git a/doc/forceModel_LaEuScalarTemp.html b/doc/forceModel_LaEuScalarTemp.html index 03f3cd37..c0075c96 100644 --- a/doc/forceModel_LaEuScalarTemp.html +++ b/doc/forceModel_LaEuScalarTemp.html @@ -28,6 +28,8 @@ LaEuScalarTempProps lambda value; Cp value1; densityFieldName "density"; + interpolation; + verbose; };

    Examples: @@ -71,7 +77,7 @@ LaEuScalarTempProps

    Description:

    -

    This "forceModel" does not influence the particles or the fluid flow! Using the particles' temperature a scalar field representing "particle-fluid heatflux" is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112 +

    This "forceModel" does not influence the particles or the fluid flow! Using the particles' temperature a scalar field representing "particle-fluid heatflux" is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112

    Restrictions:

    diff --git a/doc/forceModel_LaEuScalarTemp.txt b/doc/forceModel_LaEuScalarTemp.txt index 6c0daac5..a2b8690d 100644 --- a/doc/forceModel_LaEuScalarTemp.txt +++ b/doc/forceModel_LaEuScalarTemp.txt @@ -26,6 +26,8 @@ LaEuScalarTempProps lambda value; Cp value1; densityFieldName "density"; + interpolation; + verbose; \}; :pre {U} = name of the finite volume fluid velocity field :ulb,l @@ -37,6 +39,8 @@ LaEuScalarTempProps {value} = fluid thermal conductivity \[W/(m*K)\] :l {value1} = fluid specific heat capacity \[W*s/(kg*K)\] :l {density} = name of the finite volume fluid density field :l +{interpolation} = (optional, normally off) flag to use interpolated voidfraction and fluid velocity values :l +{verbose} = (normally off) for verbose run :l :ule [Examples:] @@ -60,7 +64,7 @@ LaEuScalarTempProps [Description:] -This "forceModel" does not influence the particles or the fluid flow! Using the particles' temperature a scalar field representing "particle-fluid heatflux" is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112 +This "forceModel" does not influence the particles or the fluid flow! Using the particles' temperature a scalar field representing "particle-fluid heatflux" is calculated. The solver then uses this source field in the scalar transport equation for the temperature. The model for convective heat transfer is based on Li and Mason (2000), A computational investigation of transient heat transfer in pneumatic transport of granular particles, Pow.Tech 112 [Restrictions:] diff --git a/doc/forceModel_ShirgaonkarIB.html b/doc/forceModel_ShirgaonkarIB.html index 5956cc2b..5e198cfc 100644 --- a/doc/forceModel_ShirgaonkarIB.html +++ b/doc/forceModel_ShirgaonkarIB.html @@ -47,7 +47,7 @@ ShirgaonkarIBProps

    Description:

    -

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): "A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion", Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundrary method. +

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): "A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion", Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method.

    References:

    diff --git a/doc/forceModel_ShirgaonkarIB.txt b/doc/forceModel_ShirgaonkarIB.txt index f9a6223e..9f488cfc 100644 --- a/doc/forceModel_ShirgaonkarIB.txt +++ b/doc/forceModel_ShirgaonkarIB.txt @@ -42,7 +42,7 @@ ShirgaonkarIBProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): "A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion", Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundrary method. +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The ShirgaonkarIB model calculates the drag force (viscous and pressure force) acting on each particle in a resolved manner (see Shirgaonkar et al. (2009): "A new mathematical formulation and fast algorithm for fully resolved simulation of self-propulsion", Journal of Comp. Physics). This model is only suited for resolved CFD-DEM simulations where the particle is represented by immersed boundary method. [References:] diff --git a/doc/forceModel_gradPForce.html b/doc/forceModel_gradPForce.html index 410cd208..f5553131 100644 --- a/doc/forceModel_gradPForce.html +++ b/doc/forceModel_gradPForce.html @@ -31,7 +31,7 @@ gradPForceProps
  • U = name of the finite volume fluid velocity field -
  • interpolation = flag to use interolate interpolated pressure values (normally off) +
  • interpolation = flag to use interpolated pressure values (normally off) diff --git a/doc/forceModel_gradPForce.txt b/doc/forceModel_gradPForce.txt index c1d2bdf3..7a0801d3 100644 --- a/doc/forceModel_gradPForce.txt +++ b/doc/forceModel_gradPForce.txt @@ -26,7 +26,7 @@ gradPForceProps {pressure} = name of the finite volume fluid pressure field :ulb,l {density} = name of the finite volume gravity field :l {U} = name of the finite volume fluid velocity field :l -{interpolation} = flag to use interolate interpolated pressure values (normally off) :l +{interpolation} = flag to use interpolated pressure values (normally off) :l :ule [Examples:] diff --git a/doc/forceModel_particleCellVolume.html b/doc/forceModel_particleCellVolume.html index d906882c..c34aa71e 100644 --- a/doc/forceModel_particleCellVolume.html +++ b/doc/forceModel_particleCellVolume.html @@ -21,7 +21,7 @@ particleCellVolumeProps { upperThreshold value; lowerThreshold value2; - verbous; + verbose; };
  • value = only cells with a field value (magnitude) lower than this upper threshold are considered @@ -40,13 +40,13 @@ particleCellVolumeProps { upperThreshold 0.999; lowerThreshold 0; - verbous; + verbose; }

    Description:

    This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles as they are represented on the CFD mesh is calculated. Further the total volume of the cells particles are in is calculated. -At "writeTime" a field named particleCellVolume , where scalarField is the name of the original field, is written. This can be can the be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given. +At "writeTime" a field named particleCellVolume , where scalarField is the name of the original field, is written. This can then be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given.

    Restrictions:

    diff --git a/doc/forceModel_particleCellVolume.txt b/doc/forceModel_particleCellVolume.txt index 21bc23dd..93b1dbfb 100644 --- a/doc/forceModel_particleCellVolume.txt +++ b/doc/forceModel_particleCellVolume.txt @@ -19,7 +19,7 @@ particleCellVolumeProps \{ upperThreshold value; lowerThreshold value2; - verbous; + verbose; \}; :pre {value} = only cells with a field value (magnitude) lower than this upper threshold are considered :l @@ -36,13 +36,13 @@ particleCellVolumeProps \{ upperThreshold 0.999; lowerThreshold 0; - verbous; + verbose; \} :pre [Description:] This "forceModel" does not influence the particles or the simulation - it is a postprocessing tool! The total volume of the particles as they are represented on the CFD mesh is calculated. Further the total volume of the cells particles are in is calculated. -At "writeTime" a field named particleCellVolume , where scalarField is the name of the original field, is written. This can be can the be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given. +At "writeTime" a field named particleCellVolume , where scalarField is the name of the original field, is written. This can then be probed using standard function object probes. Analogously a field named cellVolume is written. Using the verbose option a screen output is given. [Restrictions:] diff --git a/doc/forceModel_viscForce.html b/doc/forceModel_viscForce.html index 73b6ad9f..ebd76ec6 100644 --- a/doc/forceModel_viscForce.html +++ b/doc/forceModel_viscForce.html @@ -28,7 +28,7 @@ viscForceProps
  • density = name of the finite volume gravity field -
  • interpolation = flag to use interolate interpolated stress values (normally off) +
  • interpolation = flag to use interpolated stress values (normally off) @@ -46,7 +46,7 @@ viscForceProps

    Description:

    -

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability" ,JFM). +

    The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM).

    Restrictions:

    diff --git a/doc/forceModel_viscForce.txt b/doc/forceModel_viscForce.txt index a7986d1c..8577846c 100644 --- a/doc/forceModel_viscForce.txt +++ b/doc/forceModel_viscForce.txt @@ -24,7 +24,7 @@ viscForceProps {U} = name of the finite volume fluid velocity field :ulb,l {density} = name of the finite volume gravity field :l -{interpolation} = flag to use interolate interpolated stress values (normally off) :l +{interpolation} = flag to use interpolated stress values (normally off) :l :ule [Examples:] @@ -41,7 +41,7 @@ viscForceProps [Description:] -The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability" ,JFM). +The force model performs the calculation of forces (e.g. fluid-particle interaction forces) acting on each DEM particle. The viscForce model calculates the particle based viscous force, -(grad(tau)) * Vparticle (see Zhou et al. (2010): "Discrete particle simulation of particle-fluid flow: model formulations and their applicability", JFM). [Restrictions:] diff --git a/doc/githubAccess_public.html b/doc/githubAccess_public.html index 2ca41186..b27e7093 100644 --- a/doc/githubAccess_public.html +++ b/doc/githubAccess_public.html @@ -17,7 +17,7 @@

    Description:

    -

    This routine describes how to setup a github account and pull repositories of the CFDEM(R)project. +

    This routine describes how to set up a github account and pull repositories of the CFDEM(R)project. After setting some environment variables LIGGGHTS(R) and CFDEM(R)coupling can be compiled

    Procedure: @@ -81,7 +81,7 @@ git pull 

    gedit ~/.bashrc &
    -

    add the lines (you find them also in .../cfdemParticle/etc/bashrc and cshrc respectively): +

    add the lines (you find them also in .../cfdemParticle/etc/bashrc and cshrc respectively): 

    #================================================#
 #- source cfdem env vars
@@ -107,7 +107,7 @@ export CFDEM_PIZZA_DIR=$HOME/LIGGGHTS/PIZZA/gran_pizza_17Aug10/src
 $CFDEM_SRC_DIR
 $CFDEM_LIGGGHTS_SRC_DIR
    -

    should give "...: is a directory" otherwise something went wrong and the environment variables in ~/bashrc are not set correctly. +

    should give "...: is a directory" otherwise something went wrong and the environment variables in ~/.bashrc are not set correctly.

    To specify the paths of pizza, please check the settings in $CFDEM_SRC_DIR/lagrangian/cfdemParticle/etc/bashrc.

    @@ -139,7 +139,7 @@ Changes in $CFDEM_TUT_DIR will be lost after every git stash!

    Additional Installations:

    -

    Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postporcessing tool "lpp" you need python-numpy package installed: +

    Optionally you can install lpp which will help you convert the DEM (dump) data to VTK format. For standard CFD-DEM runs this will not be necessary. To get the DEM postprocessing tool "lpp" you need python-numpy package installed: 

    sudo apt-get install python-numpy
    @@ -149,9 +149,9 @@ Changes in $CFDEM_TUT_DIR will be lost after every git stash! 
    git clone git://cfdem.git.sourceforge.net/gitroot/cfdem/lpp mylpp
    -

    Backward Compatibility: +

    Backwards Compatibility:

    -

    Basically CFDEM(R)coupling supports one OpenFOAM(R) version therefore all settings are prepared for that. Nevertheless we try to maintain backward compatibility as long as it works with reasonable effort. +

    Basically CFDEM(R)coupling supports one OpenFOAM(R) version therefore all settings are prepared for that. Nevertheless we try to maintain backwards compatibility as long as it works with reasonable effort.

    The supported OpenFOAM(R) and LIGGGHTS(R) versions are stated in: src/lagrangian/cfdemParticle/cfdTools/versionInfo.H @@ -162,7 +162,7 @@ src/lagrangian/cfdemParticle/etc/OFversion/OFversion.H

    Troubleshooting:

    - -

    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 makes sure that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another. +

    This model is a modification of the engine search model. Instead of using the centre-cell as starting point for the engine search, further satellite points located on the surface of the sphere are checked. This ensures that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another.

    -

    Restrictions: +

    Restrictions:

    Only for immersed boundary solvers!

    diff --git a/doc/locateModel_engineSearchIB.txt b/doc/locateModel_engineSearchIB.txt index 9adbdcc2..08b66a1b 100644 --- a/doc/locateModel_engineSearchIB.txt +++ b/doc/locateModel_engineSearchIB.txt @@ -50,9 +50,9 @@ treeSearch false; will execute some geometric (linear) search using the last treeSearch true; will use a recursive tree structure to find the cell. :l :ule -This model is a modification of the engine search model. Instead of using the centre-cell as starting point for the engine search, further satellite points located on the surface of the sphere are checked. This makes sure that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another. +This model is a modification of the engine search model. Instead of using the centre-cell as starting point for the engine search, further satellite points located on the surface of the sphere are checked. This ensures that (parts of) spheres can be located even when their centre is on another processor. This is especially important for parallel computations, when a sphere is about to move from one processor to another. -[Restrictions:] +[Restrictions:] Only for immersed boundary solvers! diff --git a/doc/momCoupleModel_explicitCouple.html b/doc/momCoupleModel_explicitCouple.html index 521d7c96..ac6b5ba5 100644 --- a/doc/momCoupleModel_explicitCouple.html +++ b/doc/momCoupleModel_explicitCouple.html @@ -41,7 +41,7 @@ explicitCoupleProps

    The explicitCouple-model is a momCoupleModel model providing an explicit momentum source term for the CFD solver.

    -

    Restrictions: +

    Restrictions:

    Only for solvers that include explicit momentum exchange.

    diff --git a/doc/momCoupleModel_explicitCouple.txt b/doc/momCoupleModel_explicitCouple.txt index 58cd2824..bdcb4655 100644 --- a/doc/momCoupleModel_explicitCouple.txt +++ b/doc/momCoupleModel_explicitCouple.txt @@ -38,7 +38,7 @@ explicitCoupleProps The explicitCouple-model is a momCoupleModel model providing an explicit momentum source term for the CFD solver. -[Restrictions:] +[Restrictions:] Only for solvers that include explicit momentum exchange. diff --git a/doc/momCoupleModel_implicitCouple.html b/doc/momCoupleModel_implicitCouple.html index ca70b2c9..f2b1a00a 100644 --- a/doc/momCoupleModel_implicitCouple.html +++ b/doc/momCoupleModel_implicitCouple.html @@ -31,7 +31,7 @@ implicitCoupleProps
  • voidfraction = name of the finite volume voidfraction field -number = min value for local particle volume fraction to calculate the exchange filed (default SMALL):l +number = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l

    Examples: @@ -51,7 +51,7 @@ implicitCoupleProps

    The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver.

    -

    Restrictions: +

    Restrictions:

    Only for solvers that include implicit momentum exchange.

    diff --git a/doc/momCoupleModel_implicitCouple.txt b/doc/momCoupleModel_implicitCouple.txt index e46a35c0..08433eec 100644 --- a/doc/momCoupleModel_implicitCouple.txt +++ b/doc/momCoupleModel_implicitCouple.txt @@ -26,7 +26,7 @@ implicitCoupleProps {U} = name of the finite volume fluid velocity field :ulb,l {Us} = name of the finite volume granular velocity field :l {voidfraction} = name of the finite volume voidfraction field :l -{number} = min value for local particle volume fraction to calculate the exchange filed (default SMALL):l +{number} = minimum value for local particle volume fraction to calculate the exchange filed (default SMALL):l :ule [Examples:] @@ -46,7 +46,7 @@ implicitCoupleProps The implicitCouple-model is a momCoupleModel model providing an implicit momentum source term for the CFD solver. -[Restrictions:] +[Restrictions:] Only for solvers that include implicit momentum exchange. diff --git a/doc/momCoupleModel_noCouple.html b/doc/momCoupleModel_noCouple.html index 38dd7c35..0ec1e601 100644 --- a/doc/momCoupleModel_noCouple.html +++ b/doc/momCoupleModel_noCouple.html @@ -27,9 +27,9 @@

    Description:

    -

    The noCouple-model is a dummy momCoupleModel model providing an no momentum source term for the CFD solver. +

    The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver.

    -

    Restrictions: +

    Restrictions:

    Only for solvers that include no momentum exchange, e.g. immersed boundary.

    diff --git a/doc/momCoupleModel_noCouple.txt b/doc/momCoupleModel_noCouple.txt index c6080190..6972d30c 100644 --- a/doc/momCoupleModel_noCouple.txt +++ b/doc/momCoupleModel_noCouple.txt @@ -26,9 +26,9 @@ momCoupleModels [Description:] -The noCouple-model is a dummy momCoupleModel model providing an no momentum source term for the CFD solver. +The noCouple-model is a dummy momCoupleModel model providing a no momentum source term for the CFD solver. -[Restrictions:] +[Restrictions:] Only for solvers that include no momentum exchange, e.g. immersed boundary. diff --git a/doc/probeModel.html b/doc/probeModel.html index 3871fe47..72309a36 100644 --- a/doc/probeModel.html +++ b/doc/probeModel.html @@ -31,7 +31,7 @@

    Description:

    -

    The probeModel feature allows one to implement various probing features in CFDEM. Currently, only the particleProbe model is implemented, that performs probing of particle forces. +

    The probeModel feature allows to implement various probing features in CFDEM. Currently, only the particleProbe model is implemented, that performs probing of particle forces.

    Restrictions:

    diff --git a/doc/probeModel.txt b/doc/probeModel.txt index 5e10acfd..64826ed1 100644 --- a/doc/probeModel.txt +++ b/doc/probeModel.txt @@ -29,7 +29,7 @@ Note: This examples list might not be complete - please check below for the list [Description:] -The probeModel feature allows one to implement various probing features in CFDEM. Currently, only the "particleProbe"_probeModel_particleProbe.html model is implemented, that performs probing of particle forces. +The probeModel feature allows to implement various probing features in CFDEM. Currently, only the "particleProbe"_probeModel_particleProbe.html model is implemented, that performs probing of particle forces. [Restrictions:] diff --git a/doc/smoothingModel_constDiffSmoothing.html b/doc/smoothingModel_constDiffSmoothing.html index faf3f45a..cf5904ab 100644 --- a/doc/smoothingModel_constDiffSmoothing.html +++ b/doc/smoothingModel_constDiffSmoothing.html @@ -39,15 +39,15 @@ constDiffSmoothingProps lowerLimit 0.1; upperLimit 1e10; smoothingLength 1500e-6; - smoothingLengthReferenceField 9000e-6; + smoothingLengthReferenceField 9000e-6; }

    Description:

    -

    The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothening the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit fource coupling algorithms. +

    The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothing the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit force coupling algorithms. Smoothing for reference fields is performed to "fill in" values in cells in which these reference fields are not specified. Values calculated in the cells (via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, e.g., the average particle velocity, which are not specified in all cells in case the flow is rather dilute.

    -

    Restrictions: This model is tested in a limited number of flow situations. +

    Restrictions: This model is tested in a limited number of flow situations.

    ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error.

    diff --git a/doc/smoothingModel_constDiffSmoothing.txt b/doc/smoothingModel_constDiffSmoothing.txt index b6dc6db9..54f75cfd 100644 --- a/doc/smoothingModel_constDiffSmoothing.txt +++ b/doc/smoothingModel_constDiffSmoothing.txt @@ -33,15 +33,15 @@ constDiffSmoothingProps lowerLimit 0.1; upperLimit 1e10; smoothingLength 1500e-6; - smoothingLengthReferenceField 9000e-6; + smoothingLengthReferenceField 9000e-6; \} :pre [Description:] -The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothening the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit fource coupling algorithms. +The "constDiffSmoothing" model is a basic smoothingModel model which reads a smoothing length scale being used for smoothing the exchange fields (voidfraction, Ksl, f if present). This model can be used for smoothing explicit force coupling fields, as well as implicit force coupling algorithms. Smoothing for reference fields is performed to "fill in" values in cells in which these reference fields are not specified. Values calculated in the cells (via Lagrangian-To-Euler mapping) are NOT changed! These reference fields are, e.g., the average particle velocity, which are not specified in all cells in case the flow is rather dilute. -[Restrictions:] This model is tested in a limited number of flow situations. +[Restrictions:] This model is tested in a limited number of flow situations. ATTENTION: In case a smoothing model is used in conjunction with "PimpleImEx" solvers, the fields "f" and "fSmooth" must be placed in the initial time directory! This is because zeroGradient boundary conditions for the fields "f" and "fSmooth" must be specified, otherwise the smoothing operation will give an Error. diff --git a/doc/voidFractionModel_GaussVoidFraction.html b/doc/voidFractionModel_GaussVoidFraction.html index c976b46d..2ad4fd92 100644 --- a/doc/voidFractionModel_GaussVoidFraction.html +++ b/doc/voidFractionModel_GaussVoidFraction.html @@ -18,17 +18,17 @@ GaussProps { maxCellsPerParticle number1; alphaMin number2; - scaleUpVol number3; - weight number4; + weight number3; + porosity number4; } -