V_FIELD_3D Derived Type

type, public :: V_FIELD_3D

This KORC type represents a 3-D vector field varible in cylindrical coordinates. For example, this could be the 3-D magnetic field, which can be written as All the members (components) of the V_FIELD_3D type follow the following index convention: ( index, index, index)


Inherited by

type~~v_field_3d~~InheritedByGraph type~v_field_3d V_FIELD_3D type~fields FIELDS type~fields->type~v_field_3d E_3D, B_3D, dBdR_3D, dBdPHI_3D, dBdZ_3D, gradB_3D, curlb_3D

Contents

Source Code


Components

TypeVisibility AttributesNameInitial
real(kind=rp), public, DIMENSION(:,:,:), ALLOCATABLE:: R

component of the vector field variable.

real(kind=rp), public, DIMENSION(:,:,:), ALLOCATABLE:: PHI

component of the vector field variable.

real(kind=rp), public, DIMENSION(:,:,:), ALLOCATABLE:: Z

component of the vector field variable.


Source Code

  TYPE, PUBLIC :: V_FIELD_3D
     !! @note KORC 3-D vector field type @endnote
     !! This KORC type represents a 3-D vector field varible in
     !! cylindrical coordinates. For example, this could be the 3-D magnetic
     !! field, which can be written as $$\mathbf{B}(R,\phi,Z) = B_R(R,\phi,Z)
     !! \hat{R} + B_\phi(R,\phi,Z) \hat{\phi} + B_Z(R,\phi,Z) \hat{Z}.$$
     !! All the members (components) of the V_FIELD_3D type follow the
     !! following index convention:
     !! (\(R\) index,\(\phi\) index, \(Z\) index)

     REAL(rp), DIMENSION(:,:,:), ALLOCATABLE :: R 
     !! \(R\) component of the vector field variable.
     REAL(rp), DIMENSION(:,:,:), ALLOCATABLE :: PHI 
     !! \(\phi\) component of the vector field variable.
     REAL(rp), DIMENSION(:,:,:), ALLOCATABLE :: Z 
     !! \(Z\) component of the vector field variable.
  END TYPE V_FIELD_3D