AMReX-Astro / AMReX-Astro/Castro
revisit problem_post hooks and document
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 340
- Forks
- 105
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 8
Description
Currently there are 4 ifdefs for the problem post hooks:
DO_PROBLEM_POST_TIMESTEPDO_PROBLEM_POST_RESTARTDO_PROBLEM_POST_INITDO_PROBLEM_POST_SIMULATION
Only the last of these is controlled by a make option (USE_POST_SIM).
Usually the problem-specific implementation of these is in Prob.cpp.
We should revisit whether we really want these ifdef-ed out or if we just have simple stubs always defined. For the latter, we might need to update some problem setups.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the four hook macros and the USE_POST_SIM make option, then inspect the problem-specific implementations in Prob.cpp and the affected problem setups. The work is done when the hook policy is decided, the relevant setup changes are made if needed, and the behavior is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system, hpc
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100