Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update (some) breaking API changes #299

Merged
merged 9 commits into from
Nov 15, 2023
Merged

Update (some) breaking API changes #299

merged 9 commits into from
Nov 15, 2023

Conversation

BenjaminRodenberg
Copy link
Member

@BenjaminRodenberg BenjaminRodenberg commented Nov 11, 2023 •
edited
Loading

I updated some of the breaking API changes here. Mainly

  • Replacing old read/writeData functions with new ones.
  • Replacing raw pointers with spans
  • Replacing SolverInterface with Participant
  • Removal of outdated API functions

I also added some todos where there are still things to be done. I will merge this PR (independent from the review) soon, because otherwise working on other PRs becomes a real pain (e.g. #257). Since precice-v3 is a non-released develop branch and the current state is incomplete and inconsistent anyway, I think there is no real harm.

If anybody sees potential for improvement: Please directly apply the changes here. There is no need for long discussions in my opinion.

@BenjaminRodenberg BenjaminRodenberg self-assigned this Nov 11, 2023
@BenjaminRodenberg BenjaminRodenberg changed the base branch from master to precice-v3 November 11, 2023 11:29
@BenjaminRodenberg BenjaminRodenberg mentioned this pull request Nov 11, 2023
Merged
1 task
@BenjaminRodenberg BenjaminRodenberg added this to the Version 3.0.0 milestone Nov 11, 2023
MakisH
MakisH reviewed Nov 13, 2023
View reviewed changes
Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some first comments, there are anyway still some TODOs.
Thanks a lot for the effort of updating the API! This is very important and helpful.

pages/docs/configuration/configuration-mapping.md Outdated Show resolved Hide resolved
pages/docs/couple-your-code/couple-your-code-defining-mesh-connectivity.md Outdated Show resolved Hide resolved
pages/docs/couple-your-code/couple-your-code-defining-mesh-connectivity.md Outdated Show resolved Hide resolved
pages/docs/couple-your-code/couple-your-code-defining-mesh-connectivity.md Outdated Show resolved Hide resolved
pages/docs/couple-your-code/couple-your-code-gradient-data.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-mesh-and-data-access.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-waveform.md Outdated Show resolved Hide resolved
@MakisH
Copy link
Member

MakisH commented Nov 14, 2023

Do you want to handle the TODO parts in this PR, or in a separate one?

@BenjaminRodenberg
Copy link
Member Author

Do you want to handle the TODO parts in this PR, or in a separate one?

I think we should merge this one soon. If somebody else want's to handle the TODO parts while reviewing, I'm fine. If not, we can do it later.

MakisH
MakisH approved these changes Nov 14, 2023
View reviewed changes
Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then, feel free to open an issue and merge this.
FYI, I have not cross-checked with the documentation whether there is more than find&replace needed in the points you have touched.

@BenjaminRodenberg BenjaminRodenberg mentioned this pull request Nov 15, 2023
Closed
@BenjaminRodenberg BenjaminRodenberg merged commit f71bbf8 into precice-v3 Nov 15, 2023
1 check passed
uekerman added a commit that referenced this pull request Feb 12, 2024
@uekerman @BenjaminRodenberg
@MakisH @fsimonis @davidscn @carme-hp @Fujikawas @IshaanDesai @ezonta @precice-bot
Merge pull request #332 from precice/precice-v3
7010daa 
* 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>
@BenjaminRodenberg BenjaminRodenberg deleted the update_breaking_changes branch July 10, 2024 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MakisH MakisH MakisH approved these changes

@davidscn davidscn Awaiting requested review from davidscn

@fsimonis fsimonis Awaiting requested review from fsimonis

Assignees

@BenjaminRodenberg BenjaminRodenberg

Labels
None yet
Projects
None yet
Milestone
Version 3.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@BenjaminRodenberg @MakisH