Public Member Functions
type(vmec_class) function, pointer	vmec_construct_eq (file_name, wout_file_name, iou, eq_comm, recon_comm, state_flags)
	Construct a vmec_class object. More...

type(vmec_class) function, pointer	vmec_construct_full (file_name, wout_file_name, ne, te, ti, ze, sxrem, phi_offset, z_offset, pol_rad_ratio, iou, eq_comm, recon_comm, state_flags)
	Construct a vmec_class object. More...

Detailed Description

Interface for the construction of vmec_class types using vmec_construct_full or vmec_construct_eq.

Definition at line 448 of file vmec_equilibrium.f.

Member Function/Subroutine Documentation

type (vmec_class) function, pointer vmec_equilibrium::vmec_construct::vmec_construct_eq	(	character (len=*), intent(in)	file_name,
		character (len=*), intent(in)	wout_file_name,
		integer, intent(in)	iou,
		integer, intent(in)	eq_comm,
		integer, intent(in)	recon_comm,
		integer, intent(inout)	state_flags
	)

Construct a vmec_class object.

Allocates memory and initializes a vmec_class object. Runs vmec for one iteration to initialize all the input parameters. Defined in vmec_input.

Parameters

[in]	file_name	Filename of the vmec namelist input file.
[in]	wout_file_name	Filename of the vmec wout input file.
[in]	iou	Input/output unit to log messages to.
[in]	eq_comm	MPI communicator pool for VMEC.
[in]	recon_comm	MPI communicator pool for reconstruction.
[in,out]	state_flags	Bitwise flags to indicate which parts of the model changed.

Definition at line 587 of file vmec_equilibrium.f.

type (vmec_class) function, pointer vmec_equilibrium::vmec_construct::vmec_construct_full	(	character (len=*), intent(in)	file_name,
		character (len=*), intent(in)	wout_file_name,
		type (pprofile_class), pointer	ne,
		type (pprofile_class), pointer	te,
		type (pprofile_class), pointer	ti,
		type (pprofile_class), pointer	ze,
		type (pprofile_pointer), dimension(:), pointer	sxrem,
		real (rprec), intent(in)	phi_offset,
		real (rprec), intent(in)	z_offset,
		real (rprec), intent(in)	pol_rad_ratio,
		integer, intent(in)	iou,
		integer, intent(in)	eq_comm,
		integer, intent(in)	recon_comm,
		integer, intent(inout)	state_flags
	)

Construct a vmec_class object.

Allocates memory and initializes a vmec_class object. Runs vmec for one iteration to initialize all the input parameters. Defined in vmec_input.

Parameters

[in]	file_name	Filename of the vmec namelist input file.
[in]	wout_file_name	Filename of the vmec wout input file.
[in]	ne	pprofile_T for the electron density.
[in]	te	pprofile_T for the electron temperature.
[in]	ti	pprofile_T for the ion temperature.
[in]	ze	pprofile_T for Z effective.
[in]	sxrem	pprofile_T for the soft x-ray emissivity.
[in]	phi_offset	Initial phi offset of the plasma relative to the diagnostics in radians.
[in]	z_offset	Initial Z offset of the plasma relative to the machine center.
[in]	pol_rad_ratio	Ratio of poloidal grid to radial grid. Defines the gird sizes when computing magnetic diagnostics.
[in]	iou	Input/output unit to log messages to.
[in]	eq_comm	MPI communicator pool for VMEC.
[in]	recon_comm	MPI communicator pool for reconstruction.
[in,out]	state_flags	Bitwise flags to indicate which parts of the model changed.

Definition at line 789 of file vmec_equilibrium.f.

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