space_grid_mod Module Reference

Functions/Subroutines
subroutine, public	initialize_space_grid_mod (mpi_env, input)
	Initializes the space_grid_mod module. More...
subroutine	set_xgrid (mpi_env)
	Initialize x (radial) grid. More...
subroutine	set_ygrid (mpi_env)
	Initialize y (poloidal) grid. More...
subroutine	set_zgrid (mpi_env)
	Initialize z (toroidal) grid. More...
subroutine	set_boundary_corners
	Set border boundary condition indices. More...

Variables
real(dp), public, protected	lx = 10._dp
	Radial length. More...
real(dp), public, protected	x_periodic_end = -10000_dp
	Field line poloidal periodicity. More...
integer, public, protected	nxp
	Number of points in x direction. More...
integer, public, protected	nyp
	Number of points in y direction. More...
integer, public, protected	nzp
	Number of points in z direction. More...
integer, public	izsp
integer, public	izep
integer, public	nzpp
integer, public, protected	ixsg
integer, public, protected	ixeg
integer, public, protected	ixlg
integer, public, protected	ixrg
integer, public, protected	iysg
integer, public, protected	iyeg
integer, public, protected	iylg
integer, public, protected	iyrg
integer, public, protected	izsg
integer, public, protected	izeg
integer, public, protected	izlg
integer, public, protected	izrg
integer, public, protected	ix1
integer, public, protected	ix2
integer, public	nx2d
integer, public	nx1d
integer, public, protected	iy1
integer, public, protected	iy2
integer, public	ny2d
integer, public	ny1d
integer, public, protected	ix_min
real(dp), public, protected	deltax
real(dp), public, protected	deltaxi
real(dp), public, protected	deltaxih
real(dp), public, protected	deltaxisq
real(dp), public, protected	deltay
real(dp), public, protected	deltayi
real(dp), public, protected	deltayih
real(dp), public, protected	deltayisq
real(dp), public, protected	shiftgr_v = 0.5_dp
real(dp), public, protected	deltaz
real(dp), public, protected	deltazi
real(dp), public, protected	deltazisq
real(dp), public, protected	deltaai
real(dp), public, protected	deltaaih
real(dp), public, protected	deltaaisq
real(dp), dimension(:), pointer, public, protected	xarray
real(dp), dimension(:), pointer, public, protected	yarray
real(dp), dimension(:), pointer, public, protected	zarray
real(dp), dimension(:), pointer, public	cos_tht
real(dp), dimension(:), pointer, public	sin_tht
integer, public, protected	iyshift
integer, public, protected	iyshift_d
integer, public, protected	iyshift_u
integer, public, protected	ny_top
integer, public, protected	ny_bot
integer, public, protected	ny_topu
integer, public, protected	ny_botu
integer, public, protected	ny_topd
integer, public, protected	ny_botd
integer, public, protected	ny_zg
integer, public	neq
integer, public, protected	ixs_bc
integer, public, protected	ixe_bc
integer, public, protected	iys_bc
integer, public, protected	iye_bc
integer, public, protected	ixl_bc
integer, public, protected	ixr_bc
integer, public, protected	iyl_bc
integer, public, protected	iyr_bc
Indices for the arrays storing the spatial grids
Indices to start and end of local and global grids: s -> start, e-> end (local) l -> left , r-> right (global)
integer, public, protected	ixs
	Staring index in the x direction. More...
integer, public, protected	ixe
	Ending index in the x direction. More...
integer, public, protected	ixl
	Staring index in the x direction. More...
integer, public, protected	ixr
	Ending index in the x direction. More...
integer, public, protected	iys
	Staring index in the y direction. More...
integer, public, protected	iye
	Ending index in the y direction. More...
integer, public, protected	iyl
	Staring index in the y direction. More...
integer, public, protected	iyr
	Ending index in the y direction. More...
integer, public, protected	iyr_ngrid
	Staring index in the x direction. More...
