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

Updated documentation

Browse Source
This commit is contained in:
mathiasvangoe
2018-10-12 10:32:06 +02:00
parent 4acd0de949
commit 3858931124
3 changed files with 84 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
doc/cfdemSolverMultiphase.txt
View File

@ -1,7 +1,12 @@
"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
<!-- HTML_ONLY -->
<HEAD>
<META CHARSET="utf-8">
</HEAD>
<!-- END_HTML_ONLY -->
"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(lc,CFDEMcoupling_Manual.html#comm)
:link(main,CFDEMcoupling_Manual.html)
:line
@ -9,11 +14,49 @@ cfdemSolverMultiphase command :h3
[Description:]
cfdemSolverMultiphase is a coupled CFD-DEM solver using the CFDEMcoupling framework. Based on the OpenFOAM solver multiphaseInterFoam(R)(*) it has functionality to simulate several (>2) fluids using the Volume of Fluid approach, coupled with the DEM code LIGGGHTS for solid particles. For more information see:
<!-- HTML_ONLY -->
"cfdemSolverMultiphase" is a coupled CFD-DEM solver using the CFDEMcoupling framework. Based on the OpenFOAM solver multiphaseInterFoam&reg;(*) it has functionality to simulate several fluids using the Volume of Fluid approach, coupled with the DEM code LIGGGHTS for solid particles.
M. Vångö, S. Pirker, T. Lichtenegger, "Unresolved CFD–DEM modeling of multiphase flow in densely packed particle beds", Appl. Math. Model. (2018).
<!-- END_HTML_ONLY -->
<!-- RST
"cfdemSolverMultiphase" is a coupled CFD-DEM solver using the CFDEMcoupling framework. Based on the OpenFOAM solver multiphaseInterFoam\ |reg|\ (*) it has functionality to simulate several fluids using the Volume of Fluid approach, coupled with the DEM code LIGGGHTS for solid particles.
.. |reg| unicode:: U+000AE .. REGISTERED SIGN
END_RST -->
For more details, see "Vångö et al. (2018)"_#Vångö2018.
:line
(*) This offering is not approved or endorsed by OpenCFD Limited, the producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks. OPENFOAM® is a registered trade mark of OpenCFD Limited, a wholly owned subsidiary of the ESI Group.
:link(Vångö2018)
[(Vångö2018)] M. Vångö, S. Pirker, T. Lichtenegger. (2018):
"Unresolved CFD–DEM modeling of multiphase flow in densely packed particle beds",
Applied Mathematical Modelling
:line
<!-- HTML_ONLY -->
NOTE:
(*) This offering is not approved or endorsed by OpenCFD Limited, producer and
distributor of the OpenFOAM software via www.openfoam.com, and owner of the
OPENFOAM&reg; and OpenCFD&reg; trade marks.
OPENFOAM&reg; is a registered trade mark of OpenCFD Limited, producer and
distributor of the OpenFOAM software via www.openfoam.com.
<!-- END_HTML_ONLY -->
<!-- RST
.. note::
(*) This offering is not approved or endorsed by OpenCFD Limited, producer
and distributor of the OpenFOAM software via www.openfoam.com, and owner of
the OPENFOAM\ |reg| and OpenCFD\ |reg| trade marks.
OPENFOAM\ |reg| is a registered trade mark of OpenCFD Limited, producer and
distributor of the OpenFOAM software via www.openfoam.com.
.. |reg| unicode:: U+000AE .. REGISTERED SIGN
END_RST -->

42
doc/forceModel_gradPForceSmooth.txt
View File

