x_vars::x_1_type Type Reference

vectorial perturbation type More...

Public Member Functions
procedure	init (x, mds, grid_x, lim_sec_x)
	initialize
procedure	copy (x_i, mds, grid_i, x_o)
	copy
procedure	dealloc (x)
	deallocate

Public Attributes
integer	n_mod
	size of \(n\) and \(m\) (nr. of modes)
integer, dimension(2)	lim_sec_x
	limits of m_X (pol. flux) or n_X (tor. flux)
integer, dimension(:,:), allocatable	n
	vector of poloidal mode numbers
integer, dimension(:,:), allocatable	m
	vector of poloidal mode numbers
complex(dp), dimension(:,:,:,:), allocatable	u_0
	\(U_m^0\)
complex(dp), dimension(:,:,:,:), allocatable	u_1
	\(U_m^1\)
complex(dp), dimension(:,:,:,:), allocatable	du_0
	\(\mathcal{J}\vec{B}\cdot\nabla U_m^0\)
complex(dp), dimension(:,:,:,:), allocatable	du_1
	\(\mathcal{J}\vec{B}\cdot\nabla U_m^1\)
real(dp)	estim_mem_usage
	estimated memory usage

Detailed Description

vectorial perturbation type

The arrays here are of the form:

• U_x_i and DU_X_i: (1:angle_1,1:angle_2,1;n_mod)

See also

See grid_vars.grid_type for a discussion on ang_1 and ang_2.

Definition at line 51 of file X_vars.f90.

Member Function/Subroutine Documentation

copy()

procedure x_vars::x_1_type::copy	(	class(x_1_type), intent(in)	x_i,
		type(modes_type), intent(in)	mds,
		type(grid_type), intent(in)	grid_i,
		type(x_1_type), intent(inout)	x_o )

copy

Parameters

[in]	x_i	X_1 to be copied
[in]	mds	general modes variables
[in]	grid_i	grid of eq_i
[in,out]	x_o	copied X_1

Definition at line 67 of file X_vars.f90.

dealloc()

procedure x_vars::x_1_type::dealloc

(

class(x_1_type), intent(inout)

x

)

deallocate

Parameters

[in,out]

x

perturbation variables to be deallocated

Definition at line 69 of file X_vars.f90.

init()

procedure x_vars::x_1_type::init	(	class(x_1_type), intent(inout)	x,
		type(modes_type), intent(in)	mds,
		type(grid_type), intent(in)	grid_x,
		integer, dimension(2), intent(in), optional	lim_sec_x )

initialize

Allocates the variables, the number of modes, as well as n and m .

Optionally, the secondary mode numbers can be specified (m if poloidal flux is used and n if toroidal flux). By default, they are taken from the global X_vars variables.

Note

If the lowest limits of the grid is not 1 (e.g. grid_soli_min = 1 for first process), the input variable i_min should be set to set correctly. For a full grid, it should be set to 1.

Parameters

[in,out]	x	vectorial perturbation variables
[in]	mds	general modes variables
[in]	grid_x	perturbation grid
[in]	lim_sec_x	limits of m_X (pol. flux) or n_X (tor. flux)

Definition at line 65 of file X_vars.f90.

Member Data Documentation

du_0

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_1_type::du_0

\(\mathcal{J}\vec{B}\cdot\nabla U_m^0\)

Definition at line 58 of file X_vars.f90.

du_1

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_1_type::du_1

\(\mathcal{J}\vec{B}\cdot\nabla U_m^1\)

Definition at line 59 of file X_vars.f90.

estim_mem_usage

real(dp) x_vars::x_1_type::estim_mem_usage

estimated memory usage

Note

Debug version only

Definition at line 61 of file X_vars.f90.

lim_sec_x

integer, dimension(2) x_vars::x_1_type::lim_sec_x

limits of m_X (pol. flux) or n_X (tor. flux)

Definition at line 53 of file X_vars.f90.

m

integer, dimension(:,:), allocatable x_vars::x_1_type::m

vector of poloidal mode numbers

Definition at line 55 of file X_vars.f90.

n

integer, dimension(:,:), allocatable x_vars::x_1_type::n

vector of poloidal mode numbers

Definition at line 54 of file X_vars.f90.

n_mod

integer x_vars::x_1_type::n_mod

size of \(n\) and \(m\) (nr. of modes)

Definition at line 52 of file X_vars.f90.

u_0

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_1_type::u_0

\(U_m^0\)

Definition at line 56 of file X_vars.f90.

u_1

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_1_type::u_1

\(U_m^1\)

Definition at line 57 of file X_vars.f90.

---

The documentation for this type was generated from the following file:

• /Users/toonweyens/Code/PB3D/Modules/X_vars.f90