Skip to content

Commit 21a7d0a

Browse files
minor changes in readmd.md of postProcessing
1 parent c89a297 commit 21a7d0a

File tree

2 files changed

+75
-16
lines changed

2 files changed

+75
-16
lines changed

src/PostprocessData/readme.md

Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,14 @@ The `PostprocessData` module in phasicFlow provides powerful tools for analyzing
55
- in-simulation: this is postprocessing that is active during simulation. When running a solver, it allows for real-time data analysis and adjustments based on the simulation's current state. See below to see how you can activate in-simulation postprocessing.
66
- post-simulation: this is postprocessing that is done after the simulation is completed. It allows for detailed analysis of the simulation results, including data extraction and visualization based on the results that are stored in time-folders. If you want to use post-simulation, you need to run utility `postprocessPhasicFlow` in terminal (in the simulation case setup folder) to run the postprocessing. This utility reads the `postprocessDataDict` file and performs the specified operations on the simulation data.
77

8-
<div style="border: 1px solid black; padding: 10px; margin-bottom: 10px; background-color: gray;">
98

10-
**IMPORTANT NOTE**
9+
### Important Notes
1110

12-
in-simulation postprocessing is not implemented for MPI execution. For post-simulation postprocessing, you can use the `postprocessPhasicFlow` utility without MPI, even though the actual simulation has been done using MPI.
11+
* **NOTE 1:**
12+
postprocessing for in-simulation, is not implemented for MPI execution. So, do not use it when using MPI execution. For post-simulation postprocessing, you can use the `postprocessPhasicFlow` utility without MPI, even though the actual simulation has been done using MPI.
1313

14-
</div>
15-
16-
## 1. Overview
17-
18-
Postprocessing in phasicFlow allows you to:
19-
20-
- Extract information about particles in specific regions of the domain
21-
- Calculate statistical properties such as averages and sums of particle attributes
22-
- Track specific particles throughout the simulation
23-
- Apply different weighing methods when calculating statistics
24-
- Perform postprocessing at specific time intervals
14+
* **NOTE 2:**
15+
In post-simulation mode, all timeControl settings are ignored. The postprocessing will be done for all the time folders that are available in the case directory or if you specify the time range in the command line, the postprocessing will be done for the time folders that are in the specified range of command line.
2516

2617
## Table of Contents
2718

@@ -48,6 +39,16 @@ Postprocessing in phasicFlow allows you to:
4839
- [9. Mathematical Formulations](#9-mathematical-formulations)
4940
- [10. A complete dictionary file (postprocessDataDict)](#10-a-complete-dictionary-file-postprocessdatadict)
5041

42+
## 1. Overview
43+
44+
Postprocessing in phasicFlow allows you to:
45+
46+
- Extract information about particles in specific regions of the domain
47+
- Calculate statistical properties such as averages and sums of particle attributes
48+
- Track specific particles throughout the simulation
49+
- Apply different weighing methods when calculating statistics
50+
- Perform postprocessing at specific time intervals
51+
5152
## 2. Setting Up Postprocessing
5253

5354
Postprocessing is configured through a dictionary file named `postprocessDataDict` which should be placed in the `settings` directory. Below is a detailed explanation of the configuration options.
@@ -460,7 +461,7 @@ components
460461
processMethod particleProbe;
461462
processRegion centerPoints;
462463
selector id;
463-
field component(position,y);
464+
field component(velocity,y);
464465
ids (0 10 100);
465466
timeControl default; // other options are settings, timeStep, simulationTime
466467
// settings: uses parameters from settingsDict file
@@ -469,6 +470,35 @@ components
469470
// default: uses the default time control (defined in defaultTimeControl).
470471
// default behavior: if you do not specify it, parameters in defaultTimeControl is used.
471472
}
473+
474+
particlesTrack
475+
{
476+
processMethod particleProbe;
477+
478+
processRegion centerPoints;
479+
480+
// all particles whose ceters are located inside this box
481+
// are selected. Selection occurs at startTime: particles
482+
// that are inside the box at t = startTime.
483+
selector box;
484+
boxInfo
485+
{
486+
min (0 0 0);
487+
max (0.1 0.05 0.05);
488+
}
489+
490+
// center position of selected particles are processed
491+
field position;
492+
493+
timeControl simulationTime;
494+
// execution starts at 1.0 s
495+
startTime 1.0;
496+
// execution ends at 10 s
497+
endTime 10;
498+
// execution interval of this compoenent
499+
executionInterval 0.02;
500+
501+
}
472502

473503
on_single_sphere
474504
{

src/PostprocessData/sampleDictionary/postprocessDataDict

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ components
3636
processMethod particleProbe;
3737
processRegion centerPoints;
3838
selector id;
39-
field component(position,y);
39+
field component(velocity,y);
4040
ids (0 10 100);
4141
timeControl default; // other options are settings, timeStep, simulationTime
4242
// settings: uses parameters from settingsDict file
@@ -45,6 +45,35 @@ components
4545
// default: uses the default time control (defined in defaultTimeControl).
4646
// default behavior: if you do not specify it, parameters in defaultTimeControl is used.
4747
}
48+
49+
particlesTrack
50+
{
51+
processMethod particleProbe;
52+
53+
processRegion centerPoints;
54+
55+
// all particles whose ceters are located inside this box
56+
// are selected. Selection occurs at startTime: particles
57+
// that are inside the box at t = startTime.
58+
selector box;
59+
boxInfo
60+
{
61+
min (0 0 0);
62+
max (0.1 0.05 0.05);
63+
}
64+
65+
// center position of selected particles are processed
66+
field position;
67+
68+
timeControl simulationTime;
69+
// execution starts at 1.0 s
70+
startTime 1.0;
71+
// execution ends at 10 s
72+
endTime 10;
73+
// execution interval of this compoenent
74+
executionInterval 0.02;
75+
76+
}
4877

4978
on_single_sphere
5079
{

0 commit comments

Comments
 (0)