AMReX-Astro / AMReX-Astro/Microphysics

consider changing rhs() interface in integrator to pass y instead of integrator type

Open
#1,192 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

integrator
Dominant language
C++
Stars
43
Forks
46
Avg merge
2d 18h
Merged PRs (30d)
15

Description

Right now, we pass the full integrator type (like vode_t) to the rhs() wrapper and then copy vode_t integrator_state.y() into the burn_t state to do the burn. But some integrators (like the RKC) want to pass in different states that are not always in the .y() slot in the integrator type.

We should consider changing the wrappers to explicitly pass in the state, y() instead of the entire integration state. I think that this is very straightforward.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the rhs() wrappers and the integrator types mentioned in the issue, especially vode_t, RKC, and burn_t. Review how integrator_state.y() is copied into the burn state; done means the wrappers explicitly receive the appropriate state and also support integrators whose active state is not in y().

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend-api-design, hpc
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.