Command Line Arguments

Table of Contents

• Introduction
• Command Line Arguments
• Programmers Reference

Introduction

This contains a description of the command line arguments. All arguments take the form of

-arg=value

Command Line Arguments

Argument

Takes Value

Discription

-h	N	Displays the help text and exits the program.
-mgridf	Y	Specify the mgrid input file name.
-woutf	Y	Specify the wout input file name.
-wvacf	Y	Specify the vacuum wout input file name.
-siestaf	Y	Specify the siesta input file name.
-outf	Y	Specify the output input file name.
-logf	Y	Write screen output to a log file.
@fixed_wdith{-jv}	N	Force balance j^v from curl derived j^u. Overrdes the -ju flag.
@fixed_wdith{-ju}	N	Force balance j^u from curl derived j^v. @item3{@fixed_wdith{-p_start}, Y, Starting phi index to compute fields. If this flag is not set, default to index 1.} @item3{@fixed_wdith{-p_end}, Y, Ending phi index to compute fields. If this flag is not set, default to the last index.}
-para	Y	Configures openmp parallelism. The value of this flag sets the maximum number of threads to use. A value of -1 uses the default. @item3{-force, N, Force override of error conditions. To prevent loss of valid data, BMW will terminate if an error condition is triggerd. This flag overrides that error potential overwritting valid data.}
-num_r	Y	Number radial points. Note not used when mgridf is specified.
-num_p	Y	Number toroidal points. Note not used when mgridf is specified.
-num_z	Y	Number vertial points. Note not used when mgridf is specified.
-rmax	Y	Maximum radial grid. Note not used when mgridf is specified.
-rmin	Y	Minimum radial grid. Note not used when mgridf is specified.
-zmax	Y	Maximum vertical grid. Note not used when mgridf is specified.
-zmin	Y	Minimum vertical grid. Note not used when mgridf is specified.

Note

OpenMP and MPI support must be configured at compile time to use. A simple way to check if support has been included is to check the command line help -h.

Programmers Reference

Reference material for the coding to implement command line parsing is found in the bmw_commandline_parser module.