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

added docs

Browse Source
This commit is contained in:
s126103
2021-09-02 14:27:47 +02:00
parent fbe65effd0
commit 6a175f3450
8 changed files with 382 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/CFDEMcoupling_models.txt
View File

@ -71,7 +71,8 @@ compressible, reacting flows.
heatTransferGunn,
heatTransferGunnPartField,
reactionHeat :tb(c=2,ea=c)
reactionHeat,
"wallHeatTransferYagi"_energyModel_wallHeatTransferYagi.html :tb(c=2,ea=c)
6.7 Force models :h4
@ -103,6 +104,7 @@ granKineticEnergy,
"pdCorrelation"_forceModel_pdCorrelation.html,
"surfaceTensionForce"_forceModel_surfaceTensionForce.html,
"virtualMassForce"_forceModel_virtualMassForce.html,
"ParmarBassetForce"_forceModel_ParmarBassetForce.html,
"viscForce"_forceModel_viscForce.html,
"volWeightedAverage"_forceModel_volWeightedAverage.html :tb(c=2,ea=c)
@ -192,7 +194,8 @@ smoothing the exchange fields.
"constDiffSmoothing"_smoothingModel_constDiffSmoothing.html,
"off"_smoothingModel_noSmoothing.html,
"temporalSmoothing"_smoothingModel_temporalSmoothing.html :tb(c=2,ea=c)
"temporalSmoothing"_smoothingModel_temporalSmoothing.html,
"constDiffAndTemporalSmoothing"_smoothingModel_constDiffAndTemporalSmoothing.html :tb(c=2,ea=c)
6.16 Thermal conductivity models :h4
@ -216,3 +219,18 @@ accounting for the volume of the particles in the CFD domain.
"centre"_voidFractionModel_centreVoidFraction.html,
"divided"_voidFractionModel_dividedVoidFraction.html :tb(c=2,ea=c)
6.18 Mass transfer models :h4
The {massTransferModels} keyword specifies a list of mass transfer models used evaluating
species transfer between particles and fluids.
massTransferGunn :tb(c=2,ea=c)
6.19 Diffusion coefficient models :h4
The {diffCoeffModel} keyword entry specifies the model for the diffusion
coefficient of dissolved spieces in the fluid phase in the presence of particles.
SyamlalDiffCoeff,
off :tb(c=2,ea=c)

1
doc/CFDEMcoupling_solvers.txt
View File

@ -11,6 +11,7 @@ This section lists all CFDEMcoupling solvers alphabetically.
"cfdemSolverIB"_cfdemSolverIB.html,
"cfdemSolverMultiphase"_cfdemSolverMultiphase.html,
"cfdemSolverMultiphaseScalar"_cfdemSolverMultiphaseScalar.html,
"cfdemSolverPiso"_cfdemSolverPiso.html,
"cfdemSolverPisoScalar"_cfdemSolverPisoScalar.html,
"cfdemSolverRhoPimple"_cfdemSolverRhoPimple.html,

68
doc/cfdemSolverMultiphaseScalar.txt Normal file
View File

@ -0,0 +1,68 @@
<!-- 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(main,CFDEMcoupling_Manual.html)
:line
cfdemSolverMultiphaseScalar command :h3
[Description:]
<!-- HTML_ONLY -->
"cfdemSolverMultiphaseScalar" 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. Additionally, it enable evaluation of temperature and dissolved species concentration fields.
<!-- END_HTML_ONLY -->
<!-- RST
"cfdemSolverMultiphaseScalar" 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. Additionally, it enable evaluation of temperature and dissolved species concentration fields.
.. |reg| unicode:: U+000AE .. REGISTERED SIGN
END_RST -->
For more details, see "Vångö et al. (2018)"_#Vångö2018 and "Nijssen et al. (2021)"_#Nijssen2021.
:line
: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
:link(Nijssen2021)
[(Nijssen2021)] T.M.J. Nijssen, J.A.M. Kuipers, J. van der Stel, A.T. Adema, K.A. Buist. (2021):
"article title here",
journal name here
: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 -->

83
doc/energyModel_wallHeatTransferYagi.txt Normal file
View File

@ -0,0 +1,83 @@
"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(main,CFDEMcoupling_Manual.html)
:line
energyModel wallHeatTransferYagi command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
energyModels
(
wallHeatTransferYagi
);
wallHeatTransferYagiProps
\{
QWallFluidName "QWallFluid";
QWallFluidCoeffNAme "QWallFluidCoeff";
wallTempName "wallTemp";
tempFieldName "T";
voidfractionFieldName "voidfraction";
voidfractionMax scalar1;
maxSource scalar2;
velFieldName "U";
densityFieldName "rho";
implicit switch1;
verbose switch2;
\} :pre
{QWallFluid} = name of the wall-fluid heat transfer rate field :ulb,l
{QwallFluidCoeff} = name of the wall-fluid heat transfer coefficient field :l
{wallTemp} = name of the wall temperature field :l
{T} = name of the fluid temperature field :l
{voidfraction} = name of the finite volume void fraction field :l
{scalar1} = maximum void fraction for a cell to be considered packed :l
{scalar2} = (optional, default 1e30) maximum allowed source term :l
{U} = name of the finite volume fluid velocity field :l
{rho} = name of the fluid density field :l
{switch1} = (optional, default true) activate to treat the fluid temperature implicitly :l
{switch2} = (optional, default false) activate to write additional fields, and write cell-based data to the terminal :l
:ule
[Examples:]
energyModels
(
wallHeatTransferYagi
);
wallHeatTransferYagiProps
\{
QWallFluidName "QWallFluid";
QWallFluidCoeffNAme "QWallFluidCoeff";
wallTempName "wallTemp";
tempFieldName "T";
voidfractionFieldName "voidfraction";
voidfractionMax 0.5;
velFieldName "U";
densityFieldName "rho";
implicit true;
\} :pre
[Description:]
The energy model performs calculation of wall-to-bed heat transfer for a
packed bed, based on the correlation of "Yagi and Wakao (1959)"_#Yagi1959.
:link(Yagi1959)
[(Yagi1959)] S. Yagi, N. Wakao. (1959):
"Heat and Mass Transfer from Wall to Fluid in Packed Beds",
AIChE Journal
[Restrictions:]
IMPORTANT NOTE: Model not validated!
[Related commands:]
energyModel

32
doc/forceModel_MeiLift.txt
View File

@ -19,19 +19,23 @@ forceModels
MeiLiftProps
\{
velFieldName "U";
useSecondOrderTerms;
treatForceExplicit switch1;
verbose switch2;
interpolation switch3;
scalarViscosity switch4;
useShearInduced switch1;
useSpinInduced switch2;
combineShearSpin switch3;
treatForceExplicit switch4;
verbose switch5;
interpolation switch6;
scalarViscosity switch7;
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{useSecondOrderTerms} = (optional, default false) switch to activate second order terms in the lift force model :l
{switch1} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch2} = (optional, default false) switch to activate the report of per-particle quantities to the screen :l
{switch3} = (optional, default false) switch to activate tri-linear interpolation of the flow quantities at the particle position :l
{useShearInduced} = (optional, default true) switch to activate shear-induced (Saffman) lift :l
{useSpinInduced} = (optional, default false) switch to activate spin-induced (Magnus) lift :l
{combineShearSpin} = (optional, default false) switch to use the correlation for combined shear- and spin-induced lift by "Loth and Dorgan (2009)"_#LothDorgan2009 :l
{switch4} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch5} = (optional, default false) switch to activate the report of per-particle quantities to the screen :l
{switch6} = (optional, default false) switch to activate tri-linear interpolation of the flow quantities at the particle position :l
{switch7} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
:ule
[Examples:]
@ -43,7 +47,6 @@ forceModels
MeiLiftProps
\{
velFieldName "U";
useSecondOrderTerms;
interpolation true;
verbose true;
\} :pre
@ -52,9 +55,12 @@ MeiLiftProps
The force model performs the calculation of forces (e.g. fluid-particle
interaction forces) acting on each DEM particle. The {MeiLift} model calculates
the lift force for each particle based on Loth and Dorgan (2009). In case the
keyword "useSecondOrderTerms" is not specified, this lift force model uses the
expression of McLaughlin (1991, J. Fluid Mech. 224:261-274).
the lift force for each particle based on "Loth and Dorgan (2009)"_#LothDorgan2009.
:link(LothDorgan2009)
[(LothDorgan2009)] E. Loth, A.J. Dorgan. (2009):
"An equation of motion for particles of finite Reynolds number and size",
Environmental Fluid Mechanics
[Restrictions:]

