V3FIT
Public Member Functions | List of all members
magnetic_response::magnetic_response_construct Interface Reference

Interface for the construction of magnetic_response_class types using magnetic_response_construct_new, & magnetic_response_construct_point or & magnetic_response_construct_netcdf. More...

Public Member Functions

type(magnetic_response_class) function, pointer magnetic_response_construct_new (name, date, coil_id, inductance, current_scale, num_t, num_t_shell, rmin, rmax, zmin, zmax, n_field_periods, stell_sym, a_r, a_f, a_z, a_s_r, a_s_f, a_s_z, svd_cut_off)
 Construct a magnetic_response_class object. More...
 
type(magnetic_response_class) function, pointer magnetic_response_construct_point (name, date, coil_id, position, direction, vacuum, current_scale)
 Construct a magnetic_response_class object. More...
 
type(magnetic_response_class) function, pointer magnetic_response_construct_netcdf (mdsig_iou, svd_cut_off)
 Construct a magnetic_response_class object. More...
 

Detailed Description

Interface for the construction of magnetic_response_class types using magnetic_response_construct_new, & magnetic_response_construct_point or & magnetic_response_construct_netcdf.

Definition at line 216 of file magnetic_response.f.

Member Function/Subroutine Documentation

◆ magnetic_response_construct_netcdf()

type (magnetic_response_class) function, pointer magnetic_response::magnetic_response_construct::magnetic_response_construct_netcdf ( integer, intent(in)  mdsig_iou,
real (rprec), intent(in)  svd_cut_off 
)

Construct a magnetic_response_class object.

Allocates memory and initializes a magnetic_response_class object from a mdsig file.

Parameters
[in]mdsig_iouAn instance of a the netcdf id of the open mdsig file.
[in]svd_cut_offCutoff on singular values for data compression.
Returns
A pointer to a constructed magnetic_response_class object.

Definition at line 489 of file magnetic_response.f.

◆ magnetic_response_construct_new()

type (magnetic_response_class) function, pointer magnetic_response::magnetic_response_construct::magnetic_response_construct_new ( character (len=*), intent(in)  name,
character (len=*), intent(in)  date,
character (len=*), intent(in)  coil_id,
real (rprec), dimension(:), pointer  inductance,
real (rprec), dimension(:), pointer  current_scale,
integer, intent(in)  num_t,
integer, intent(in)  num_t_shell,
real (rprec), intent(in)  rmin,
real (rprec), intent(in)  rmax,
real (rprec), intent(in)  zmin,
real (rprec), intent(in)  zmax,
integer, intent(in)  n_field_periods,
logical, intent(in)  stell_sym,
real (rprec), dimension(:,:,:), pointer  a_r,
real (rprec), dimension(:,:,:), pointer  a_f,
real (rprec), dimension(:,:,:), pointer  a_z,
real (rprec), dimension(:,:), pointer  a_s_r,
real (rprec), dimension(:,:), pointer  a_s_f,
real (rprec), dimension(:,:), pointer  a_s_z,
real (rprec), intent(in)  svd_cut_off 
)

Construct a magnetic_response_class object.

Allocates memory and initializes a magnetic_response_class object.

Parameters
[in]nameName of the code which computed the responses.
[in]dateData and time the code was run.
[in]coil_idIdenifier of field-coils.
[in]inductanceArray of diagnostic field-coil-group responses.
[in]current_scaleArray of external current scales.
[in]num_tNumber of phi planes per field period in plasma grid.
[in]num_t_shellNumber of phi planes per field period in the conducting shell grid.
[in]rminMinimum R for plasma grid.
[in]rmaxMaximum R for plasma grid.
[in]zminMinimum z for plasma grid.
[in]zmaxMaximum z for plasma grid.
[in]n_field_periodsNumber of field periods.
[in]stell_symUse stellarator symmetry.
[in]a_rR component of plasma response function.
[in]a_fPhi component of plasma response function.
[in]a_zZ component of plasma response function.
[in]a_s_rR component of the conducting shell response function.
[in]a_s_fPhi component of the conducting shell response function.
[in]a_s_zZ component of the conducting shell response function.
[in]svd_cut_offCutoff on singular values for data compression.
Returns
A pointer to a constructed magnetic_response_class object.

Definition at line 267 of file magnetic_response.f.

◆ magnetic_response_construct_point()

type (magnetic_response_class) function, pointer magnetic_response::magnetic_response_construct::magnetic_response_construct_point ( character (len=*), intent(in)  name,
character (len=*), intent(in)  date,
character (len=*), intent(in)  coil_id,
real (rprec), dimension(3)  position,
real (rprec), dimension(3)  direction,
real (rprec), dimension(:), pointer  vacuum,
real (rprec), dimension(:), pointer  current_scale 
)

Construct a magnetic_response_class object.

Allocates memory and initializes a magnetic_response_class object.

Parameters
[in]nameName of the code which computed the responses.
[in]dateData and time the code was run.
[in]coil_idIdenifier of field-coils.
[in]positionPosition of the point measurement.
[in]directionDirection of the point measurement.
[in]vacuumArray of diagnostic vacuum responses.
[in]current_scaleArray of external current scales.
Returns
A pointer to a constructed magnetic_response_class object.

Definition at line 413 of file magnetic_response.f.


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