shared_data Module Reference

This file contains variables and parameters used by many modules in SIESTA. More...

Variables
integer, parameter	ngmres_steps = 100
	Max number of gmres steps (10-100) should scale with ns.
integer, parameter	prediag = 1
	Diagonal preconditioning flag.
integer, parameter	preblock = 2
	Block preconditioning flag.
real(dp), parameter	fsq_res = 1.E-16_dp
	Threshold force for turning off resistive perturbations.
real(dp), parameter	levm_ped = 1.E-10_dp
	FIXME: UNKNOWN.
real(dp), parameter	mu_ped = 1.E-8_dp
	Pedestal value of levenberg/mu. Should be between 10^-5 and 10^-10.
integer, parameter	gmres_peak = 2
	GMRES peak improvement.
integer, parameter	gmres_no_peak = 1
	GMRES no_peak improvement.
integer, parameter	unit_out = 336
	File output io unit.
logical, parameter	l_pedge = .true.
	Preserve s=1 as iso-pressure surface.
logical, parameter	l_natural = .TRUE.
	Natural boundry condition flag.
integer	neqs
	Number of elements in the xc array.
integer	ndims
	Number of independent variables.
integer	niter
	Total number of iteration to run.
integer	mblk_size
	Block size. (mpol + 1)*(2*ntor + 1)*ndims.
integer	nsp
	Total radial grid size in the VMEC region.
integer	nprecon
	Preconditioner flag.
integer	nprecon_type
	Preconditioner type.
integer	ngmres_type = gmres
	GMRES control flag.
integer	iortho = 3
	Orthogonalization in GMRES.
integer	hesspass_test = -1
	Dump block and data files for testing.
integer	in_hess_nfunct
	FIXME UNKNOWN.
integer	out_hess_nfunct
	FIXME UNKNOWN.
real(dp)	mupar_test
	FIXME UNKNOWN.
real(dp)	fsq_total
	|F|^2 WITH column scaling.
real(dp)	fsq_total1
	|F|^2 WITHOUT column scaling.
real(dp), dimension(:), allocatable	xc
	1D array of Fourier mode displacement components.
real(dp), dimension(:), allocatable, target	gc
	1D Array of Fourier mode MHD force components
real(dp), dimension(:), allocatable, target	gc_sup
	1D Array of Fourier mode MHD force components, FIXME Check if this is really needed.
real(dp), dimension(:,:,:), allocatable	buv_res
	Resonant magnetic field perturbation.
real(dp), dimension(:), allocatable	xc0
	Saved fouier displacements.
real(dp), dimension(:), allocatable	gc0
	Saved fouier MHD forces.
real(dp), dimension(:,:,:,:), allocatable	col_scale
	Column scaling factors.
real(dp)	fsq_gmres
	|F|^2 for GMRES iterations.
real(dp)	fsq_lin
	Linear |F|^2.
real(dp)	etak_tol
	FIXME: UNKNOWN.
real(dp)	levm_scale = 1
	FIXME: UNKNOWN.
real(dp)	wtotal
	MHD energy sum of magnetic and thermal.
real(dp)	wtotal0
	Saved MHD energy sum of magnetic and thermal.
real(dp)	delta_t
	Time step.
real(dp)	fsqvs
	|F|^2 for s components.
real(dp)	fsqvu
	|F|^2 for u components.
real(dp)	fsqvv
	|F|^2 for v components.
real(dp), dimension(4)	ste
	Spectral Truncation RMS error,.
real(dp), dimension(12)	bs0
	FIXME: UNKNOWN.
real(dp), dimension(12)	bu0
	FIXME: UNKNOWN.
real(dp)	bsbu_ratio_s
	FIXME: UNKNOWN.
real(dp)	jsju_ratio_s
	FIXME: UNKNOWN.
real(dp)	bsbu_ratio_a
	FIXME: UNKNOWN.
real(dp)	jsju_ratio_a
	FIXME: UNKNOWN.
real(dp)	scale_s
	FIXME: UNKNOWN.
real(dp)	scale_u
	FIXME: UNKNOWN.
real(dp), dimension(:,:,:), allocatable	r1_i
	R coordinates of the computational grid.
real(dp), dimension(:,:,:), allocatable	z1_i
	Z coordinates of the computational grid.
real(dp), dimension(:,:,:), allocatable	ru_i
	dR/du coordinates of the computational grid.
real(dp), dimension(:,:,:), allocatable	zu_i
	dZ/du coordinates of the computational grid.
real(dp), dimension(:,:,:), allocatable	rv_i
	dR/dv coordinates of the computational grid.
real(dp), dimension(:,:,:), allocatable	zv_i
	dZ/dv coordinates of the computational grid.
real(dp)	jsupvdota
	FIXME: UNKNOWN.
real(dp), dimension(:,:,:), pointer	asubsmnsf
	Covariant vector potential for stellator symmetric s component on full grid.
real(dp), dimension(:,:,:), pointer	asubsmncf
	Covariant vector potential for non-stellator symmetric s component on full grid.
real(dp), dimension(:,:,:), pointer	asubumncf
	Covariant vector potential for stellator symmetric u component on full grid.
real(dp), dimension(:,:,:), pointer	asubumnsf
	Covariant vector potential for non-stellator symmetric u component on full grid.
real(dp), dimension(:,:,:), pointer	asubvmncf
	Covariant vector potential for stellator symmetric v component on full grid.
real(dp), dimension(:,:,:), pointer	asubvmnsf
	Covariant vector potential for non-stellator symmetric v component on full grid.
logical	l_push_edge
	Solve u,v components at s=1.
logical	l_push_s
	Solve for s component at origin.
logical	l_push_u
	Solve for u component at origin.
logical	l_push_v
	Solve for v component at origin.
logical	l_linearize
	Use linearized forces.
logical	l_conjgrad
	FIXME: UNKNOWN.
logical	l_getwmhd
	Compute MHD energy.
logical	l_getfsq
	Compute |F|^2.
logical	l_applyprecon
	Apply preconditioner.
logical	l_printoriginforces = .false.
	Print forces at the origin.
logical	l_init_state
	Store initial field/pressure state.
logical	l_update_state = .false.
	Update the ste array.
logical	l_par_state
	Parallel allocated quantities? FIXME: check this.
logical	lcolscale
	Apply column scaling to hessian.
logical	lasym = .false.
	Use non-stellarator symmetry.
logical	lrecon = .false.
	Output extra information to the restart file that will be used by V3FIT. @DEPRICATED.
logical	lverbose = .true.
	Use verbose screen output.
logical	lequi1 = .true.
	Equilibrate matrix with col 1-norm.
real(dp)	siesta_curtor = 0.0
	Total toroidal current.

Detailed Description

This file contains variables and parameters used by many modules in SIESTA.

Variable Documentation

col_scale

real(dp), dimension(:,:,:,:), allocatable shared_data::col_scale

Column scaling factors.

column scaling factor

iortho

integer shared_data::iortho = 3

Orthogonalization in GMRES.

• 3 ICGS (Recommended)
• 2 CGS
• 1 IMGS
• 0 MGS FIXME: Make this a parameter.

l_natural

logical, parameter shared_data::l_natural = .TRUE.

Natural boundry condition flag.

• True Use natural bc at s=0 (preferred: maintains symmetry)
• False Evolves all forces at origin.

ndims

integer shared_data::ndims

Number of independent variables.

• 3 Stellarator symmetry.
• 6 Stellarator symmetry.

ngmres_type

integer shared_data::ngmres_type = gmres

GMRES control flag.

• gmres_peak
• gmres_no_peak