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

Add precice.hpp and solver-interface changes to porting guide #284

Merged
merged 4 commits into from
Jul 21, 2023
Merged

Add precice.hpp and solver-interface changes to porting guide #284

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5ae45a
Add precice.hpp and solver-interface changes to porting guide
MakisH Jul 19, 2023
2f964ab
Update couple-your-code-porting-v2-3.md
MakisH Jul 19, 2023
f42576b
Update couple-your-code-porting-v2-3.md
MakisH Jul 19, 2023
c5ee69f
Update pages/docs/couple-your-code/couple-your-code-porting-v2-3.md
MakisH Jul 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions pages/docs/couple-your-code/couple-your-code-porting-v2-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ Please add breaking changes here when merged to the `develop` branch.

## preCICE API

- The main preCICE header file was renamed. This means that you need to:
- Replace `#include "precice/SolverInterface.hpp"` with `#include "precice/precice.hpp"`.
- Where declaring a preCICE object, replace the `precice::SolverInterface` type with `precice::Participant`
- Where constructing a preCICE object, replace the `precice::SolverInterface( ... )` constructor with `precice::Participant( ... )`.
- Consider renaming your objects from, e.g., `interface` to `participant`, to better reflect the purpose and to be consistent with the rest of the changes.
- Migrate connectivity information to the vertex-only API. All `setMeshX` methods take vertex IDs as input and return nothing.
- Directly define face elements or cells of your coupling mesh available in your solver by passing their vectices to preCICE, which automatically handles edges of triangles etc. See [Mesh Connectivity](couple-your-code-defining-mesh-connectivity) for more information.
- Rename `setMeshTriangleWithEdges` to `setMeshTriangle` and `setMeshQuadWithEdges` to `setMeshQuad`. The edge-based implementation was removed.
Expand Down Expand Up @@ -84,6 +89,7 @@ error: ‘class precice::SolverInterface’ has no member named ‘initializeDat

## preCICE configuration file

- The XML tag `<solver-interface>` was removed and all underlying functionality was moved to the `<precice-configuration>` tag. Remove the lines including `<solver-interface>` and `</solver-interface>`, and move any attributes (such as `dimensions="3"` or `experimental`) from the `solver-interface` to the `precice-configuration` tag.
- Replace mapping constraint `scaled-consistent` with `scaled-consistent-surface`.
- Replace `<use-mesh provide="true" ... />` with `<provide-mesh ... />`, and `<use-mesh provide="false" ... />` with `<receive-mesh ... />`.
- Replace `<extraplation-order value="2" />` in `<coupling-scheme>` with `<extraplation-order value="1" />` or simply remove it.
Expand Down Expand Up @@ -134,6 +140,13 @@ A specific solver should only be configured if you want to force preCICE to use

## Language bindings

The renaming of the preCICE API from `SolverInterface` to `preCICE` also applies to all language bindings. The C++ header change `precice/SolverInterface.hpp` to `precice/precice.hpp` becomes:

- In C: Replace `#include "precice/SolverInterfaceC.h"` with `#include "precice/preciceC.h"` and `precicec_createSolverInterface( ... )` with `precicec_createParticipant( ... )`.
- In Julia: Replace `precicec_createSolverInterface( ... )` with `precicec_createParticipant( ... )`.
- In Matlab: Replace `SolverInterface` with `Participant` everywhere.
- In Fortran, Python: You don't need to change anything.

<!--
- Rename Fortran function `precicef_ongoing()` to `precicef_is_coupling_ongoing()`
- Removed `precicef_write_data_required()`, `precicef_read_data_available()`, `precicef_action_required()`.
Expand Down
Loading