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.

Sign up for GitHub

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

Jump to bottom

Collective Effects Config in Dashboard #690

Merged
merged 60 commits into from
Nov 22, 2024
Merged

Collective Effects Config in Dashboard #690

merged 60 commits into from
Nov 22, 2024
+682 −103

Conversation

proy30
Copy link
Contributor

@proy30 proy30 commented Aug 29, 2024 •
edited
Loading

PR adds in Space Charge and CSR configuration for users.

TODO:

  • Space Charge Defaults
    • poisson_solver = "fft" (though, in ImpactX documentation default is "multigrid".)
    • max_level = 0
    • particle_shape = 2
    • n_cell = 1 (for x,y,z)
    • blocking_factor (x,y,z) - 32
  • Space Charge Validation
    • n_cell - value_type = 'int' & >=1, must be a factor of blocking_factor
    • prob_relative - if poisson_solver = "fft", index[0] >=3
      if possion_solver = "multigrid", index[0] >1
      else index[1-(n-1)] >1
    • blocking_factor (x,y,z) - Greater than 0
  • CSR Defaults
    • csr_bins = 150
  • CSR Validation
    • csr_bins='int', positive number
  • Add multigrid-specific numerical options (no validation as of now)
    • MLMG Relative Tolerance
    • MLMG Absolute Tolerance
    • MLMG Max Iterations
    • MLMG Verbosity
  • Update export_template
  • Update run_simulation status function

Resolves #665

@proy30 proy30 added component: dashboard our browser based trame dashboard component: space charge Space charge & potential solver labels Aug 29, 2024
@proy30 proy30 marked this pull request as draft August 29, 2024 02:24
@proy30 proy30 self-assigned this Aug 29, 2024
@ax3l ax3l self-requested a review August 29, 2024 05:46
@proy30
Copy link
Contributor Author

proy30 commented Sep 5, 2024

UI as of 9/4/24 - 6:25pm PST:

chrome_dDj4cC6PK7

@ax3l ax3l changed the title [WIP] Space Charge Configuration [WIP] Collective Effects Config in Dashboard Sep 5, 2024
@ax3l ax3l added the component: CSR coherent synchrotron radiation models label Sep 5, 2024
@proy30 proy30 force-pushed the dashboard/space_charge_configuration branch from d6d3cb1 to c08a1be Compare September 6, 2024 17:19
@ax3l ax3l mentioned this pull request Oct 2, 2024
Merged
@proy30 proy30 mentioned this pull request Oct 21, 2024
Merged
4 tasks
proy30 and others added 15 commits October 24, 2024 08:36
@proy30
Added initial space charge UI with basic compatibility with simulation
d8f458c
@pre-commit-ci @proy30
[pre-commit.ci] auto fixes from pre-commit.com hooks
bc6ac53 
for more information, see https://pre-commit.ci
@proy30
Connected max_level and poisson_solver to simulation
245ca67
@proy30
prob_relative simulation functionality added
0fd00f4
@proy30
Update code structuring
6de4c5d
@proy30
rename variables
deab4ff
@proy30
Moved input cards
8ac0134
@proy30
code structure adjustment
87f6117
@proy30
Added space charge documentation
6dd9df2
@proy30
Added CSR configuration
a4967d3
@proy30
Rename 'CSR Configuration' to 'CSR' for UI and code
cc7796c 
folder name is still called 'csrConfiguration'
@proy30
Connect csr_bins to simulation
4d55002
@proy30
Updated UI look and minor code structure
26658e8
@proy30
Add initial validation for Space Charge
2dd9313
@proy30
update simulation code & change Vcombobox to vSelect
8c4d341
@proy30
Updated prob_relative validation
12c8681 
prob_relative values are required to decrease with increasing index
@proy30
Connected blocking_factor to simulation
86e4c07
@proy30
Add multigrid-specific numerical options
f94bcdc 
No validation yet and not yet connected to simulation
@proy30
Adjust UI formatting
5b0327c
@proy30
Update export_template for space charge and csr
dcdb8fe
@proy30
Updated default for blocking_factor xyz
c00c91f
@proy30
Fixed simulation.py after merge
774b365 
Space charge/csr simulation content did not merge in correctly originally, this fixes it.
@proy30 proy30 force-pushed the dashboard/space_charge_configuration branch from 2ddadf9 to 774b365 Compare October 24, 2024 15:41
@proy30 proy30 changed the title [WIP] Collective Effects Config in Dashboard Collective Effects Config in Dashboard Nov 7, 2024
EZoni
EZoni reviewed Nov 8, 2024
View reviewed changes
src/python/impactx/dashboard/Toolbar/exportTemplate.py Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is a git display issue, but the indentation of the function body for build_space_charge_or_csr seems off. Could you double check?

EZoni
EZoni reviewed Nov 8, 2024
View reviewed changes
src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py
with vuetify.VCol(cols=6, classes="py-0"):
vuetify.VTextField(
label="MLMG Relative Tolerance",
v_model=("mlmg_relative_tolerance",),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In one discussion in the Trame repo, I was told that one could use v_model_number as well (on top of type="number") and that it could render numbers better when it comes to formatting.

I did try it on my end without noticing any significant improvement, but maybe you could try it as well.

For reference, here's the comment where this was mentioned: Kitware/trame#599 (reply in thread).

EZoni
EZoni reviewed Nov 8, 2024
View reviewed changes
src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py
Comment on lines +47 to +52
if state.poisson_solver == "fft":
state.prob_relative = [1.1] + [0.0] * (num_prob_relative_fields - 1)
elif state.poisson_solver == "multigrid":
state.prob_relative = [3.1] + [0.0] * (num_prob_relative_fields - 1)
else:
state.prob_relative = [0.0] * num_prob_relative_fields
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question for both you and @cemitch99, should we add a comment about the numbers that appear here (e.g., 1.1, 3.1, etc.)? I'm not too familiar with the context here, so I'm not sure if the meaning of these numbers should be clarified.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those numbers in prob_relative specify the size of the grid relative to the size of the beam, and are documented here and here. Maybe some of the input parameters should include links to the documentation?

cemitch99
cemitch99 approved these changes Nov 8, 2024
View reviewed changes
Copy link
Member

@cemitch99 cemitch99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. We can discuss a little when we chat today.

@cemitch99 cemitch99 marked this pull request as ready for review November 21, 2024 18:08
@cemitch99 cemitch99 merged commit 1c3861f into ECP-WarpX:development Nov 22, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EZoni EZoni EZoni left review comments

@ax3l ax3l ax3l left review comments

@cemitch99 cemitch99 cemitch99 approved these changes

Assignees

@proy30 proy30

Labels
component: CSR coherent synchrotron radiation models component: dashboard our browser based trame dashboard component: space charge Space charge & potential solver
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Dashboard] Missing Space Charge Configuration
4 participants
@proy30 @ax3l @cemitch99 @EZoni