-
Notifications
You must be signed in to change notification settings - Fork 7
docs: Add GEQDSK/geoflux implementation plan with 3D field support #177
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
Draft
krystophny
wants to merge
19
commits into
main
Choose a base branch
from
tokamak
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add comprehensive TODO for tokamak GEQDSK support using geoflux coordinates - Reference Simpson rule implementation in KAMEL fix-integration branch - Document 3D field superposition via field_divB0 module - Note that 3D perturbations affect field but not reference coordinates
Document field_divB0 perturbation modes: - Vacuum perturbation workflow (ipert=1) with Biot-Savart coil fields - Plasma response modes (ipert=2,3) with Fourier representation - Coil file formats (AUG, GPEC, Nemov, STELLOPT) - vacfield.x program for generating field files from coil geometries - Phased implementation plan for SIMPLE+GEQDSK Note: libneo has full 3D capability but no regression tests yet
Add comprehensive summary section covering: - 4 perturbation modes (ipert=0/1/2/3) with use cases - Vacuum perturbation workflow using vacfield.x - Plasma response mode requirements - Available tools (coil_tools, coil_convert, Python interfaces) - Current status: fully implemented but not regression tested - 3-phase integration plan for SIMPLE+GEQDSK - Example field_divB0.inp configuration This provides quick reference for understanding libneo's 3D capabilities before diving into detailed implementation phases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a comprehensive implementation plan for tokamak GEQDSK support in SIMPLE using geoflux reference coordinates.
Key Additions
1. Complete GEQDSK Implementation Roadmap
2. 3D Field Superposition Documentation
3. Implementation References
fix-integrationbranchArchitecture Highlights
Clean separation:
Key insight: Reference coordinates stay axisymmetric (based on equilibrium), while magnetic field can include 3D perturbations.
Reuse strategy: Leverage field_divB0 for all GEQDSK I/O and field evaluation, only add coordinate transformation layer.
Status
This is a documentation-only PR - no code changes yet. It provides:
Next Steps
Files Changed
TODO.md: Comprehensive implementation plan (new file, ~1000 lines)Related Issues
Addresses the need for tokamak equilibrium support alongside existing stellarator capabilities.