88
doc/forceModel_ParmarBassetForce.txt Normal file
View File

@ -0,0 +1,88 @@
"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(main,CFDEMcoupling_Manual.html)
:line
forceModel ParmarBassetForce command :h3
[Syntax:]
Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
dictionary.
forceModels
(
ParmarBassetForce
);
ParmarBassetForceProps
\{
velFieldName "U";
UsFieldName "Us";
nIntegral scalar1;
discretisationOrder scalar2;
treatForceExplicit switch1;
interpolation switch2;
smoothingModel "smoothingModel";
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{Us} = name of the finite volume cell averaged particle velocity field :l
{scalar1} = number of timesteps considered in the near history :l
{scalar2} = (1 or 2) discretisation order of the far history differential equations :l
{switch1} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch2} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{smoothingModel} = name of smoothing model for the dU/dt field :l
:ule
[Examples:]
forceModels
(
ParmarBassetForce
);
ParmarBassetForceProps
\{
velFieldName "U";
USFieldName "Us"
nIntegral 10;
discretisationOrder 1;
smoothingModel constDiffAndTemporalSmoothing;
constDiffAndTemporalSmoothingProps
\{
lowerLimit 1e-8;
upperLimit 1e8;
smoothingLength 0.1;
smoothingStrength 0.001;
correctBoundary true;
\}
\} :pre
[Description:]
The force model performs the calculation of forces (e.g. fluid-particle
interaction forces) acting on each DEM particle. The {ParmarBassetForce} model
calculates the Basset history force for each particle, based on the method by
"Parmar et al. (2018)"_#Parmar2018.
For more detail, see "Nijssen et al. (2020)"_#Nijssen2020.
:link(Parmar2018)
[(Parmar2018)] M. Parmar, S. Annamalai, S. Balachandar, A. Prosperetti. (2018):
"Differential Formulation of the Viscous History Force on a Particle for Efficient and Accurate Computation",
Journal of Fluid Mechanics
:link(Nijssen2020)
[(Nijssen2020)] T.M.J. Nijssen, J.A.M. Kuipers, J. van der Stel, A.T. Adema, K.A. Buist. (2020):
"Complete liquid-solid momentum coupling for unresolved CFD-DEM simulations",
International Journal of Multiphase Flow
[Restrictions:]
IMPORTANT NOTE: Model not validated!
[Related commands:]
"forceModel"_forceModel.html

30
doc/forceModel_virtualMassForce.txt
View File

@ -19,19 +19,29 @@ forceModels
virtualMassForceProps
\{
velFieldName "U";
voidfractionFieldName "voidfraction";
UsFieldName "Us";
phiFieldName "phi";
splitUrelCalculation switch1;
useUs switch2;
useFelderhof switch3;
Cadd scalar1;
treatForceExplicit switch2;
interpolation switch3;
treatForceExplicit switch4;
interpolation switch5;
smoothingModel "smoothingModel";
\} :pre
{U} = name of the finite volume fluid velocity field :ulb,l
{voidfraction} = name of the finite volume void fraction field :l
{Us} = name of the finite volume cell averaged particle velocity field :l
{phi} = name of the finite volume flux field :l
{switch1} = (optional, default false) indicator to split calculation of Urel between CFDEM and LIGGGHTS :l
{switch2} = (optional, default false) indicator to use the cell-averaged particle velocity Us for calculation of Urel :l
{switch3} = (optional, default false) indicator to use the correlation by Felderhof for the virtual mass coefficient :l
{scalar1} = (optional, default 0.5) virtual mass coefficient :l
{switch2} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch3} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch4} = (optional, default true) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{switch5} = (optional, default false) sub model switch, see "forceSubModel"_forceSubModel.html for details :l
{smoothingModel} = name of smoothing model for the DU/Dt field :l
:ule
[Examples:]
@ -43,7 +53,10 @@ forceModels
virtualMassForceProps
\{
velFieldName "U";
voidfractionFieldName "voidfraction"
USFieldName "Us"
phiFieldName "phi";
smoothingModel off;
\} :pre
[Description:]
@ -52,6 +65,15 @@ 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.
For more detail, see "Nijssen et al. (2020)"_#Nijssen2020.
:link(Nijssen2020)
[(Nijssen2020)] T.M.J. Nijssen, J.A.M. Kuipers, J. van der Stel, A.T. Adema, K.A. Buist. (2020):
"Complete liquid-solid momentum coupling for unresolved CFD-DEM simulations",
International Journal of Multiphase Flow
[Restrictions:]
IMPORTANT NOTE: Model not validated!
[Related commands:]

