-
Notifications
You must be signed in to change notification settings - Fork 82
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
Changing Freesurface post-processing routine to a Sampler #1187
Conversation
I plan to change the names of the files from FreeSurface to FreeSurfaceSampler, but that would make it much harder to review. So I'm saving that for last. |
Also, I have python scripts to read in the data for every sampler type (ascii, native, and netcdf). I think these should be added to tools, and they'd be set up to read the output from the reg test that I added this sampler too. Thoughts? Figuring out the layout of any of these types took me some time, and having an example should be helpful. |
Examples are useful! Maybe better in the documentation? I worry about adding python scripts that could go out of date because we can't test them automatically. We can chat more about that. |
That's a good idea. I learned that jupyter notebooks can be included in sphinx documentation, so I might try that. |
I set up the docs so that they actually run the jupyter notebooks and generate the plots, and the notebooks are displayed in the docs for easy copy-paste. |
Here's how the docs look with these changes. |
@jrood-nrel do you think you could take a look at what I'm doing with the docs, namely, changing the conf.py and docs.yml files? @moprak-nrel do you have time to look over the stuff in the source code? |
|
Thanks for the feedback. I'll talk to Marc about what's the best way to incorporate this stuff. |
…dding better docs description and removing some comments from scripts
* remove incomplete, unused python script * add FreeSurfaceSampler to reg test * documentation * python scripts that pass with ctest (to be added later)
Summary
FreeSurface is designed to find the location of the air-water interface in simulations with vof. This PR converts that capability to a Sampler type, enabling sampling of fields at the interface and native output with AMReX particles.
Pull request type
Please check the type of change introduced:
Checklist
The following is included:
This PR was tested by running: