v3: Make dt mandatory in documentation#257
Conversation
* change precice_dt to preciceDt and solver_dt to solverDt to follow conventions.
|
This implements the changes from precice/precice#1622 in the documentation. |
fsimonis
left a comment
There was a problem hiding this comment.
There are some contextual changes that are missing. Especially the way we handle the max time step size has changed.
pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Outdated
Show resolved
Hide resolved
images/docs/couple-your-code/couple-your-code-waveform/APIRelativeReadTime.pdf
Show resolved
Hide resolved
pages/docs/couple-your-code/couple-your-code-implicit-coupling.md
Outdated
Show resolved
Hide resolved
pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md
Outdated
Show resolved
Hide resolved
pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Outdated
Show resolved
Hide resolved
| ``` | ||
|
|
||
| `relativeReadTime` describes the time relatively to the beginning of the current time step. This means that `relativeReadTime = 0` gives us access to data at the beginning of the time step. By choosing `relativeReadTime > 0` we can sample data at later points. The maximum allowed `relativeReadTime` corresponds to the remaining time until the end of the current time window. Remember that the remaining time until the end of the time window is always returned when calling `preciceDt = precice.getMaxTimeStepSize()` as `preciceDt`. So `relativeReadTime = preciceDt` corresponds to sampling data at the end of the current time window. | ||
| In the previous sections of the step-by-step guide we always used `relativeReadTime = preciceDt` where `preciceDt = precice.getMaxTimeStepSize()` points to the end of the current time window (see, for example ["Step 5 - Non-matching time step sizes"](couple-your-code-time-step-sizes.html)). However, the original purpose of `relativeReadTime` is exactly to offer the user an interface for sampling from waveforms. The figure below illustrates how providing different values `dt` for `relativeReadTime` allows to sample interpolated values at different points in time: |
There was a problem hiding this comment.
I don't think that this is a good strategy (see also above): To tell users first how to do it the wrong way, and then the right way. Maybe we need to re-order our steps?
There was a problem hiding this comment.
Now that the waveform API is not experimental anymore but the default, let's put some information from here into "Step 5 - Non-matching time step sizes". I think this section needs some updates and refinement anyway. Additionally, I think that the topics that we currently explain in "Step 5 - Non-matching time step sizes" are definitely more advanced and exotic than some of the basic topics that we explain here. So yes: let's reorder some things.
We should still keep the more advanced background information (interpolation degree, higher-order time stepping) here to not provide too much information too early.
There was a problem hiding this comment.
There is a
There was a problem hiding this comment.
I didn't get this from the picture, seems like you use
Above you write
... relatively to the beginning of the current time step starting at
$\tau_n$
This should be
pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Outdated
Show resolved
Hide resolved
pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Outdated
Show resolved
Hide resolved
pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Outdated
Show resolved
Hide resolved
pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md
Outdated
Show resolved
Hide resolved
…ess.md Co-authored-by: Frédéric Simonis <simonisfrederic@gmail.com>
pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Outdated
Show resolved
Hide resolved
…hub.io into v3-make-dt-mandatory
uekerman
left a comment
There was a problem hiding this comment.
I would suggest to merge here and improve later.
pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md
Outdated
Show resolved
Hide resolved
* Fix whitespace. * Update action config docs to v3 (#254) * Update Roadmap * Update fundamentals-roadmap.md * Use time step, not timestep. (#259) * v3: Update documentation w.r.t getMaxTimeStep(). (#258) * Update documentation w.r.t getMaxTimeStep(). * Implements changes from precice/precice#1623 --------- Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Minor follow-up for #258. * Update documentation for initialize (#186) * Documentation for data initialization changes introduced in v3.0.0. * Cleanup initializeData. --------- Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> Co-authored-by: Benjamin Uekermann <benjamin.uekermann@ipvs.uni-stuttgart.de> * Update profiling section (#266) * Update profiling section * Update examples in profiling section * Apply suggestions from code review Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Add motivation for custom tool * Wording tweaks * More rewording * Update event files in output files --------- Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Fix typo in profiling * Update profiling info in guide * Update CMake variables to new names (#289) * Clarify some instructions in porting guide (#287) Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> * Fix minor issues in tooling/performance-analysis (#272) * Rename events to profiling according to precice/precice #1787 * Mention where to find the precice-profiling * Add hint regarding the event flag in precice-profiling * Add recommendation for `imvj-restart-mode` in configuration of acceleration (#296) * Update configuration-acceleration.md Add recommendation to use restart mode in `IQN-IMVJ` method for large-scale simulations. * Update pages/docs/configuration/configuration-acceleration.md Improve descriptive accuracy Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> --------- Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Apply trivial renaming changes. * Fix naming. * Add note. * Update breaking API changes (#299) --------- Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> * Fix token * Fix arg * Bump preCICE version * Update hint on formatting configuration files * Refer to precice.hpp instead of participant.hpp * Update version in docs sidebar * Rewrite mapping docs (#308) * Add overview figure * Work in progress * Fix links * Transform pdfs to svgs * Update kernel method section * Also write about GPU executors * Language edits by Benjamin and Makis Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Review updates * Makis language edits Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> * Fix typos via aspell --------- Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Fix some outdated solver-interface and dimensions (#314) * Migrate use-mesh to provide/receive-mesh * Migrate binprecice to precice-tools * Update config-visualizer page * Include instructions to remove .data() in readData function (#313) * Include instructions to remove .data() in readData function * Mention span replacing raw pointers * Remove raw pointers from general porting example * Cleanup porting guide example * Update couple your code * Remove obsolete section regarding IDs * Apply suggestions from code review Co-authored-by: Ishaan Desai <ishaandesai@gmail.com> * This PR adds C++ STL linking from Doxygen to cppreference * Fix WD * Link to porting guides from the source docs * Add list of porting guides to overview * Add new solid solver to Nutils adapter overview page (#325) * Geometric Multiscale Documentation (#205) Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> * Update submodules * Ignore tooling in images * Update xmlreference to v3.0.0 * Cleanup porting guide API+Config (#317) Co-authored-by: Ishaan Desai <ishaandesai@gmail.com> Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> * Update the rust bindings page * Fix link * Make dt in readData mandatory in documentation (#257) * v3: Make dt mandatory in documentation * Update read data functions to use relativeReadTime. * change precice_dt to preciceDt and solver_dt to solverDt to follow conventions. * Add missing. * Shorten a bit. * Minor follow-up for #258. * Add figure. * Remove outdated note. * Use dt properly. * Remove unnecessary pdf. * Partial update of documentation w.r.t breaking changes. * Redice diff. * Redice diff. * Reduce diff. * Fix some more breaking changes. * Add how dt is computed. See #257. * Apply suggestions from code review Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> * Remove unneeded. * Add pointer to interpolation section. * Fix format. * Add advice on precice/precice#1866. * Apply suggestions from code review * Update some minor, obviously outdated points. * Update png. * Update pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Co-authored-by: Frédéric Simonis <simonisfrederic@gmail.com> * Update heading. * Moved changes to #326. * Update pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md * Update pages/docs/couple-your-code/couple-your-code-waveform.md --------- Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> Co-authored-by: Frédéric Simonis <simonisfrederic@gmail.com> Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> * Update submodules * Remove v3 tip from roadmap * Add rust bindings to installation overview * Update libprecice2 to libprecice3 on Ubuntu packages page * Update header names in installation-linking * Update porting information on configuration overview page * Update several things on configuration basics page * Update configuration communication page * Revert tweaks in configuration basics page Previously, I changed from precice to participant as name for the preCICE handle and I used "Force" instead of "Forces" to be consistent with the tutorial guidelines. But both changes would also need updates on many other pages. Thus, I left them for the moment for consistency. * Refer to QN default values on acceleration configuration * Update porting info and mention Rust on couple your code start * Change global dim to mesh dim in step 3 * Remove dim handling from step 6 * Fix getDataDim arguments in step 3 * Fix dim handling in step 9 * Fix dim in direct access * Fix and tweak porting guide * Make linter happy * Make linter happier * Add missing tutorials in the sidebar and overview (#334) * Add partitioned-pipe-two-phase to sidebar and overview * Add oscillator overlap in sidebar and overview * Add partitioned-heat-conduction-overlap to the sidebar and overview * Add volume-coupled-flow to sidebar and overview * Add two-scale-heat-conduction to sidebar and overview * Update pages/tutorials/tutorials.md Co-authored-by: Ishaan Desai <ishaan.desai@ipvs.uni-stuttgart.de> * Update pages/tutorials/tutorials.md --------- Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com> Co-authored-by: Ishaan Desai <ishaan.desai@ipvs.uni-stuttgart.de> * Update bindings overview picture (#333) * Update bindings overview picture * Move arrow of Python bindings to precice.hpp * Add Rust bindings --------- Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@in.tum.de> Co-authored-by: Gerasimos Chourdakis <chourdak@in.tum.de> Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de> Co-authored-by: Frédéric Simonis <simonisfrederic@gmail.com> Co-authored-by: David Schneider <david.schneider@ipvs.uni-stuttgart.de> Co-authored-by: carme-hp <71499004+carme-hp@users.noreply.github.com> Co-authored-by: June <94080048+Fujikawas@users.noreply.github.com> Co-authored-by: homspons <ge35joj> Co-authored-by: Ishaan Desai <ishaandesai@gmail.com> Co-authored-by: Elia Zonta <99761626+ezonta@users.noreply.github.com> Co-authored-by: precice-bot <info@precice.org> Co-authored-by: Ishaan Desai <ishaan.desai@ipvs.uni-stuttgart.de>
Uh oh!
There was an error while loading. Please reload this page.