eq_ops::print_output_eq Interface Reference

Print equilibrium quantities to an output file: More...

Public Member Functions
integer function	print_output_eq_1 (grid_eq, eq, data_name)
	flux version More...
integer function	print_output_eq_2 (grid_eq, eq, data_name, rich_lvl, par_div, dealloc_vars)
	metric version More...

Detailed Description

Print equilibrium quantities to an output file:

• flux:
  • pres_FD,
  • q_saf_FD,
  • rot_t_FD,
  • flux_p_FD,
  • flux_t_FD,
  • rho,
  • S,
  • kappa_n,
  • kappa_g,
  • sigma
• metric:
  • g_FD,
  • h_FD,
  • jac_FD

If rich_lvl is provided, "_R_[rich_lvl]" is appended to the data name if it is >0 (only for eq_2).

Optionally, for eq_2, 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 metric equilibrium quantities can be deallocated on the fly, which is useful if this routine is followed by a deallocation any way, so that memory usage does not almost double.
3. print_output_eq_2 is only used by HELENA now, as for VMEC it is too slow since there are often multiple VMEC equilibrium jobs, while for HELENA this is explicitely forbidden.

Returns

ierr

Definition at line 90 of file eq_ops.f90.

Member Function/Subroutine Documentation

print_output_eq_1()

integer function eq_ops::print_output_eq::print_output_eq_1	(	type(grid_type), intent(in)	grid_eq,
		type(eq_1_type), intent(in)	eq,
		character(len=*), intent(in)	data_name
	)

flux version

Parameters

[in]	grid_eq	equilibrium grid variables
[in]	eq	flux equilibrium variables
[in]	data_name	name under which to store

Definition at line 2275 of file eq_ops.f90.

Here is the call graph for this function:

print_output_eq_2()

integer function eq_ops::print_output_eq::print_output_eq_2	(	type(grid_type), intent(in)	grid_eq,
		type(eq_2_type), intent(inout)	eq,
		character(len=*), intent(in)	data_name,
		integer, intent(in), optional	rich_lvl,
		logical, intent(in), optional	par_div,
		logical, intent(in), optional	dealloc_vars
	)

metric version

Parameters

[in]	grid_eq	equilibrium grid variables
[in,out]	eq	metric equilibrium 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]	dealloc_vars	deallocate variables on the fly after writing

Definition at line 2408 of file eq_ops.f90.

Here is the call graph for this function:

---

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

• /opt/PB3D/Modules/eq_ops.f90