x_vars::set_nm_x Interface Reference

Sets n_X and m_X. More...

Public Member Functions
subroutine	set_nm_x_1 (mds, grid_X, lim_sec_X_o, n_X_loc, m_X_loc, lim_sec_X_i)
	vectorial version More...
subroutine	set_nm_x_2 (mds, grid_X, lim_sec_X_o, n_X_1, m_X_1, n_X_2, m_X_2, lim_sec_X_i)
	tensorial version More...

Detailed Description

Sets n_X and m_X.

By default, this is done using by default global X_vars variables but optionally different limits for the secondary mode numbers (m_X for poloidal flux or n_X for toroidal flux).

Note

n_X and m_X need to have been set up with the same limits as the grid used here. This is done in setup_nm_X().

Definition at line 116 of file X_vars.f90.

Member Function/Subroutine Documentation

set_nm_x_1()

subroutine x_vars::set_nm_x::set_nm_x_1	(	type(modes_type), intent(in)	mds,
		type(grid_type), intent(in)	grid_X,
		integer, dimension(2), intent(inout)	lim_sec_X_o,
		integer, dimension(:,:), intent(inout), allocatable	n_X_loc,
		integer, dimension(:,:), intent(inout), allocatable	m_X_loc,
		integer, dimension(2), intent(in), optional	lim_sec_X_i
	)

vectorial version

Parameters

[in]	mds	general modes variables
[in]	grid_x	perturbation grid
[in,out]	lim_sec_x_o	limits on secondary mode numbers
[in,out]	n_x_loc	toroidal mode numbers
[in,out]	m_x_loc	poloidal mode numbers
[in]	lim_sec_x_i	optional limits on secondary mode numbers

Definition at line 145 of file X_vars.f90.

set_nm_x_2()

subroutine x_vars::set_nm_x::set_nm_x_2	(	type(modes_type), intent(in)	mds,
		type(grid_type), intent(in)	grid_X,
		integer, dimension(2,2), intent(inout)	lim_sec_X_o,
		integer, dimension(:,:), intent(inout), allocatable	n_X_1,
		integer, dimension(:,:), intent(inout), allocatable	m_X_1,
		integer, dimension(:,:), intent(inout), allocatable	n_X_2,
		integer, dimension(:,:), intent(inout), allocatable	m_X_2,
		integer, dimension(2,2), intent(in), optional	lim_sec_X_i
	)

tensorial version

Parameters

[in]	mds	general modes variables
[in]	grid_x	perturbation grid
[in,out]	lim_sec_x_o	limits on secondary mode numbers
[in,out]	n_x_1	toroidal mode numbers for dimension 1
[in,out]	m_x_1	poloidal mode numbers for dimension 1
[in,out]	n_x_2	toroidal mode numbers for dimension 2
[in,out]	m_x_2	poloidal mode numbers for dimension 2
[in]	lim_sec_x_i	optional limits on secondary mode numbers

Definition at line 169 of file X_vars.f90.

---

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

• /opt/PB3D/Modules/X_vars.f90