x_vars::x_2_type Type Reference

tensorial perturbation type More...

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

Public Attributes
integer, dimension(2)	n_mod
	size of \(n\) and \(m\) (nr. of modes)
integer, dimension(2, 2)	lim_sec_x
	limits of m_X (pol. flux) or n_X (tor. flux)
integer, dimension(:,:), allocatable	n_1
	vector of toroidal mode numbers of dimension 1
integer, dimension(:,:), allocatable	n_2
	vector of toroidal mode numbers of dimension 2
integer, dimension(:,:), allocatable	m_1
	vector of poloidal mode numbers of dimension 1
integer, dimension(:,:), allocatable	m_2
	vector of poloidal mode numbers of dimension 2
complex(dp), dimension(:,:,:,:), allocatable	pv_0
	\(\widetilde{PV}^0\) coefficient
complex(dp), dimension(:,:,:,:), allocatable	pv_1
	\(\widetilde{PV}^1\) coefficient
complex(dp), dimension(:,:,:,:), allocatable	pv_2
	\(\widetilde{PV}^2\) coefficient
complex(dp), dimension(:,:,:,:), allocatable	kv_0
	\(\widetilde{KV}^0\) coefficient
complex(dp), dimension(:,:,:,:), allocatable	kv_1
	\(\widetilde{KV}^1\) coefficient
complex(dp), dimension(:,:,:,:), allocatable	kv_2
	\(\widetilde{KV}^2\) coefficient
real(dp)	estim_mem_usage
	estimated memory usage

Detailed Description

tensorial perturbation type

The arrays here are of the form:

• PV_i and KV_i: (1:angle_1,1:angle_2,1;n_mod^2)

See also

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

Note

This type is also used for field-averaged tensorial perturbation variables, with angle_1 of size 1.

Definition at line 81 of file X_vars.f90.

Member Function/Subroutine Documentation

copy()

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

copy

Parameters

[in]	x_i	X_2 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 101 of file X_vars.f90.

dealloc()

procedure x_vars::x_2_type::dealloc

(

class(x_2_type), intent(inout)

x

)

deallocate

Parameters

[in,out]

x

perturbation variables to be deallocated

Definition at line 103 of file X_vars.f90.

init()

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

initialize

See also

See init_X_1().

Note

The tensorial perturbation type can also be used for field-aligned variables, in which case the first index is assumed to have dimension 1 only. This can be triggered using is_field_averaged. There is no difference between a tensorial perturbation type with size of first dimension set to one through the use of this flag, or through other means.

Parameters

[in,out]	x	tensorial 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) for both dimensions
[in]	is_field_averaged	if field-aligned, only one dimension for first index

Definition at line 99 of file X_vars.f90.

Member Data Documentation

estim_mem_usage

real(dp) x_vars::x_2_type::estim_mem_usage

estimated memory usage

Note

Debug version only

Definition at line 95 of file X_vars.f90.

kv_0

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_2_type::kv_0

\(\widetilde{KV}^0\) coefficient

Definition at line 91 of file X_vars.f90.

kv_1

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_2_type::kv_1

\(\widetilde{KV}^1\) coefficient

Definition at line 92 of file X_vars.f90.

kv_2

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_2_type::kv_2

\(\widetilde{KV}^2\) coefficient

Definition at line 93 of file X_vars.f90.

lim_sec_x

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

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

Definition at line 83 of file X_vars.f90.

m_1

integer, dimension(:,:), allocatable x_vars::x_2_type::m_1

vector of poloidal mode numbers of dimension 1

Definition at line 86 of file X_vars.f90.

m_2

integer, dimension(:,:), allocatable x_vars::x_2_type::m_2

vector of poloidal mode numbers of dimension 2

Definition at line 87 of file X_vars.f90.

n_1

integer, dimension(:,:), allocatable x_vars::x_2_type::n_1

vector of toroidal mode numbers of dimension 1

Definition at line 84 of file X_vars.f90.

n_2

integer, dimension(:,:), allocatable x_vars::x_2_type::n_2

vector of toroidal mode numbers of dimension 2

Definition at line 85 of file X_vars.f90.

n_mod

integer, dimension(2) x_vars::x_2_type::n_mod

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

Definition at line 82 of file X_vars.f90.

pv_0

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_2_type::pv_0

\(\widetilde{PV}^0\) coefficient

Definition at line 88 of file X_vars.f90.

pv_1

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_2_type::pv_1

\(\widetilde{PV}^1\) coefficient

Definition at line 89 of file X_vars.f90.

pv_2

complex(dp), dimension(:,:,:,:), allocatable x_vars::x_2_type::pv_2

\(\widetilde{PV}^2\) coefficient

Definition at line 90 of file X_vars.f90.

---

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

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