Skip to content

make_predictors.m

Basic Information

  USAGE:  predictors = make_predictors(predictor_inputs)

  PURPOSE: Script to construct plasma geometry predictors from standard
        environment inputs. Intended to be generic to any standard
        tokamak system environment.Called from scripts such as
        make_east_predictors or make_kstar_predictors.

  INPUTS:  (in structure "predictor_inputs")
    tok_data_struct = vacuum geometry objects structure for the device
       efit_gfile_test = gfile to use (for testing of predictors only)
       tokamak = machine name, eg 'KSTAR', 'EAST', (needed for read_gfile_tok)
       idxbpr = index vector to select desired probes for R-predictors
       idxbpz = index vector to select desired probes for Z-predictors
       idxbpip = index vector to select desired probes for Ip-predictors
       idxbpk = index vector to select desired probes for kappa-predictors
       idxflr = index vector to select desired flux loops for R-predictors
       idxflz = index vector to select desired flux loops for Z-predictors
       idxflip = index vector to select desired flux loops for Ip-predictors
       idxflk = index vector to select desired flux loops for kappa-predictors
    idxc = PF coil index vector for fitting/testing with EFIT
    idxv = VV index vector for testing with VV currents
       rrange1 = maj radius range of sub-grid for predictor 1 (m) eg [1.5 2]
       zrange1 = vert range of sub-grid for predictor 1 (m) eg [-.5 .5]
       iusejphi = flag to use jphi (all current) region for fits
       efit_gfile_grid = gfile to use to define grid from jphi if iusejphi=1
       nprtst = # of princ comp of grid to mag set to use in test
       nsvdz2 = # of sing vals to keep in R pred inverse (for P*pred1,2)
       nsvdr2 = # of sing vals to keep in R pred inverse
       nsvdi2 = # of sing vals to keep in Ip pred inverse
    nsvdk1 = # of sing vals to keep in Kappa pred inverse
    nrs
    nzs
    nkaps
    nls
    Rmin,Rmax
    Zmin,Zmax
    kapmin,kapmax
    limin,limax
    amax
    Z1,Z2
    R1,R2
    cctest
    icomppfr
    icomppfz
    icomppfip
    icomppfk

  OUTPUTS: (in structure "predictors")
    Pzpred = Z-predictor (Pzpred*[mag]/Ip0 = predicted Z)
    Prpred = R-predictor (Prpred*[mag]/Ip0 + Rrel = predicted R)
    Pipred = Ip-predictor (Pipred*[Bprobes] = predicted Ip)
    Pkpred = kappa-predictor (Pkpred*[mag]/Ip0??? = predicted kappa)
    Rpred
    Zpred
    Ippred
    Kpred
    + many  plots evaluating quality of predictors

  RESTRICTIONS:
    Specified objects file must provide units desired in predictor (eg
    if want predictor based on mks, must use mks object file). Comments
    in code assume MA-based objects (eg east_objects.mat), but should
    be consistent with mks/terminal choice if use those object files).
     If iusejphi==1, must have efit_gfile_grid defined (which is source of
       jphi on which grid is based if iusejphi=1)

  METHOD:
    Variety of inversions of grid-to-mag objects, linear fits to selected
    data from subgrids, subset of magnetics...

Dependencies