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

Add some example siesta namelist input files. #69

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Add some example siesta namelist input files. #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions Sources/siesta_namelist.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,82 @@
!> @item{mupar_test, UNKNOWN, shared_data::mupar_test}
!> @end_table
!>
!> @section siesta_namelist_exam_sec Example Files
!> @subsection siesta_namelist_exam_sec Fixed Boundary
!> This example runs a 2 field period stellarator symmetric fixed boundary run
!> where the perturbation is applied to m=2 modes.
!>
!> @code
!> &SIESTA_INFO
!> LCOLSCALE = T
!> LADD_PERT = T
!> LRESTART = F
!> NITER = 1000
!> MPOLIN = 3
!> NTORIN = 3
!> NFPIN = 2
!> FTOL = 1.0E-20
!> levmarq_param = 1.0E-1
!> WOUT_FILE = 'wout_example.vmec.nc'
!> RESTART_EXT = 'restart_example'
!> MRES = 2,
!> HELPERT = 5.0E-4
!> /
!> @endcode
!>
!> @subsection siesta_namelist_exam_sparse_sec Fixed Boundary Sparse modes
!> This example uses sparse modes.
!>
!> @code
!> &SIESTA_INFO
!> LCOLSCALE = T
!> LADD_PERT = T
!> LRESTART = F
!> NITER = 1000
!> MPOLIN = 3
!> NTORIN = 4
!> NFPIN = 1
!> ntor_type = 'sparse'
!> ntor_modes(0) = 0
!> ntor_modes(-1) = -1
!> ntor_modes(1) = 1
!> ntor_modes(-2) = -2
!> ntor_modes(2) = 2
!> ntor_modes(-3) = -4
!> ntor_modes(3) = 4
!> FTOL = 1.0E-20
!> levmarq_param = 1.0E-1
!> WOUT_FILE = 'wout_example.vmec.nc'
!> RESTART_EXT = 'restart_example'
!> MRES = 2,
!> HELPERT = 5.0E-4
!> /
!> @endcode
!>
!> @subsection siesta_namelist_exam_free_sec Free Boundary
!> This example for a free boundary equilibrium.
!>
!> @code
!> &SIESTA_INFO
!> LCOLSCALE = T
!> LADD_PERT = T
!> LRESTART = F
!> NITER = 1000
!> MPOLIN = 3
!> NTORIN = 3
!> NFPIN = 2
!> FTOL = 1.0E-20
!> levmarq_param = 1.0E-1
!> WOUT_FILE = 'wout_example.vmec.nc'
!> RESTART_EXT = 'restart_example'
!> MRES = 2,
!> HELPERT = 5.0E-4
!> l_vessel = T
!> vessel_file = /path/to/vessel/file
!> mgrid_file = /path/to/mgrid/file
!> /
!> @endcode
!>
!> @section siesta_namelist_prog_ref_sec Programmers Reference
!> Reference material for the coding to implement this namelist is found in the
!> @ref siesta_namelist module.
Expand Down