Skip to content

Commit ee8c545

Browse files
update of readme.md file after adding precision and scientific options for postprocessing
1 parent 42315d2 commit ee8c545

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

src/PostprocessData/readme.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,41 @@ Regions define where in the domain the postprocessing operations are applied:
138138
| <td colspan="3">\* Particles selection is done when simulation reaches the time that is specified by `startTime` of the post-process component and this selection remains intact up to the end of simulation. This is very good for particle tracking purposes or when you want to analyze specific particles behavior over time.</td> |
139139
| <td colspan="3">\** This region creates a rectangular mesh and particles are located into cells according to their center points. When using `GaussianDistribution` as `processMethod`, a larger neighbor radius is considered for each cell and particles inside this neighbor radius are included in the calculations.</td> |
140140
141+
### output format
142+
143+
The output format of the postprocessing results can be controlled by the `precision` and `scientific` parameters:
144+
145+
- `precision`: Number of decimal places for the output (defualt is 6).
146+
- `scientific`: Whether to use scientific notation for large numbers (options: `yes`, `no`, default is `yes`).
147+
148+
for example, if you want to use 5 decimal places and no scientific notation, you can set:
149+
150+
```C++
151+
on_single_sphere
152+
{
153+
processMethod arithmetic;
154+
155+
processRegion sphere;
156+
157+
sphereInfo
158+
{
159+
radius 0.01;
160+
center (-0.08 -0.08 0.015);
161+
}
162+
163+
timeControl default;
164+
165+
precision 5; // default is 6
166+
167+
scientific no; // default is yes
168+
169+
operations
170+
(
171+
// a list of operations should be defined here
172+
);
173+
}
174+
```
175+
141176
## 6. Processing Operations for Bulk Properties
142177

143178
Within each processing region of type `bulk`, you can define multiple operations to be performed:
@@ -566,6 +601,7 @@ components
566601
// are selected. Selection occurs at startTime: particles
567602
// that are inside the box at t = startTime.
568603
selector box;
604+
569605
boxInfo
570606
{
571607
min (0 0 0);
@@ -574,6 +610,14 @@ components
574610

575611
// center position of selected particles are processed
576612
field position;
613+
614+
// precision for output to file (optional: default is 6)
615+
precision 8;
616+
617+
// if the output format of numbers in scientific format
618+
// is required, set scientific to yes, otherwise no
619+
// (optional: default is yes)
620+
scientific no;
577621
578622
timeControl simulationTime;
579623
// execution starts at 1.0 s
@@ -608,6 +652,14 @@ components
608652
cellExtension 3;
609653
}
610654

655+
// precision for output to file (optional: default is 6)
656+
precision 5;
657+
658+
// if the output format of numbers in scientific format
659+
// is required, set scientific to yes, otherwise no
660+
// (optional: default is yes)
661+
scientific no;
662+
611663
operations
612664
(
613665
avVelocity

0 commit comments

Comments
 (0)