ORB5  4.00
Loading...
Searching...
No Matches
fields_mod::field_type Type Reference

Field data structure. More...

Public Attributes

real(kind=r8), dimension(:,:,:), allocatable bspl
 B-spline coefficients in real space.
complex(kind=r8), dimension(:,:), allocatable rhs_f
 Right-hand-side of solver in Fourier space.
integer, dimension(:), allocatable need_field
 Is the field needed for each species? (evaluated at guiding center positions).
integer, dimension(:), allocatable need_grad_field
 Is the field gradient needed for each species? (evaluated at guiding center positions).
integer, dimension(:), allocatable need_gyro_field
 Is the gyro-averaged field needed for each species?
integer, dimension(:), allocatable need_gyro_grad_field
 Is the gyro-averaged field gradient needed for each species? (or gradient of gyro-averaged field if nl_gradgyr==.true.).
integer, dimension(:), allocatable field_pic
 Index to access field in guiding center attribute arrays.
integer, dimension(:), allocatable grad_field_pic
 Index to access field gradient in guiding center attribute arrays (add 1 to access radial component, 2 for poloidal, and 3 for toroidal).
integer, dimension(:), allocatable gyro_field_pic
 Index to access gyro-averaged field in guiding center attribute arrays.
integer, dimension(:), allocatable gyro_grad_field_pic
 Index to access gyro-averaged field gradient in guiding center attribute arrays (add 1 to access radial component, 2 for poloidal, and 3 for toroidal).

Detailed Description

Field data structure.

Member Data Documentation

◆ bspl

real(kind=r8), dimension(:,:,:), allocatable fields_mod::field_type::bspl

B-spline coefficients in real space.

◆ field_pic

integer, dimension(:), allocatable fields_mod::field_type::field_pic

Index to access field in guiding center attribute arrays.

◆ grad_field_pic

integer, dimension(:), allocatable fields_mod::field_type::grad_field_pic

Index to access field gradient in guiding center attribute arrays (add 1 to access radial component, 2 for poloidal, and 3 for toroidal).

◆ gyro_field_pic

integer, dimension(:), allocatable fields_mod::field_type::gyro_field_pic

Index to access gyro-averaged field in guiding center attribute arrays.

◆ gyro_grad_field_pic

integer, dimension(:), allocatable fields_mod::field_type::gyro_grad_field_pic

Index to access gyro-averaged field gradient in guiding center attribute arrays (add 1 to access radial component, 2 for poloidal, and 3 for toroidal).

◆ need_field

integer, dimension(:), allocatable fields_mod::field_type::need_field

Is the field needed for each species? (evaluated at guiding center positions).

  • -1 : not needed
  • 0 : needed every substep
  • n>0 : needed every n time step

◆ need_grad_field

integer, dimension(:), allocatable fields_mod::field_type::need_grad_field

Is the field gradient needed for each species? (evaluated at guiding center positions).

  • -1 : not needed
  • 0 : needed every substep
  • n>0 : needed every n time step

◆ need_gyro_field

integer, dimension(:), allocatable fields_mod::field_type::need_gyro_field

Is the gyro-averaged field needed for each species?

  • -1 : not needed
  • 0 : needed every substep
  • n>0 : needed every n time step

◆ need_gyro_grad_field

integer, dimension(:), allocatable fields_mod::field_type::need_gyro_grad_field

Is the gyro-averaged field gradient needed for each species? (or gradient of gyro-averaged field if nl_gradgyr==.true.).

  • -1 : not needed
  • 0 : needed every substep
  • n>0 : needed every n time step

◆ rhs_f

complex(kind=r8), dimension(:,:), allocatable fields_mod::field_type::rhs_f

Right-hand-side of solver in Fourier space.

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