Skip to content

Commit c8740c3

Browse files
committed
Update profiling info in guide
1 parent 820829a commit c8740c3

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

pages/docs/couple-your-code/couple-your-code-porting-v2-3.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ A specific solver should only be configured if you want to force preCICE to use
117117
- Remove all timings in the mapping configuration `<mapping: ... timing="initial/onadvance/ondemand" />`.
118118

119119
<!--
120-
- Add `<profiling mode="all" />` after the `<log>` tag if you need profiling data.
121120
- Replace `<export:vtk />` for parallel participants with `<export:vtu />` or `<export:vtp />`.
122121
-->
123122

@@ -137,6 +136,6 @@ A specific solver should only be configured if you want to force preCICE to use
137136

138137
## Profiling
139138

140-
<!--
141-
- New modes for profiling data: `none`, `fundamental` (default), `all`.
142-
-->
139+
- There are three profiling modes now: `off`, `fundamental` (default), `all`.
140+
- Add `<profiling mode="all" />` inside the `<precice-configuration>` tag if you need detailed profiling data.
141+
- If you relied on `sync-mode="on"`, remove it from `<precice-configuration>` and add it to the profiling tag `<profiling synchronize="true" />`.

pages/docs/tooling/tooling-performance-analysis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Measuring the runtime of such operations can be tricky, as the time spent waitin
3939
Synchronizing all ranks using a barrier solves the issue, but has an impact on performance.
4040

4141
To keep this waiting component of the overall measurement to a minimum without affecting performance, we added a configuration option to toggle the synchonization before required events.
42-
Use the `sync-mode` attribute to enable such synchonization if you need it.
42+
Use the `synchronize` attribute to enable such synchronization if you need it.
4343

4444
```xml
45-
<precice-configuration sync-mode="1">
46-
...
45+
<precice-configuration>
46+
<profiling synchronize="true" />
4747
</precice-configuration>
4848
```
4949

@@ -87,8 +87,8 @@ To prevent any write operations of the filesystem until the end of the simulatio
8787
To profile blocking operations:
8888

8989
```xml
90-
<precice-configuration sync-mode="1">
91-
<profiling mode="all" />
90+
<precice-configuration>
91+
<profiling mode="all" synchronize="true" />
9292
</precice-configuration>
9393
```
9494

0 commit comments

Comments
 (0)