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] minor updates

Browse Source
This commit is contained in:
danielque
2024-01-19 15:56:33 +01:00
parent 714ba31e7a
commit 4cc54f283e
6 changed files with 33 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/CFDEMcoupling_about.txt
View File

@ -44,7 +44,7 @@ the use of Git allows to easily update to the latest version :l
basic documentation is provided :l
:ule
The file structure:
The project structure:
{src} directory including the source files of the coupling toolbox and models :ulb,l
{applications} directory including the solver files for coupled CFD-DEM simulations :l
@ -52,7 +52,8 @@ The file structure:
{tutorials} directory including basic tutorial cases showing the functionality :l
:ule
Details on installation are given on the "CFDEMproject Website"_lig .
Details on installation are given in the "Installation"_CFDEMcoupling_install.html
section.
The functionality of this CFD-DEM framework is described via "tutorial
cases"_CFDEMcoupling_tutorials.html showing how to use different solvers and
models.

5
doc/CFDEMcoupling_install.txt
View File

@ -45,6 +45,11 @@ following commands:
apt-get install build-essential flex bison git-core cmake zlib1g-dev libboost-system-dev libboost-thread-dev libopenmpi-dev openmpi-bin gnuplot libreadline-dev libncurses-dev libxt-dev
apt-get install libqt5x11extras5-dev libxt-dev qt5-default qttools5-dev curl :pre
NOTE: Ubuntu 21.04 and newer dropped the {qt5-default} package. Instead use:
apt-get install build-essential flex bison git-core cmake zlib1g-dev libboost-system-dev libboost-thread-dev libopenmpi-dev openmpi-bin gnuplot libreadline-dev libncurses-dev libxt-dev
apt-get install libqt5x11extras5-dev libxt-dev qttools5-dev qttools5-dev-tools qtwebengine5-dev libqt5svg5-dev libqt5websockets5-dev libqt5xmlpatterns5 qtxmlpatterns5-dev-tools curl :pre
2.1.2 Setup the environment :h5
Open your bash startup file

1
doc/CFDEMcoupling_solvers.txt
View File

@ -13,6 +13,7 @@ This section lists all CFDEMcoupling solvers alphabetically.
"cfdemSolverIBContinuousForcing"_cfdemSolverIBContinuousForcing.html,
"cfdemSolverMultiphase"_cfdemSolverMultiphase.html,
"cfdemSolverMultiphaseScalar"_cfdemSolverMultiphaseScalar.html,
"cfdemSolverPimple"_cfdemSolverPimple.html,
"cfdemSolverPiso"_cfdemSolverPiso.html,
"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html,
"cfdemSolverRhoPimple"_cfdemSolverRhoPimple.html,

2
doc/CFDEMcoupling_tutorials.txt
View File

@ -62,7 +62,7 @@ OpenFOAM\ |reg|\ (*) documentations.
END_RST -->.
Settings of the coupling routines are defined in
$caseDir/CFD/constant/"couplingProperies"_CFDEMcoupling_dicts.html#couplingProperties
$caseDir/CFD/constant/"couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
(e.g. force models, data exchange model, etc.) and
$caseDir/CFD/constant/"liggghtsCommands"_CFDEMcoupling_dicts.html#liggghtsCommands
(allows to execute a LIGGGHTS command during a coupled simulation).

11
doc/forceModel_staticPressure.txt
View File

@ -49,9 +49,14 @@ staticPressureProps
[Description:]
As discussed in "gravityEff"_otherForceModel_gravityEff.html, in case of simulating periodic boxes, it is necessary to have a gravitaional source term.
Since that force is added to the gas momentum equation, we need to add the same force excluding the effect of the gravitational force on the
particles (the gravitational force on the particles is already available on the LIGGGHTS side) to drive the particles. This force model performs the calculation of the following force acting on each DEM particle,
As discussed in "gravityEff"_otherForceModel_gravityEff.html, in case of
simulating periodic boxes, it is necessary to have a gravitational source term.
Since that force is added to the gas momentum equation, we need to add the same
force excluding the effect of the gravitational force on the particles
(the gravitational force on the particles is already available on the LIGGGHTS side)
to drive the particles.
This force model performs the calculation of the following force acting on each
DEM particle,
:c,image(Eqs/forceModels_staticPressure_pic1.jpg)

26
doc/otherForceModel_gravityEff.txt
View File

@ -41,30 +41,34 @@ gravityEffProps
[Description:]
An effective gravitational source term, {gravityEff}, that is necessery to drive the flow only in
case of periodic box simulations. This source term is added to the momentum equation. In case of
simulating periodic boxes with assuming "Homogenous no flow condition" we will have:
An effective gravitational source term, {gravityEff}, that is necessery to drive
the flow only incase of periodic box simulations.
This source term is added to the momentum equation.
In case of simulating periodic boxes and assuming "homogeneous no-flow condition"
we will have:
:c,image(Eqs/otherForceModels_gravityEff_pic1.jpg)
This equation depicts that in "no flow condition" static pressure gradient balances the mixture weight.
Therefore, to derive the flow in the periodic box simulations, a dynamic pressure gradient is defined as,
This equation depicts that in "no-flow condition" static pressure gradient balances the mixture weight.
Therefore, to derive the flow in periodic box simulations, a dynamic pressure gradient is defined as
:c,image(Eqs/otherForceModels_gravityEff_pic2.jpg)
If one replaces the static pressure gradient of the fluid momentum equation with,
If one replaces the static pressure gradient of the fluid momentum equation with
:c,image(Eqs/otherForceModels_gravityEff_pic3.jpg)
The fluid momentum equation solved in case of periodic box simulations will be,
the fluid momentum equation solved in case of periodic box simulations will be
:c,image(Eqs/otherForceModels_gravityEff_pic4.jpg)
The {gravityEff} source term is the third term in the RHS of the momentum equation. Note that
the gravitational body force of the fluid momentum equation is considered with this source term.
The {gravityEff} source term is the third term on the RHS of the momentum equation.
Note that the gravitational body force of the fluid momentum equation is considered
with this source term.
In the basic implementation of {gravityEff}, first we calculate the density of the mixture and then
the source term is calculated based on the third term in the RHS of the momentum equation.
In the basic implementation of {gravityEff}, first we calculate the density of
the mixture and then the source term is calculated based on the third term on the
RHS of the momentum equation.
[Restrictions:]