Stellarator-Tools
v3rfun_input Module Reference

This 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. More...

Functions/Subroutines

subroutine v3rfun_input_read_namelist (namelist_file)
 Reads the namelist input file. More...
 

Variables

integer, parameter v3rfun_file_length = 120
 Filename length.
 
integer, parameter v3rfun_name_length = 25
 Name length.
 
character(len=v3rfun_file_lengthname_coils_dot = ''
 Filename for the field coils.
 
character(len=v3rfun_file_lengthname_diagnostic_dot = ''
 Filename for the diagnostic coils.
 
character(len=v3rfun_name_lengthidrfun = ''
 v3rfun identification for the run.
 
logical lstell_sym = .false.
 Control for stellarator symmetry.
 
logical l_read_coils_dot = .true.
 Control to ignore the coils dot file.
 
logical use_con_shell = .false.
 Computes the response function for a conducting shell.
 
integer ir = 101
 Number of radial grid points.
 
integer jz = 101
 Number of vertical grid points.
 
integer kp = 1
 Number of toroidal grid points.
 
integer kp_shell = 1
 Number of shell toroidal grid points.
 
integer n_field_periods_nli = 0
 Number of field periods.
 
real(rprec) rmin = 0.0
 Minimum R for plasma grid.
 
real(rprec) rmax = 0.0
 Maximum R for plasma grid.
 
real(rprec) zmin = 0.0
 Minimum Z for plasma grid.
 
real(rprec) zmax = 0.0
 Maximum Z for plasma grid.
 
real(rprec) major_radius = 0.0
 Shell major radius for shell grid.
 
real(rprec) minor_radius = 0.0
 Shell minor radius for shell grid.
 
real(rprec) len_integrate_ddc = 0.001
 Integration length in meters.
 
logical, dimension(nigroup) is_super_con = .false.
 Tag super conducting coils.
 
real(rprec), dimension(nigroup, 3) cg_shift_1 = 0.0
 Vector to shift all the coils before rotation.
 
real(rprec), dimension(nigroup, 3) cg_shift_2 = 0.0
 Vector to shift all the coils after rotation.
 
real(rprec), dimension(nigroup, 3) cg_rot_xcent = 0.0
 Position of center of rotation.
 
real(rprec), dimension(nigroup) cg_rot_theta = 0.0
 Spherical polar angle to specify axis of rotation.
 
real(rprec), dimension(nigroup) cg_rot_phi = 0.0
 Spherical azimuthal angle to specify axis of rotation.
 
real(rprec), dimension(nigroup) cg_rot_angle = 0.0
 Angle to rotate about axis of rotation. Left hand convention. Put left thumb along axis of rotation, fingers indicate direction of positive rotation.
 
logical, dimension(nigroup) l_rot_coil_center = .true.
 Controls the center of rotation. More...
 

Detailed Description

This 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.

Namelist v3r_coils definition

Note
Some of the references are missing here. This is due to a bug in Doxygen when variable decalarations span multiple lines.

Function/Subroutine Documentation

◆ v3rfun_input_read_namelist()

subroutine v3rfun_input::v3rfun_input_read_namelist ( character (len=*), intent(in)  namelist_file)

Reads the namelist input file.

Reads the namelist input file. V3RFUN currently requires no processing of the namelist input.

Parameters
[in]namelist_fileThe file name of the namelist input file.

Variable Documentation

◆ l_rot_coil_center

logical, dimension(nigroup) v3rfun_input::l_rot_coil_center = .true.

Controls the center of rotation.

  • True Use current-averaged center of coil-group for center of rotation.
  • False Use position specified in cg_rot_xcent for center of rotation.