x_ops::print_output_x Interface Reference

Print either vectorial or tensorial perturbation quantities of a certain order to an output file. More...

Public Member Functions
integer function	print_output_x_1 (grid_X, X, data_name, rich_lvl, par_div, lim_sec_X)
	vectorial version. More...
integer function	print_output_x_2 (grid_X, X, data_name, rich_lvl, par_div, lim_sec_X, is_field_averaged)
	tensorial version More...

Detailed Description

Print either vectorial or tensorial perturbation quantities of a certain order to an output file.

• vectorial:
  • U
  • DU
• tensorial:
  • PV_int
  • KV_int

(The non-integrated variables are not saved because they are heavy and not requested.)

If rich_lvl is provided, "_R_[rich_lvl]" is appended to the data name if it is >0.

Optionally, it can be specified that this is a divided parallel grid, corresponding to the variable eq_jobs_lims with index eq_job_nr. In this case, the total grid size is adjusted to the one specified by eq_jobs_lims and the grid is written as a subset.

Note

1. The equilibrium quantities are outputted in Flux coordinates.
2. 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.

Returns

ierr

Definition at line 85 of file X_ops.f90.

Member Function/Subroutine Documentation

print_output_x_1()

integer function x_ops::print_output_x::print_output_x_1	(	type(grid_type), intent(in)	grid_X,
		type(x_1_type), intent(in)	X,
		character(len=*), intent(in)	data_name,
		integer, intent(in), optional	rich_lvl,
		logical, intent(in), optional	par_div,
		integer, dimension(2), intent(in), optional	lim_sec_X
	)

vectorial version.

Parameters

[in]	grid_x	perturbation grid variables
[in]	x	vectorial perturbation variables
[in]	data_name	name under which to store
[in]	rich_lvl	Richardson level to print
[in]	par_div	is a parallely divided grid
[in]	lim_sec_x	limits of m_X (pol. flux) or n_X (tor. flux)

Definition at line 411 of file X_ops.f90.

Here is the call graph for this function:

print_output_x_2()

integer function x_ops::print_output_x::print_output_x_2	(	type(grid_type), intent(in)	grid_X,
		type(x_2_type), intent(in)	X,
		character(len=*), intent(in)	data_name,
		integer, intent(in), optional	rich_lvl,
		logical, intent(in), optional	par_div,
		integer, dimension(2,2), intent(in), optional	lim_sec_X,
		logical, intent(in), optional	is_field_averaged
	)

tensorial version

Parameters

[in]	grid_x	perturbation grid variables
[in]	x	tensorial perturbation variables
[in]	data_name	name under which to store
[in]	rich_lvl	Richardson level to print
[in]	par_div	is a parallely divided grid
[in]	lim_sec_x	limits of m_X (pol. flux) or n_X (tor. flux)
[in]	is_field_averaged	whether field-averaged, so only one dimension for first index

Definition at line 603 of file X_ops.f90.

Here is the call graph for this function:

---

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

• /opt/PB3D/Modules/X_ops.f90