Clarify some instructions in porting guide #287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MakisH
reviewed
Aug 1, 2023
Co-authored-by: Gerasimos Chourdakis <[email protected]>
Co-authored-by: Gerasimos Chourdakis <[email protected]>
Co-authored-by: Gerasimos Chourdakis <[email protected]>
MakisH
approved these changes
Aug 8, 2023
|
I think this PR should have been merged directly into |
uekerman
added a commit
that referenced
this pull request
Feb 12, 2024
* 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Benjamin Uekermann <[email protected]> * Update profiling section (#266) * Update profiling section * Update examples in profiling section * Apply suggestions from code review Co-authored-by: Benjamin Uekermann <[email protected]> * Add motivation for custom tool * Wording tweaks * More rewording * Update event files in output files --------- Co-authored-by: Benjamin Uekermann <[email protected]> * 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 <[email protected]> * 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 <[email protected]> --------- Co-authored-by: Benjamin Uekermann <[email protected]> * Apply trivial renaming changes. * Fix naming. * Add note. * Update breaking API changes (#299) --------- Co-authored-by: Gerasimos Chourdakis <[email protected]> * 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 <[email protected]> Co-authored-by: Benjamin Uekermann <[email protected]> * Review updates * Makis language edits Co-authored-by: Gerasimos Chourdakis <[email protected]> * Fix typos via aspell --------- Co-authored-by: Gerasimos Chourdakis <[email protected]> Co-authored-by: Benjamin Uekermann <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Update submodules * Ignore tooling in images * Update xmlreference to v3.0.0 * Cleanup porting guide API+Config (#317) Co-authored-by: Ishaan Desai <[email protected]> Co-authored-by: Gerasimos Chourdakis <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Frédéric Simonis <[email protected]> Co-authored-by: Benjamin Uekermann <[email protected]> * 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 <[email protected]> * Update pages/tutorials/tutorials.md --------- Co-authored-by: Benjamin Uekermann <[email protected]> Co-authored-by: Ishaan Desai <[email protected]> * 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 <[email protected]> Co-authored-by: Gerasimos Chourdakis <[email protected]> Co-authored-by: Benjamin Rodenberg <[email protected]> Co-authored-by: Frédéric Simonis <[email protected]> Co-authored-by: David Schneider <[email protected]> Co-authored-by: carme-hp <[email protected]> Co-authored-by: June <[email protected]> Co-authored-by: homspons <ge35joj> Co-authored-by: Ishaan Desai <[email protected]> Co-authored-by: Elia Zonta <[email protected]> Co-authored-by: precice-bot <[email protected]> Co-authored-by: Ishaan Desai <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the follow-up of the issue #286 .