probeModel: particleProbe

Syntax

To be activated via couplingProperties dictionary.

forceModels
(
    myForceModel1
    myForceModel2
    myForceModel3
);

probeModel particleProbe;

particleProbeProps
{
    particleIDsToSample (ID1 ID2 ID3 ...);
    verboseToFile;
    verbose;
    printEvery       xEvery;
    printOnlyAtStep  xStep;
    sampleAll;
    probeDebug;
    includePosition;
    writePrecision xPrecision;
}

  • particleIDsToSample = list of particle IDs to be sampled.

  • forceModels = list of force models in the simulation. The particleProbe will be applied to all of these models.

  • verboseToFile = switch to activate the particle probe. Set to true if present.

  • verbose = main switch to activate output to log file. Set to true if present.

  • printEvery = integer to specify the interval for sampling (default = 1, i.e., probing occurs every CFD time step).

  • printOnlyAtStep = print probes only at specified time step. Overrides printEvery setting. (default: deactivated).

  • sampleAll = switch to activate sampling of all particles. Otherwise (default) only particles specified via “particleIDsToSample” will be sampled.

  • probeDebug = switch to activate probing of debug properties of secondary importance (specific for each force model). Set to true if present.

  • includePosition = switch to add the particle position in the log file. Only set if present. (default: off)

  • writePrecision = number of significant digits of the text output (default = 3).

Examples

forceModels
(
    gradPForce
);
particleProbeProps
{
    particleIDsToSample (0 1 2 3);
    verboseToFile;
    verbose;
    printEvery  100;
    sampleAll;
    probeDebug;
    includePosition;
    writePrecision 4;
}

Note

This examples list might not be complete - please check below for the list of force models that can perform particle probing.

Description

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).

Restrictions

You can manually switch off the probe model for each force model by specifying the Switch suppressProbe in the corresponding force properties dictionary.

Related commands which are currently enabled for particle probing:

gradPForce, viscForce, MeiLift, as well as most other forceModels (see src directory for details, i.e., use grep -r 'probeM(' ./ in the terminal).

Default: none.