Home

Tutorial

This page provides a few examples of the various capabilities of the config-visualizer. This guide assumes that the setup instruction have been completed.

Use Cases

A sample use case is included in ROOT/sample/precice-config.xml, which is used in this example. To output the full dot file, run:

precice-config-visualizer -o sample/precice sample/precice-config.xml
xdot sample/precice

You should now see a complicated diagram with many connections, which may contain redundant information. Let's say we are confident that data-access information is accurate. We can now merge or hide this information. We run the the same code with the --data-access=merged option.

precice-config-visualizer --data-access=merged -o sample/precice sample/precice-config.xml
xdot sample/precice

We now see that the data access connections have now been merged to a single connection between the participants and the meshes.

After checking that data exchange is occurring correctly, we just want a simple diagram that show the various connections between participants and meshes. We then merge the data-exchange connections with the --data-exchange=merged option:

python3 visualize.py --data-access=merged --data-exchange=merged -o sample/precice sample/precice-config.xml
xdot sample/precice

We now see a simplified diagram with a quick overview of the various relationship between the components of the preCICE coupling.

We can now get rid of the coupling scheme and communicator info for a nicer diagram with:

precice-config-visualizer --data-access=merged --data-exchange=merged  --cplschemes=hide --communicators=hide -o sample/precice sample/precice-config.xml
xdot sample/precice