Skip to content

Docs #16

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
Open
wants to merge 297 commits into
base: master
Choose a base branch
from
Open

Docs #16

wants to merge 297 commits into from

Conversation

BTV25
Copy link
Member

@BTV25 BTV25 commented Jun 20, 2025

Basic documentation for FLOWVPM. Does not include the full API, just the most relevant parts.

cibinjoseph and others added 30 commits February 26, 2024 03:15
@cibinjoseph
Remove field PSE
7c4202b
@cibinjoseph
Remove field C
5529f0b
@cibinjoseph
Remove field SFS
9eba49a
@cibinjoseph
Remove field J
88d928b
@cibinjoseph
Remove field M
4264836
@cibinjoseph
Correct typo
dbc6203
@cibinjoseph
Remove field static
f57754d
@cibinjoseph
Remove index field
26726c6
@cibinjoseph
Remove Particle struct and maintain an array of particles
01eec2c
@cibinjoseph
Remove particle file
2a7d0e7
@cibinjoseph
Remove debug statements and correct setindex and getindex functions t…
beaf02f 
…o use the views
@cibinjoseph
Generalize buffer_element() for the particle and remove Particle typing
6a49638
@cibinjoseph
Remove comment
b7895be
@cibinjoseph
Add getter and setter functions
285b5f4
@cibinjoseph
Use getter and setter functions in FMM definitions
b6c70dd
@cibinjoseph
Use the getter and setter functions for resetting the particles
24fca7d
@cibinjoseph
Add get and set for the other fields
0fe84da
@cibinjoseph
Use getter and setter functions everywhere
3ad5366
@cibinjoseph
Replace some more functions with getter and setter functions
afba95d
@cibinjoseph
Use the views to make code readability better and improve perf
28e5abf
@cibinjoseph
Add a variable replacer script for ease of use later if necessary
67833ac
@cibinjoseph
Remove replacer script from later commits
9771fbb
@cibinjoseph
Unroll 1:3 loops
ef01eee
@cibinjoseph
Variable substitution using the get functions
5602198
@cibinjoseph
Remove index field from xdmf file
00b95a3
@cibinjoseph
Undo the vectorization on 1-3 loops
51a0324
@cibinjoseph
Convert direct to use getter functions
ad595e6
@cibinjoseph
Merge pull request #7 from cibinjoseph/cibin
12c6c91 
Cibin
pullbacks for direct! and timestepping
e070b22
actually add rrules
9614d1f
@BTV25 BTV25 requested a review from rymanderson June 20, 2025 18:49
rymanderson
rymanderson requested changes Jun 26, 2025
View reviewed changes
Copy link
Member

@rymanderson rymanderson left a comment

Choose a reason for hiding this comment

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

Not quite ready yet.

@BTV25
Copy link
Member Author

BTV25 commented Jun 26, 2025

Looks like tests won't pass because the main branch is not up to date with the FastMultipole changes. I think it would be easiest if we upgraded the master branch and then fetched the changes into the docs branch.

@BTV25 BTV25 requested a review from rymanderson June 26, 2025 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rymanderson rymanderson Awaiting requested review from rymanderson

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@BTV25 @rymanderson @cibinjoseph @Eric-P-Green