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

Profiling of user-code via API #1647

Open
fsimonis opened this issue May 10, 2023 · 1 comment · May be fixed by #1657
Open

Profiling of user-code via API #1647

fsimonis opened this issue May 10, 2023 · 1 comment · May be fixed by #1657
Labels
enhancement A new feature, a new functionality of preCICE (from user perspective)
Milestone

Comments

@fsimonis
Copy link
Member

Please describe the problem you are trying to solve.
preCICE contains its own profiling framework.
It could be useful for the user to use this profiling functionality as well.
This would add information to the solver sections solver.initialize and solver.advance, making them easier to interpret, especially in traces.

This would be especially useful to integrate the time measurements of existing adapters.

The limitation being that preCICE needs to be constructed for the profiling to work.

Describe the solution you propose.

void SolverInterface::startSection(::precice::string_view sectionName);
void SolverInterface::stopSection(::precice::string_view sectionName);

Describe alternatives you've considered
Solver codes may already rely on external tools, or other kind of instrumentalization for profiling.

Additional context

See #1419

@fsimonis fsimonis added the enhancement A new feature, a new functionality of preCICE (from user perspective) label May 10, 2023
@fsimonis fsimonis added this to the Version 3.x.x milestone May 10, 2023
@uekerman
Copy link
Member

This nicely fits the future plans to standardize adapters. Very similar idea (but probably worth a separate issue one day): We could do the same for our logging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement A new feature, a new functionality of preCICE (from user perspective)
Projects
Status: WP2 Compile standard (2024-2025)
Development

Successfully merging a pull request may close this issue.

2 participants