![]() |
Stellarator-Tools
|
This contains a description of the command line arguments. All arguments take the form of
-arg=value
| Argument | Takes Value | Discription |
| -h | N | Displays the help text and exits the program. |
| -wout_file | Y | Specify the wout input file name. |
| -restart_file | Y | Specify the restart input file name. |
| -test_name | Y | Name of the test to run. |
| -tol | Y | Tolarance value. |
| -min | Y | Minimum radial value. |
| -max | Y | Maximum radial value. |
| -relative | N | Use relative error. |
| -dump | N | Dump values to the screen. |
| -u | Y | Poloidal angle to dump. |
| -v | Y | Toroidal angle to dump. |
| test | Check a test profile of a known function. |
| r | Check profiles of r. |
| z | Check profiles of z. |
| drdu | Check profiles of drdu. |
| drdv | Check profiles of drdv. |
| dzdu | Check profiles of dzdu. |
| dzdv | Check profiles of dzdv. |
| phipf | Check profiles of phipf. |
| chipf | Check profiles of chipf. |
| bsups | Check profiles of bsups. |
| bsupu | Check profiles of bsupu. |
| bsupv | Check profiles of bsupv. |
| bsubs | Check profiles of bsubs. |
| bsubu | Check profiles of bsubu. |
| bsubv | Check profiles of bsubv. |
| jbsups | Check profiles of jbsups. |
| jbsupu | Check profiles of jbsupu. |
| jbsupv | Check profiles of jbsupv. |
| jksups | Check profiles of jksups. |
| jksupu | Check profiles of jksupu. |
| jksupv | Check profiles of jksupv. |
| jacobian | Check profiles of the jacobian. |
| curtor | Check total toroidal current. |
| vmec_divb | Check vmec diveregence of B. |
| siesta_divb | Check siesta diveregence of B. |
| pressure | Check profiles of pressure. |
Reference material for the coding to implement command line parsing is found in the commandline_parser class.