Skip to content

plot_tok_geo.m

Basic Information

  USAGE:  plot_tok_geo(tok_data_struct,options,equil_data)

    Examples:
        plot_tok_geo(tok_data_struct,options,east_system.equil_data)
        plot_tok_geo(tok_data_struct,options,psizr)

  PURPOSE: Plot the basic tokamak geometry.

  INPUTS: [default]
    tok_data_struct = structure containing tokamak geometry data
    options = structure containing any of the following options:
    iblackbg = flag: 0= white figure background, [1]=black figure background
       ipltpsi  = flag: 1= contour equilibrium psizr, >1= #contours to plot
                (default = 1 if psizr exists, else 0)
       ipltrho  = flag  1= contour equilibrium normalized rho surfaces, >1= #contours to plot
       ipltB    = flag: 1= contour equilibrium |B|, >1= #contours to plot [0]
       ipltJ    = flag: 1= contour equilibrium jphi, >1= #contours to plot [0]
     (Only one of ipltpsi, iltrho, ipltB, ipltJ may be specified; all need equil_data.)

   ipltfc   = flag; 1= plot the f-coils [1]
   ipltvv   = flag; 1= plot the vacuum vessel elements [1]
    ipltlim  = flag: 1= plot limiter switch [1]
    ipltfl   = flag: 1= plot Flux Loops [0]
    ipltbp   = flag: 1= plot B-Probe indices [0]
    ipltgap  = flag: 1= plot gap locations [0]
    ilabeleq = flag: 1= contour label flux values [0]
    ilabelfc = flag: 1= label PF's with indices,
                       >1 => use name labels, with fontsize=ilabelfc [0]
    ilabelcc = flag: 1= label PF coil STATES with indices (cannot also set ilabelfc)
       Pcc      = matrix that computes PF currents from states (required if ilabelcc=1)
    ilabelvv = flag: 1= label VV elements with indices [0]
    ilabelfl = flag: 1= label FL's with indices [0]
                       >1 => use name labels, with fontsize=ilabelfl [0]
    ilabelbp = flag: 1= label BP's with indices,
                       >1 => use name labels, with fontsize=ilabelbp [0]
    ilabelgap= flag: 1= label gaps with indices [0]
    idxvv    = indices of vacuum vessel to plot (default = all)
    idxfl    = indices of flux loops to plot (default all, used only if ipltfl)
    idxbp    = indices of Bprobes to plot (default all, used only if ipltbp)
    vvgroup  = grouping vector for vacuum vessel elements, used only if
            ilabelvv=1 to define vessel element labels
       ileftright: bit 1 = plot left side, bit 0 = plot right side (default)
    equil_data  = equilibrium psizr from EFIT OR structure containing
          psizr and psibnd (e.g. equil_data in *_system struct
          produced by build_*_sys.m script.

  OUTPUTS:
    Plot of tokamak geometry