precice / precice/tutorials

Relying more on default parameters for the acceleration

Open
#765 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
142
Forks
167
Avg merge
20h 24m
Merged PRs (30d)
11

Description

Originally posted by @uekerman in https://github.com/precice/tutorials/issues/640#issuecomment-2761259728:

If we touch this, I would suggest to directly switch to the default everywhere, e.g.

<acceleration:IQN-ILS>
  <data name="Displacement" mesh="Solid-Mesh" />
  <data name="Force" mesh="Solid-Mesh" />
</acceleration:IQN-ILS>

This would mean, for the perpendicular-flap case:

    <acceleration:IQN-ILS>
      <data name="Displacement" mesh="Solid-Mesh" />
      <data name="Force" mesh="Solid-Mesh" />
-      <preconditioner type="residual-sum" update-on-threshold="false" />
-      <filter type="QR2" limit="1e-2" />
-      <initial-relaxation value="0.5" />
-      <max-used-iterations value="100" />
-      <time-windows-reused value="15" />
    </acceleration:IQN-ILS>

We could revisit all tutorials and remove all non-default values, or update to newer options (e.g., use the QR3 filter in more tutorials).

This would, however, require re-validation of each tutorial that is updated (and then updating the reference results).

Compare to the defaults in https://precice.org/configuration-xml-reference.html

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the perpendicular-flap case and compare its XML acceleration settings with the defaults in the preCICE configuration XML reference. Review the other tutorials for non-default acceleration values, then re-validate each updated tutorial and update its reference results. Done means the examples use appropriate current defaults or options and all reference results remain valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.