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.

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

Unclear instructions in porting guide #286

Closed
carme-hp opened this issue Jul 27, 2023 · 2 comments
Closed

Unclear instructions in porting guide #286

carme-hp opened this issue Jul 27, 2023 · 2 comments
Labels
content Content-only issues

Comments

@carme-hp
Copy link
Contributor

carme-hp commented Jul 27, 2023

In the Porting from 2.x to 3.x guide the following points raised confusion:

  • About intialize:

Remove initializeData() and initialize the data after defining the mesh and before calling initialize() if requiresInitialData() is true.

It think it would help to mention that initializeData() and initialize() have been merged into initialize(). I understand this means that the mesh and the data (if needed) need to be specified before calling initialize()

  • About isActionRequired and markActionFullfiled:

Replace precice::constants::* with isActionRequired() and markActionFulfilled() with their respective requirement clause: requiresInitialData(), requiresReadingCheckpoint() or requiresWritingCheckpoint(). If these requirements are checked, then they are promised to be acted on.

Alternative: Replace isActionRequired() with their respective requirement clause: requiresInitialData(), requiresReadingCheckpoint() or requiresWritingCheckpoint(). If these requirements are checked, then they are promised to be acted on, so markActionFulfilled is not needed anymore.

@carme-hp
Copy link
Contributor Author

Another unclear point:

Change integer input argument data ID to string arguments mesh name and data name in the API commands hasData, writeBlockVectorData, writeVectorData, writeBlockScalarData, writeScalarData, readBlockVectorData, readVectorData, readBlockScalarData, readScalarData, requiresGradientDataFor, writeBlockVectorGradientData, writeVectorGradientData, writeBlockScalarGradientData, writeScalarGradientData

Since all of this functions have now been simplified to readData, writeDataand writeGradientData it would be nice to mention that as an additional point after the previous one.

@MakisH
Copy link
Member

MakisH commented Aug 8, 2023

Closed by #287.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Content-only issues
Projects
Status: Done
Development

No branches or pull requests

3 participants