diff --git a/doc/CFDEMcoupling_Manual.html b/doc/CFDEMcoupling_Manual.html index 6d2fc602..eb31ac01 100644 --- a/doc/CFDEMcoupling_Manual.html +++ b/doc/CFDEMcoupling_Manual.html @@ -219,25 +219,26 @@ listing below of styles within certain commands. forceModel_KochHillDragforceModel_LaEuScalarTemp forceModel_MeiLiftforceModel_SchillerNaumannDrag forceModel_ShirgaonkarIBforceModel_fieldStore -forceModel_gradPForceforceModel_noDrag -forceModel_particleCellVolumeforceModel_virtualMassForce -forceModel_viscForceforceSubModel -forceSubModel_ImExforceSubModel_ImExCorr -liggghtsCommandModelliggghtsCommandModel_execute -liggghtsCommandModel_readLiggghtsDataliggghtsCommandModel_runLiggghts -liggghtsCommandModel_writeLiggghtslocateModel -locateModel_engineSearchlocateModel_engineSearchIB -locateModel_engineSearchMany2ManylocateModel_standardSearch -locateModel_turboEngineSearchmeshMotionModel -meshMotionModel_noMeshMotionmomCoupleModel -momCoupleModel_explicitCouplemomCoupleModel_implicitCouple -momCoupleModel_noCoupleprobeModel -probeModel_noProberegionModel -regionModel_allRegionsmoothingModel -smoothingModel_constDiffSmoothingsmoothingModel_noSmoothing -voidfractionModelvoidfractionModel_GaussVoidFraction -voidfractionModel_IBVoidFractionvoidfractionModel_bigParticleVoidFraction -voidfractionModel_centreVoidFractionvoidfractionModel_dividedVoidFraction +forceModel_pdCorrelationforceModel_gradPForce +forceModel_noDragforceModel_particleCellVolume +forceModel_virtualMassForceforceModel_viscForce +forceSubModelforceSubModel_ImEx +forceSubModel_ImExCorrliggghtsCommandModel +liggghtsCommandModel_executeliggghtsCommandModel_readLiggghtsData +liggghtsCommandModel_runLiggghtsliggghtsCommandModel_writeLiggghts +locateModellocateModel_engineSearch +locateModel_engineSearchIBlocateModel_engineSearchMany2Many +locateModel_standardSearchlocateModel_turboEngineSearch +meshMotionModelmeshMotionModel_noMeshMotion +momCoupleModelmomCoupleModel_explicitCouple +momCoupleModel_implicitCouplemomCoupleModel_noCouple +probeModelprobeModel_noProbe +regionModelregionModel_allRegion +smoothingModelsmoothingModel_constDiffSmoothing +smoothingModel_noSmoothingvoidfractionModel +voidfractionModel_GaussVoidFractionvoidfractionModel_IBVoidFraction +voidfractionModel_bigParticleVoidFractionvoidfractionModel_centreVoidFraction +voidfractionModel_dividedVoidFraction diff --git a/doc/CFDEMcoupling_Manual.txt b/doc/CFDEMcoupling_Manual.txt index fdc93a03..5a004c21 100644 --- a/doc/CFDEMcoupling_Manual.txt +++ b/doc/CFDEMcoupling_Manual.txt @@ -268,6 +268,7 @@ listing below of styles within certain commands. "forceModel_SchillerNaumannDrag"_forceModel_SchillerNaumannDrag.html, "forceModel_ShirgaonkarIB"_forceModel_ShirgaonkarIB.html, "forceModel_fieldStore"_forceModel_fieldStore.html, +"forceModel_pdCorrelation"_forceModel_pdCorrelation.html, "forceModel_gradPForce"_forceModel_gradPForce.html, "forceModel_noDrag"_forceModel_noDrag.html, "forceModel_particleCellVolume"_forceModel_particleCellVolume.html, diff --git a/doc/Eqs/pdCorrelation.png b/doc/Eqs/pdCorrelation.png new file mode 100644 index 00000000..161dc5e8 Binary files /dev/null and b/doc/Eqs/pdCorrelation.png differ diff --git a/doc/forceModel_pdCorrelation.html b/doc/forceModel_pdCorrelation.html new file mode 100644 index 00000000..c838e5e2 --- /dev/null +++ b/doc/forceModel_pdCorrelation.html @@ -0,0 +1,58 @@ + +
CFDEMproject WWW Site - CFDEM Commands +
+ + + + +
+ +

forceModel_pdCorrelation +

+

Syntax: +

+

Defined in couplingProperties dictionary. +

+
forceModels
+(
+    pdCorrelation
+);
+pdCorrelationProps
+{
+    coarseGrainingFactors
+    (
+        X Y Z
+    );
+    particleDensities
+    (
+        A B C
+    );
+    runOnWriteOnly true;
+}; 
+
+ +

Description: +

+

This "forceModel" does not influence the particles or the flow - it calculates the particle momentum-diameter correlation +

+
+
+

where delta is the type-specific coarsegraining factor. +

+

This model is sensitive to additionally pulled particle type info, and can either use the type-specific densities from the dict or those pulled from LIGGGHTS. +

+

Restrictions: +

+

none. +

+

Related commands: +

+

forceModel

+ diff --git a/doc/forceModel_pdCorrelation.txt b/doc/forceModel_pdCorrelation.txt new file mode 100644 index 00000000..34049c96 --- /dev/null +++ b/doc/forceModel_pdCorrelation.txt @@ -0,0 +1,53 @@ +"CFDEMproject WWW Site"_lws - "CFDEM Commands"_lc :c + +:link(lws,http://www.cfdem.com) +:link(lc,CFDEMcoupling_Manual.html#comm) + +:line + +forceModel_pdCorrelation :h3 + +[Syntax:] + +Defined in couplingProperties dictionary. + +forceModels +( + pdCorrelation +); +pdCorrelationProps +\{ + coarseGrainingFactors + ( + X Y Z + ); + particleDensities + ( + A B C + ); + runOnWriteOnly true; +\}; :pre + +{coarseGrainingFactors} = list of coarse graining factors by type, separated by whitespace, optional :ulb,l +{particleDensities} = list of particle densities by type, separated by whitespace, optional :l +{runOnWriteOnly} = switch if this should be executed on write, optional (default: false - execute every coupling step). :l + + +:ule + +[Description:] + +This "forceModel" does not influence the particles or the flow - it calculates the particle momentum-diameter correlation + +:c,image(Eqs/pdCorrelation.png) +where delta is the type-specific coarsegraining factor. + +This model is sensitive to additionally pulled particle type info, and can either use the type-specific densities from the dict or those pulled from LIGGGHTS. + +[Restrictions:] + +none. + +[Related commands:] + +"forceModel"_forceModel.html \ No newline at end of file