@ -1,15 +1,16 @@
"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(lc,CFDEMcoupling_Manual.html#comm)
:link(main,CFDEMcoupling_Manual.html)
:line
forceModel_gradPForceSmooth command :h3
forceModel gradPForceSmooth command :h3
[Syntax:]
Defined in couplingProperties dictionary.
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
forceModels
(
@ -17,15 +18,21 @@ forceModels
);
gradPForceSmoothProps
\{
pFieldName "pressure";
velocityFieldName "U";
interpolation switch1;
smoothingModel "smoothingModel";
\}; :pre
pFieldName "pressure";
velocityFieldName "U";
useAddedMass scalar1;
treatForceExplicit switch1;
treatForceDEM switch2;
interpolation switch3;
smoothingModel "smoothingModel";
\} :pre
{pressure} = name of the finite volume fluid pressure field :ulb,l
{U} = name of the finite volume fluid velocity field :l
{switch1} = flag to use interpolated pressure values (normally off) :l
{scalar1} = (optional, default 0) coefficient of added mass accounted for :l
{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch3} = (optional, default false) flag to use interpolated pressure values :l
{smoothingModel} = name of smoothing model :l
:ule
@ -37,27 +44,26 @@ forceModels
);
gradPForceSmoothProps
\{
pFieldName "p_rgh";
pFieldName "p_rgh";
velocityFieldName "U";
interpolation false;
smoothingModel "temporalSmoothing";
interpolation false;
smoothingModel "temporalSmoothing";
temporalSmoothingProps
\{
lowerLimit 0.1;
upperLimit 1e10;
refField "p_rgh";
smoothingStrength 1;
refField "p_rgh";
gamma 1.0;
\} :pre
\} :pre
[Description:]
The gradPForceSmooth model calculates the particle based pressure gradient force identically as the gradPForce model but allows smoothing of the pressure prior to the force calculation (without altering the original pressure). Any smoothing model can be used and does not have to be the same as specified in couplingProperties. Properties for the smoothing model has to be specified in a sub-dictionary within gradPForceSmoothProps.
The gradPForceSmooth model calculates the particle based pressure gradient force identically as the gradPForce model but allows smoothing of the pressure prior to the force calculation (without altering the original pressure field). Any smoothing model can be used and does not have to be the same as specified in couplingProperties. Properties for the smoothing model has to be specified in a sub-dictionary within gradPForceSmoothProps.
[Restrictions:]
A volScalarField "pSmooth" MUST be specified in the initial time directory with appropriate boundary conditions!
A volScalarField "pSmooth" MUST be specified in the initial time directory!
[Related commands:]

22
doc/smoothingModel_temporalSmoothing.txt
View File

@ -1,23 +1,23 @@
"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c
"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(lc,CFDEMcoupling_Manual.html#comm)
:link(main,CFDEMcoupling_Manual.html)
:line
smoothingModel_temporalSmoothing command :h3
smoothingModel temporalSmoothing command :h3
[Syntax:]
Defined in dictionary dependent on the application.
Defined in dictionary depending on the application.
smoothingModel temporalSmoothing;
temporalSmoothingProps
\{
lowerLimit number1;
upperLimit number2;
refField referenceField;
gamma smoothingStrength;
refField referenceField;
gamma smoothingStrength;
\} :pre
{number1} = scalar fields will be bound to this lower value :ulb,l
@ -30,17 +30,19 @@ temporalSmoothingProps
temporalSmoothingProps
\{
lowerLimit 0.1;
upperLimit 1e10;
lowerLimit 0.1;
upperLimit 1e10;
referenceField "p";
gamma 1;
gamma 1.0;
\} :pre
[Description:]
The "temporalSmoothing" model is a smoothing model that utilizes temporal relaxation of a desired quantity. This model can be used to filter out high-frequency fluctuations (e.g. numerical noise) controlled via the control parameter gamma. Note that this model does NOT smooth the calculated fields, instead smoothing is performed on a separate (smooth) field which uses the calculated (un-smooth) field as a reference. Thus its usage is limited and CANNOT be used to smooth the exchange fields similar to the other smoothing models. For further information see Vångö et al., "Unresolved CFD–DEM modeling of multiphase flow in densely packed particle beds", Appl. Math. Model. (2018).
[Restrictions:] This model does NOT smooth the calculated fields and can therefore NOT be used as a general smoothing model to smoothen the exhchange fields. Attempting this will generate an error.
[Restrictions:]
This model does NOT smooth the calculated fields and can therefore NOT be used as a general smoothing model to smoothen the exhchange fields. Attempting this will generate an error.
[Related commands:]