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

If no -arg= is found, then the -file is implied. In other words, a command line of

xv3fit input.file

is the same as

xv3fit -file=input.file

Command Line Arguments

Argument

Takes Value

Discription

-h	N	Displays the help text and exits the program.
-d	N	Use the default namelist input file. The default input filename is v3fit.in.
-file	Y	Specify the v3fit namelist input file.
-test	N	Overwrites the v3fit_input::my_task variable and runs the internal unit tests instead.
-force	N	Forces the equilibrium to re-solve on every reconstruction parameter
-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.
-out	N	Writes out the input file for each reconstruction step.
-c	Y	Compress magnetic response functions using the cutoff.
-c_diff	N	Use central differencing to compute the Jacobian.
-serial	N	Run the reconstruction serially and with parallel equilibria.
-restart	Y	Specify v3fit to restart from the provided result file. Must have the last valid wout and/or siesta restart file.

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 commandline_parser module.