integer, public, protected	izs
	Staring index in the z direction. More...
integer, public, protected	ize
	Ending index in the z direction. More...
integer, public, protected	izl
	Staring index in the z direction. More...
integer, public, protected	izr
	Ending index in the z direction. More...
integer, public, protected	nzgc = 1
	Number of ghost cells. More...
integer, public, protected	nygc = 1
	Number of ghost cells. More...
integer, public, protected	nxgc = 1
	Number of ghost cells. More...

Function/Subroutine Documentation

initialize_space_grid_mod()

subroutine, public space_grid_mod::initialize_space_grid_mod	(	type(tmpienv), intent(in)	mpi_env,
		type(tinputenv), intent(in)	input
	)

Initializes the space_grid_mod module.

Here is the call graph for this function:

Here is the caller graph for this function:

set_boundary_corners()

subroutine space_grid_mod::set_boundary_corners

Set border boundary condition indices.

Here is the caller graph for this function:

set_xgrid()

subroutine space_grid_mod::set_xgrid

(

type(tmpienv), intent(in)

mpi_env

)

Initialize x (radial) grid.

Here is the call graph for this function:

Here is the caller graph for this function:

set_ygrid()

subroutine space_grid_mod::set_ygrid

(

type(tmpienv), intent(in)

mpi_env

)

Initialize y (poloidal) grid.

Here is the call graph for this function:

Here is the caller graph for this function:

set_zgrid()

subroutine space_grid_mod::set_zgrid

(

type(tmpienv), intent(in)

mpi_env

)

Initialize z (toroidal) grid.

Refactor:

This should be checked at the beginning of the run

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

cos_tht

real(dp), dimension(:), pointer, public space_grid_mod::cos_tht

deltaai

real(dp), public, protected space_grid_mod::deltaai

deltaaih

real(dp), public, protected space_grid_mod::deltaaih

deltaaisq

real(dp), public, protected space_grid_mod::deltaaisq

deltax

real(dp), public, protected space_grid_mod::deltax

deltaxi

real(dp), public, protected space_grid_mod::deltaxi

deltaxih

real(dp), public, protected space_grid_mod::deltaxih

deltaxisq

real(dp), public, protected space_grid_mod::deltaxisq

deltay

real(dp), public, protected space_grid_mod::deltay

deltayi

real(dp), public, protected space_grid_mod::deltayi

deltayih

real(dp), public, protected space_grid_mod::deltayih

deltayisq

real(dp), public, protected space_grid_mod::deltayisq

deltaz

real(dp), public, protected space_grid_mod::deltaz

deltazi

real(dp), public, protected space_grid_mod::deltazi

deltazisq

real(dp), public, protected space_grid_mod::deltazisq

ix1

integer, public, protected space_grid_mod::ix1

ix2

integer, public, protected space_grid_mod::ix2

ix_min

integer, public, protected space_grid_mod::ix_min

ixe

integer, public, protected space_grid_mod::ixe

Ending index in the x direction.

ixe_bc

integer, public, protected space_grid_mod::ixe_bc

ixeg

integer, public, protected space_grid_mod::ixeg

ixl

integer, public, protected space_grid_mod::ixl

Staring index in the x direction.

ixl_bc

integer, public, protected space_grid_mod::ixl_bc

ixlg

integer, public, protected space_grid_mod::ixlg

ixr

integer, public, protected space_grid_mod::ixr

Ending index in the x direction.

ixr_bc

integer, public, protected space_grid_mod::ixr_bc

ixrg

integer, public, protected space_grid_mod::ixrg

ixs

integer, public, protected space_grid_mod::ixs

Staring index in the x direction.

ixs_bc

integer, public, protected space_grid_mod::ixs_bc

ixsg

integer, public, protected space_grid_mod::ixsg

iy1

integer, public, protected space_grid_mod::iy1

iy2

