GitHub

API Reference

Base

CHEASE.write_EXPEQ_file — Function
write_EXPEQ_file(
    ϵ::Float64,
    z_axis::Float64,
    pressure_sep::Float64,
    r_center::Float64,
    Bt_center::Float64,
    Ip::Float64,
    r_bound::Vector{Float64},
    z_bound::Vector{Float64},
    mode::Int,
    rho_pol::Vector{Float64},
    pressure::Vector{Float64},
    j_tor::Vector{Float64})

Writes a EXPEQ file for CHEASE given the above arrays and scalars

source
CHEASE.write_chease_namelist — Function
write_chease_namelist(
    Bt_center::Float64,
    r_center::Float64,
    Ip::Float64,
    r_bound::Vector{Float64},
    z_bound::Vector{Float64};
    rescale_eq_to_ip::Bool=false,
    extra_box_fraction::Float64=0.33)

Writes the chease namelist to the current folder

source
CHEASE.read_chease_output — Function
read_chease_output(filename::String)

Reads gEQDSK output filename from CHEASE using the EFIT.jl package and returns an MXHEquilibrium object

source
CHEASE.run_chease — Function
run_chease(
    ϵ::Float64,
    z_axis::Float64,
    pressure_sep::Float64,
    Bt_center::Float64,
    r_geo::Float64,
    Ip::Float64,
    r_bound::Vector{Float64},
    z_bound::Vector{Float64},
    mode::Integer,
    rho_psi::Union{Missing,Vector{Float64}},
    pressure::Vector{Float64},
    j_tor::Vector{Float64};
    rescale_eq_to_ip::Bool=false,
    clear_workdir::Bool,
    extra_box_fraction::Float64=0.33)

This function executes chease given the above set-up and handles the file-io

Returns an EFITEquilibrium struct (see MXHEquilibrium/src/efit.jl)

The rescaleeqtoip option rescales the equilibrium to match Ip given (this is useful when using CHEASE from nothing where jtor is madeup)

source

IO