77
doc/smoothingModel_constDiffAndTemporalSmoothing.txt Normal file
View File

@ -0,0 +1,77 @@
"CFDEMproject Website"_lws - "Main Page"_main :c
:link(lws,http://www.cfdem.com)
:link(main,CFDEMcoupling_Manual.html)
:line
smoothingModel constDiffAndTemporalSmoothing command :h3
[Syntax:]
Defined in dictionary depending on the application.
smoothingModel constDiffAndTemporalSmoothing;
constDiffAndTemporalSmoothingProps
\{
lowerLimit number1;
upperLimit number2;
smoothingLength lengthScale;
smoothingLengthReferenceField lengthScaleRefField;
smoothingStrength smoothingStrength;
correctBoundary switch1;
verbose;
\} :pre
{number1} = scalar fields will be bound to this lower value :ulb,l
{number2} = scalar fields will be bound to this upper value :l
{lengthScale} = length scale over which the exchange fields will be smoothed out :l
{lengthScaleRefField} = length scale over which reference fields (e.g., the average particle velocity) will be smoothed out. Should be always larger than lengthScale. If not specified, will be equal to lengthScale. :l
{smoothingStrength} = control parameter gamma for the smoothing, lower value yields stronger smoothing (gamma = 1 results in an equal contribution from the un-smoothed and smoothed fields) :l
{correctBoundary} = (optional, default false) activate to use purely temporal smoothing on the boundary field, avoids interpolation errors near the domain boundary :l
{verbose} = (optional, default false) flag for debugging output :l
:ule
[Examples:]
constDiffAndTemporalSmoothingProps
\{
lowerLimit 0.1;
upperLimit 1e10;
smoothingLength 1500e-6;
smoothingLengthReferenceField 9000e-6;
referenceField "p";
gamma 1.0;
\} :pre
[Description:]
The {constDiffAndTemporalSmoothing} model is a smoothing model that combines the
spacial smoothing of "constDiffSmoothing"_smoothingModel_constDiffSmoothing.html and
the temporal smoothing of "temporalSmoothing"_smoothingModel_temporalSmoothing.html for
the relaxation of a desired quantity. This model can be used to filter out
high-frequency fluctuations (e.g. numerical noise) controlled via the smoothing length
and the temporal smoothing strength parameter gamma.
For more details, see "Vångö et al. (2018)"_#Vångö2018 and "Nijssen et al. (2020)"_#Nijssen2020.
: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
:link(Nijssen2020)
[(Nijssen2020)] T.M.J. Nijssen, J.A.M. Kuipers, J. van der Stel, A.T. Adema, K.A. Buist. (2020):
"Complete liquid-solid momentum coupling for unresolved CFD-DEM simulations",
International Journal of Multiphase Flow
[Restrictions:]
This model is tested in a limited number of flow situations.
[Related commands:]
"smoothingModel"_smoothingModel.html
"constDiffSmoothing"_smoothingModel_constDiffSmoothing.html
"temporalSmoothing"_smoothingModel_temporalSmoothing.html