95 lines
4.0 KiB
HTML
95 lines
4.0 KiB
HTML
<HTML>
|
|
<CENTER><A HREF = "http://www.cfdem.com">CFDEMproject WWW Site</A> - <A HREF = "CFDEMcoupling_Manual.html#comm">CFDEM Commands</A>
|
|
</CENTER>
|
|
|
|
|
|
|
|
|
|
<HR>
|
|
|
|
<H3>probeModel_particleProbe command
|
|
</H3>
|
|
<P><B>Syntax:</B>
|
|
</P>
|
|
<P>To be activated via couplingProperties dictionary.
|
|
</P>
|
|
<P>forceModels
|
|
(
|
|
myForceModel1
|
|
myForceModel2
|
|
myForceModel3
|
|
);
|
|
</P>
|
|
<P>probeModel particleProbe;
|
|
</P>
|
|
<PRE>particleProbeProps
|
|
{
|
|
particleIDsToSample (ID1 ID2 ID3 ...); //list of particleIDs to sample
|
|
verboseToFile; //main switch
|
|
verbose; //currently not used
|
|
printEvery xEvery; //print every this many CFD time steps
|
|
printOnlyAtStep xStep; //print only at this CFD time step (overrides "printEvery")
|
|
sampleAll; //Activate sampling for all particles
|
|
probeDebug; //probes additional fields
|
|
includePosition; //will include particle position in the output file
|
|
writePrecision xPrecision; //number of significant digits to print
|
|
};
|
|
</PRE>
|
|
<UL><LI><I>particleIDsToSample</I> = list of particle IDs to be sampled.
|
|
|
|
<LI><I>myForceModeli</I> = list of force models in the simulation, the particleProbe will be applied to all of these models!
|
|
|
|
<LI><I>verboseToFile</I> = main switch to activate the particle probe (default = off).
|
|
|
|
<LI><I>verbose</I> = main switch to activate output to Info (currently not implemented).
|
|
|
|
<LI><I>xEvery</I> = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step).
|
|
|
|
<LI><I>xStep</I> = integer to specify the step for sampling (default = deactivated, i.e., it will print accordingly to "printEvery").
|
|
|
|
<LI><I>sampleAll</I> = switch to activate sampling of all particles. Otherwise (default) only particles specified via "particleIDsToSample" in the couplingProperties dictionary will be sampled.
|
|
|
|
<LI><I>probeDebug</I> = switch to activate probing of debug properties of secondary importance (specific for each force model).
|
|
|
|
<LI><I>includePosition</I> = switch to add the particle position in the log file (default = off).
|
|
|
|
<LI><I>xPrecision</I>= number of significant digits of the text output (default = 3).
|
|
|
|
|
|
</UL>
|
|
<P><B>Examples:</B>
|
|
</P>
|
|
<PRE>particleIDsToSample (0 1 2 3);
|
|
forceModels
|
|
(
|
|
gradPForce
|
|
);
|
|
particleProbeProps
|
|
{
|
|
verboseToFile; //main switch
|
|
verbose; //currently not used
|
|
printEvery 100; //print every this many CFD time steps
|
|
sampleAll; //Activate sampling for all particles
|
|
probeDebug; //probes additional fields
|
|
includePosition; //will include particle position in the output file
|
|
writePrecision 4; //number of significant digits to print
|
|
};
|
|
</PRE>
|
|
<P>Note: This examples list might not be complete - please check below for the list of force models that can perform particle probing.
|
|
</P>
|
|
<P><B>Description:</B>
|
|
</P>
|
|
<P>The particleProbe feature keeps track of per-particle quantities (e.g., the fluid-particle interaction forces) acting on each DEM particle, and handles its storage during the simulation. Data is saved in the CFD/particleProbes/startTime directory, where startTime is the time at which the simulation is started (this avoids unwanted deletion of particleProbe data).
|
|
</P>
|
|
<P><B>Restrictions:</B>
|
|
</P>
|
|
<P>You can manually switch off the probe model for each force model by specifying the Switch "suppressProbe" in the corresponding force properties dictionary.
|
|
</P>
|
|
<P><B>Related commands which are currently enabled for particle probing:</B>
|
|
</P>
|
|
<P><A HREF = "forceModel_gradPForce.html">gradPForce</A>, <A HREF = "forceModel_viscForce.html">viscForce</A>, <A HREF = "forceModel_Beetstra.html">BeetstraDrag</A>, <A HREF = "forceModel_Holloway.html">HollowayDrag</A>, <A HREF = "forceModel_MeiLift.html">MeiLift</A>, as well as most other forceModels (see src directory for details, i.e., use "grep -r 'probeM(' ./" in the terminal).
|
|
</P>
|
|
<P><B>Default:</B> none.
|
|
</P>
|
|
</HTML>
|