integer, public, protected space_grid_mod::iy2

iye

integer, public, protected space_grid_mod::iye

Ending index in the y direction.

iye_bc

integer, public, protected space_grid_mod::iye_bc

iyeg

integer, public, protected space_grid_mod::iyeg

iyl

integer, public, protected space_grid_mod::iyl

Staring index in the y direction.

iyl_bc

integer, public, protected space_grid_mod::iyl_bc

iylg

integer, public, protected space_grid_mod::iylg

iyr

integer, public, protected space_grid_mod::iyr

Ending index in the y direction.

iyr_bc

integer, public, protected space_grid_mod::iyr_bc

iyr_ngrid

integer, public, protected space_grid_mod::iyr_ngrid

Staring index in the x direction.

iyrg

integer, public, protected space_grid_mod::iyrg

iys

integer, public, protected space_grid_mod::iys

Staring index in the y direction.

iys_bc

integer, public, protected space_grid_mod::iys_bc

iysg

integer, public, protected space_grid_mod::iysg

iyshift

integer, public, protected space_grid_mod::iyshift

iyshift_d

integer, public, protected space_grid_mod::iyshift_d

iyshift_u

integer, public, protected space_grid_mod::iyshift_u

ize

integer, public, protected space_grid_mod::ize

Ending index in the z direction.

izeg

integer, public, protected space_grid_mod::izeg

izep

integer, public space_grid_mod::izep

izl

integer, public, protected space_grid_mod::izl

Staring index in the z direction.

izlg

integer, public, protected space_grid_mod::izlg

izr

integer, public, protected space_grid_mod::izr

Ending index in the z direction.

izrg

integer, public, protected space_grid_mod::izrg

izs

integer, public, protected space_grid_mod::izs

Staring index in the z direction.

izsg

integer, public, protected space_grid_mod::izsg

izsp

integer, public space_grid_mod::izsp

lx

real(dp), public, protected space_grid_mod::lx = 10._dp

Radial length.

neq

integer, public space_grid_mod::neq

nx1d

integer, public space_grid_mod::nx1d

nx2d

integer, public space_grid_mod::nx2d

nxgc

integer, public, protected space_grid_mod::nxgc = 1

Number of ghost cells.

nxp

integer, public, protected space_grid_mod::nxp

Number of points in x direction.

ny1d

integer, public space_grid_mod::ny1d

ny2d

integer, public space_grid_mod::ny2d

ny_bot

integer, public, protected space_grid_mod::ny_bot

ny_botd

integer, public, protected space_grid_mod::ny_botd

ny_botu

integer, public, protected space_grid_mod::ny_botu

ny_top

integer, public, protected space_grid_mod::ny_top

ny_topd

integer, public, protected space_grid_mod::ny_topd

ny_topu

integer, public, protected space_grid_mod::ny_topu

ny_zg

integer, public, protected space_grid_mod::ny_zg

nygc

integer, public, protected space_grid_mod::nygc = 1

Number of ghost cells.

nyp

integer, public, protected space_grid_mod::nyp

Number of points in y direction.

nzgc

integer, public, protected space_grid_mod::nzgc = 1

Number of ghost cells.

nzp

integer, public, protected space_grid_mod::nzp

Number of points in z direction.

nzpp

integer, public space_grid_mod::nzpp

shiftgr_v

real(dp), public, protected space_grid_mod::shiftgr_v = 0.5_dp

sin_tht

real(dp), dimension(:), pointer, public space_grid_mod::sin_tht

x_periodic_end

real(dp), public, protected space_grid_mod::x_periodic_end = -10000_dp

Field line poloidal periodicity.

xarray

real(dp), dimension(:), pointer, public, protected space_grid_mod::xarray

yarray

real(dp), dimension(:), pointer, public, protected space_grid_mod::yarray

zarray

real(dp), dimension(:), pointer, public, protected space_grid_mod::zarray