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

[WIP] Refactor user interface of JRhom algorithm (previously multi-J) #5647

Open
wants to merge 8 commits into
base: development
Choose a base branch
from

Conversation

EZoni
Copy link
Member

@EZoni EZoni commented Feb 7, 2025

Implement what was discussed during the hackathon and summarized in #5229 (comment).

If accepted, this PR should replace #5229, which addressed only renaming and has many merge conflicts.

The previous input parameters

  • warpx.do_multi_J
  • warpx.do_multi_J_n_depositions
  • psatd.rho_in_time
  • psatd.J_in_time

are replaced with the one new input parameter psatd.JRhom, a string such as CC1, CL2, etc., which encodes

  • the time dependency of J through the first character;
  • the time dependency of rho through the second character;
  • the number of subintervals through the last integer.

This is aligned with the conventions used in the paper where we published the algorithm.

To-do:

  • Rediscuss new user interface
  • Improve parser of new user input psatd.JRhom
  • Complete refactoring throughout the code base
  • Add backward compatibility error messages
  • Update standard output messages (assert, abort, warning, error, ...)
  • Update documentation

@EZoni EZoni added the changes input scripts / defaults Changes the syntax or meaning of input scripts and/or defaults label Feb 7, 2025
@EZoni EZoni marked this pull request as ready for review February 8, 2025 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes input scripts / defaults Changes the syntax or meaning of input scripts and/or defaults
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant