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

Update PIC algorithm docu #5251

Merged
merged 3 commits into from
Feb 17, 2025

Conversation

fabidie
Copy link
Contributor

@fabidie fabidie commented Jan 24, 2025

A more detailed description of the PIC algorithm. Let me know whether it is more comprehensive now and if you want to add any information.

@ikbuibui ikbuibui added CI:no-compile CI is skipping compile/runtime tests but runs PICMI tests documentation regarding documentation or wiki discussions labels Jan 24, 2025
@ikbuibui ikbuibui added this to the 0.9.0 / next stable milestone Jan 24, 2025
Copy link
Member

@steindev steindev left a comment

Choose a reason for hiding this comment

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

Just a few comments, mainly misspelled markup.
You can also check the preview yourself at (https://picongpu--5251.org.readthedocs.build/en/5251/models/AOFDTD.html#model-aofdtd)

@chillenzer
Copy link
Contributor

chillenzer commented Jan 27, 2025

Haven't read through it yet, I'll have a closer look when the rendering issues are fixed. But as a general direction, we might want to add pictures like the two attached. Both are from the PIConGPU part of the alpaka workshop in October.

Simple idealistic PIC cycle:
pic-cycle drawio

Actual implementation (probably less pertinent here):
picongpu-main-loop_with-annotations_without-annotations drawio

@steindev
Copy link
Member

@chillenzer the second (larger) picture is great and fits nicely at the end of @fabidie's new text. We, i.e. you, would just need to update the "current update" step. It should display the continuity equation in differential form and not the current formula. In detail, $\vec v$ and $f$ are known at different times in the simulation (they are displaced by half a time step), and thus the currently printed equation for the computation of $J$ is inconsistent and leads to violation of charge conservation.

Copy link
Contributor

@finnolec finnolec left a comment

Choose a reason for hiding this comment

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

It reads well and I especially like the "blob" for macroparticles.

@finnolec
Copy link
Contributor

If the picture from @chillenzer is added we might also want to include documentation for the moving window somewhere in the documentation, but this doesn't belong into the PIC algorithm.

@BrianMarre
Copy link
Member

and close Issue #5056

@fabidie fabidie force-pushed the updatePICdoku branch 4 times, most recently from d13e535 to 44f7c03 Compare February 6, 2025 11:02
Copy link
Member

@steindev steindev left a comment

Choose a reason for hiding this comment

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

Only one missing colon (for correct rendering)...Otherwise I'm good.

@chillenzer
Copy link
Contributor

If nobody insists, I promised @steindev to merge this once everything renders correctly.

Copy link
Contributor

@chillenzer chillenzer left a comment

Choose a reason for hiding this comment

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

Renders fine and @steindev said it's good content-wise.

@chillenzer chillenzer merged commit aed7105 into ComputationalRadiationPhysics:dev Feb 17, 2025
10 checks passed
@fabidie fabidie deleted the updatePICdoku branch February 17, 2025 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI:no-compile CI is skipping compile/runtime tests but runs PICMI tests documentation regarding documentation or wiki discussions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants