V3FIT
Modules List
Here is a list of all documented modules with brief descriptions:
 NbivariateThis modules contains routines for interpolating points inside a grid. This was originally written by S. P. Hirshman. It has been modified for thread safety converting it to be object oriented by M. Cianciosa
 NblocktridiagonalsolverSolver for block tri-diagonal matrices. [Kalyan S. Perumalla, ORNL, 2009-2011]
 Nblocktridiagonalsolver_sModule contains subroutines for solver for block tri-diagonal matrices
 Nbmw_commandline_parserDefines the base class of the type bmw_commandline_parser_class
 Nbmw_contextDefines the base class of the type bmw_context_class. This contains the state variables needed by BMW
 Nbmw_parallel_contextDefines the base class of the type bmw_parallel_context_class. This contains the state variables needed by BMW for parallel computation
 Nbmw_runBMW is a code for extending fields belond the VMEC domain in a manner that ensures divergence free fields. BMW does a Biot-Savart volume integration of of the equilibrium current density to obtain a continous vector potential every where on the mgrid grid
 Nbmw_state_flagsContains parameters defining the bit positions for flags that mark different options
 NcombinationDefines the base class of the type combination_class
 Ncommandline_parserDefines the base class of the type commandline_parser_class
 NcompressionDefines the base class of the type compression_class. This class contains the code and buffers to hold compressed and uncompressed data. 2D matrix data is compressed using a singular value decomposition. See del-Castillo-Negrete et. al. doi:10.1016/j.jcp.2006.07.022
 Ncoordinate_utilitiesModule is part of the LIBSTELL. This modules containes code to convert from different coordinate systems
 Ndata_parametersThis modules contains parameters used by equilibrium models
 Ndiagnostic_dotModule for opening and reading a diagnostic dot file. The file format for these files are documented in Magnetic Diagnostic Dot File
 NeceDefines the base class of the type ece_class
 Nece_dotModule for opening and reading a 'ece.' file. The file format for these files are documented in ECE Diagnostic Dot File
 NemissionDefines the base class of the type emission_class. This contains the X-Ray emission as function of temperature and energy. This needs to still be multiplied by ne^2
 NequilibriumDefines the base class of the type equilibrium_class. Equilibrium is an abstract interface to the equilibrium solver. Every method is meant to be overwritten by a subclass method with a few exceptions. For instance a vacuum equilibrium could use the default return values for equilibrium_get_ne, equilibrium_get_te and equilibrium_get_sxrem methods
 NextcurzRepresents a signal obtained by integrating around the magnetic field to get the current enclosed in the Z direction using Ampere's Law. Defines the base class of the type extcurz_class
 Nf1dim_modModule containing Fletcher-Reeves (non-linear Conjugate Gradient) routines including linear search algorithm
 NfeedbackDefines the base class of the type feedback_class
 Nfile_optsContains cross platform routines for manipulating files on the file system. Defines a functions to move, copy and delete a file that is cross platform. While, system contains a crossplatform way to call a command line commands, the command used will vary by platform
 NfourierModule contains subroutines for computing FFT on parallel radial intervals. Converts quantities between real and fourier space. Note fixarray must be called once before call any of the Fourier subroutines to calculate all necessary sine and cosine factors on a fixed mesh of collocation angles
 NfunctionsThis module containes functions used by the profiles
 Ngrid_extensionThis file contains utilities for extending the vmec grid
 Nguassian_processDefines the base class of the type guassian_process_class. The guassian_process contains code to compuet guassian process profiles
 Nintegration_pathModule is part of the LIBSTELL. This modules contains code to define and integrate along an arbitray path
 NintpolImplements interferometry/polarimetry diagnostic. Defines the base class of the type intpol_class
 Nipch_dotModule for opening and reading a 'ipch.' file. The file format for these files are documented in Inteferometry/Polarimetry Diagnostic Dot File
 Nisland_paramsThis file contains fix parameters related to the computational grids
 NlimiterDefines the base class of the type limiter_class
 Nlimiter_gridDefines the base class of the type limiter_grid_class
 Nlimiter_iso_tDefines the base class of the type limiter_iso
 Nline_segmentModule is part of the LIBSTELL. This module contains code to create a profile constructed of line sigments. These line segments are assumed to be specified such that xx(i) < xx(i + 1)
 Nm_gridDefines the base class of the type m_grid_class. This contains the state variables to define the vacuum vector potential
 NmagneticDefines the base class of the type magnetic_class
 Nmagnetic_responseDefines the base class of the type magnetic_response_class
 NmetricsModule for reading in VMEC input and computing metric elements on the SIESTA (sqrt-flux) radial grid. Computes and stores the real-space metric elements, Jacobian based on square root of fluc splined vmec coordinate system
 NmodelDefines the base class of the type model_class. The model contains information not specific to the equilibrium
 Nmodel_stateContains parameters defining the bit positions for flags that mark changes in different parts of the model
 Nmpi_incUmbrella module avoid multiple inlcudes of the mpif.h header
 NmseImplements motional stark effect diagnostic. Defines the base class of the type mse_class
 Nmse_dotModule for opening and reading a 'mse.' file. The file format for these files are documented in Motional Stark Effect Diagnostic Dot File
 NpchelmsThis file solves the helmholtz equation to set inital fields that match vmec and vacuum currents from the vector potential. Initial vector potential on the edge is supplied by the BMW code
 Npprofile_tDefines the base class of the type pprofile_class. This module contains all the code necessary to define parameterized profiles
 Nprimed_gridDefines the base class of the type primed_grid_class. This contains the state variables to define the currents and positions of the volumn integral
 Nprior_gaussianDefines the base class of the type prior_gaussian_class. This class implements priors of the type
 NprofilerDefines functions for measuring an tabulating performance of function and subroutine calls. These routines are only active when the PROFILE_ON macro is defined
 NquantitiesThis file contains subroutines for allocating and initializing curvilinear magnetic covariant and pressure Fourier harmonics on the half-radial mesh
 NreconstructionDefines the base class of the type reconstruction_class. This class contains the minimization algorithm
 Nrestart_modContains routines for writting the restart file
 Nshared_dataThis file contains variables and parameters used by many modules in SIESTA
 Nshared_functionsModule contained subroutines and functions updating MHD forces and Wmhd
 Nsiesta_bfieldThis file contains subroutines for updating half-grid magnetic fields
 Nsiesta_contextDefines the base class of the type siesta_context_class. This contains the state variables needed by SIESTA
 Nsiesta_currentsTakes the Curl(B) to return the contravariant current density. Contravariant components of the magnetic field must be converted to covariant components first
 Nsiesta_equilibriumDefines the base class of the type siesta_class. This module contains all the code necessary to interface V3FIT with SIESTA
 Nsiesta_errorThis module contains all the code needed to define error
 Nsiesta_fileDefines the base class of the type siesta_file_class. This contains the output of a siesta equilibrium
 Nsiesta_forceCompute the JxB - Grad(p) covariant force components. The plasma is in equilibrium when the force of the magnetic pressure balances the plasma pressure
 Nsiesta_initInitializes unperturbed siesta fields and pressure in real space
 Nsiesta_namelistThis file contains all the variables and maximum sizes of the inputs for a SIESTA namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs
 Nsiesta_pressureUpdates pressure
 Nsiesta_stateThis file contains subroutines for aupdating from t to t + delta_t the magnetic field and pressure as part of the SIESTA project. Stores updated values of JPMN*H, JBSUBXMN*H in Quantities Module
 NsignalDefines the base class of the type signal_class
 Nsignal_dotDefines the base class of type signal_dot_file. This module contains common code used in parsing diagnostic dot files. The actual parsing of the diagnostic dot file is handled by ipch_dot, thscte_dot and sxrch_dot
 Nsxrch_dotModule for opening and reading a 'sxrch.' file. The file format for these files are documented in Soft X-Ray Diagnostic Dot File
 NsxremDefines the base class of the type sxrem_class
 Nsxrem_ratioDefines a feedback signal based on the temperature based on the ration of the soft x-ray emissivity profile. This signal feeds back the temperature profile at a specified positon
 Nsxrem_ratio_dotModule for opening and reading a 'sxrem_ratio.' file. The file format for these files are documented in Soft X-ray Emissivity Ratio Dot File
 NthomsonImplements thomson scattering diagnostic. Defines the base class of the type thomson_class
 Nthscte_dotModule for opening and reading a 'thscte.' file. The file format for these files are documented in Thomson Scattering Diagnostic Dot File
 Nunprimed_gridDefines the base class of the type unprimed_grid_class. This contains the state variables to define the currents and positions of the volumn integral
 Nv3fit_contextDefines a v3fit_context_class object to contain all the memory for running v3fit. Contains methods to write memory to disk
 Nv3fit_inputThis file contains all the variables and maximum sizes of the inputs for a v3fit namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a V3FIT task should be copied to a v3fit_context object. All non-parameters are inputs to the namelist input file
 Nv3fit_paramsDefines the base class of the type param_class
 Nv3rfun_contextDefines a v3rfun_context_class object to contain all the memory for running v3rfun
 Nv3rfun_inputThis file contains all the variables and maximum sizes of the inputs for a V3RFUN namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a V3RFUN task should be copied to a v3rfun_context object. All non-parameters are inputs to the namelist input file
 Nvacuum_equilibriumDefines the base class of the type vacuum_class. This module contains all the code necessary to interface V3FIT with a vacuum equilibrium
 Nvacuum_inputThis file contains all the variables and maximum sizes of the inputs for a vacuum namelist input file. The module contained within does not represent an object instance. Instead all variables are contained in a global context. This is required due to limitations of FORTRAN 95 and namelist inputs. Any information needed by a vacuum equilibrium should be copied to a vacuum_equilibrium object. All non-parameters are inputs to the namelist input file
 Nvmec_contextDefines the base class of the type vmec_context_class. This contains the state variables needed by VMEC
 Nvmec_equilibriumDefines the base class of the type vmec_class. This module contains all the code necessary to interface V3FIT with VMEC