Skip to content

sawteeth_source!: exclude_indexes keyword #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
StuartBenjamin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

sawteeth_source!: exclude_indexes keyword #321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
457d112
sawteeth_source!: exclude_indexes keyword
StuartBenjamin Oct 13, 2026
4e3f43c
Merge remote-tracking branch 'origin/master' into sawteeth_flatten_bo…
StuartBenjamin Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions src/physics/sources.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,52 +566,54 @@ push!(document[Symbol("Physics sources")], :total_radiation_sources)


"""
sawteeth_source!(dd::IMAS.DD; qmin_desired::Union{Float64, Nothing}=nothing, flat_factor::Real=0.5)
sawteeth_source!(dd::IMAS.DD; qmin_desired::Union{Float64, Nothing}=nothing, flat_factor::Real=0.5, exclude_indexes::AbstractVector{Int}=IMASdd.index_no_sawtooth)

Model sawteeth by flattening all sources where abs(q) drops below qmin_desired.

- `qmin_desired`: Safety factor threshold for sawteeth inversion. If `nothing`, uses
`dd.sawteeth.diagnostics.rho_tor_norm_inversion` if available, otherwise falls back to `1.0`
- `flat_factor`: Relaxation factor for flattening, from 0.0 (no change) to 1.0 (full flattening)
- `exclude_indexes`: Source indexes that are not flattened (default: those that come from profiles, not external drive)
"""
function sawteeth_source!(dd::IMAS.DD; qmin_desired::Union{Float64, Nothing}=nothing, flat_factor::Real=0.5)
function sawteeth_source!(dd::IMAS.DD; qmin_desired::Union{Float64, Nothing}=nothing, flat_factor::Real=0.5, exclude_indexes::AbstractVector{Int}=IMASdd.index_no_sawtooth)

if qmin_desired === nothing
if !ismissing(dd.sawteeth.diagnostics, :rho_tor_norm_inversion)
rho0 = @ddtime(dd.sawteeth.diagnostics.rho_tor_norm_inversion)
return sawteeth_source!(dd, rho0; flat_factor)
return sawteeth_source!(dd, rho0; flat_factor, exclude_indexes)
else
return sawteeth_source!(dd; qmin_desired=1.0, flat_factor)
return sawteeth_source!(dd; qmin_desired=1.0, flat_factor, exclude_indexes)
end
else
cp1d = dd.core_profiles.profiles_1d[]

# update core_sources with sawteeth
i_qdes = findlast(q -> (abs(q) < qmin_desired), cp1d.q)
#rho_qdes = (i_qdes === nothing) ? 0.0 : cp1d.grid.rho_tor_norm[i_qdes]
return sawteeth_source!(dd, i_qdes; flat_factor)
return sawteeth_source!(dd, i_qdes; flat_factor, exclude_indexes)
end
end

function sawteeth_source!(dd::IMAS.DD{T}, ::Nothing; flat_factor::Real=0.5) where {T<:Real}
function sawteeth_source!(dd::IMAS.DD{T}, ::Nothing; flat_factor::Real=0.5, exclude_indexes::AbstractVector{Int}=IMASdd.index_no_sawtooth) where {T<:Real}
# no inversion radius, so call with rho0 = 0.0
return sawteeth_source!(dd, 0.0; flat_factor)
return sawteeth_source!(dd, 0.0; flat_factor, exclude_indexes)
end

function sawteeth_source!(dd::IMAS.DD{T}, i_qdes::Int; flat_factor::Real=0.5) where {T<:Real}
function sawteeth_source!(dd::IMAS.DD{T}, i_qdes::Int; flat_factor::Real=0.5, exclude_indexes::AbstractVector{Int}=IMASdd.index_no_sawtooth) where {T<:Real}
cp1d = dd.core_profiles.profiles_1d[]
return sawteeth_source!(dd, cp1d.grid.rho_tor_norm[i_qdes]; flat_factor)
return sawteeth_source!(dd, cp1d.grid.rho_tor_norm[i_qdes]; flat_factor, exclude_indexes)
end

"""
sawteeth_source!(dd::IMAS.DD{T}, rho0::T; flat_factor::Real=0.5) where {T<:Real}
sawteeth_source!(dd::IMAS.DD{T}, rho0::T; flat_factor::Real=0.5, exclude_indexes::AbstractVector{Int}=IMASdd.index_no_sawtooth) where {T<:Real}

Model sawteeth by flattening all sources within the inversion radius rho0

- `rho0`: Normalized toroidal flux coordinate of the inversion radius
- `flat_factor`: Relaxation factor for flattening (0 = no change, 1 = full flattening)
- `exclude_indexes`: Source indexes that are not flattened (default: those that come from profiles, not external drive)
"""
function sawteeth_source!(dd::IMAS.DD{T}, rho0::T; flat_factor::Real=0.5) where {T<:Real}
function sawteeth_source!(dd::IMAS.DD{T}, rho0::T; flat_factor::Real=0.5, exclude_indexes::AbstractVector{Int}=IMASdd.index_no_sawtooth) where {T<:Real}
@assert rho0 <= 1.0
cp1d = dd.core_profiles.profiles_1d[]

Expand All @@ -638,7 +640,7 @@ function sawteeth_source!(dd::IMAS.DD{T}, rho0::T; flat_factor::Real=0.5) where
# identify sawteeth inversion radius
if rho0 > 0.0
# exclude sources that come from profiles, not external drive
total_source1d = total_sources(dd.core_sources, cp1d; time0=dd.global_time, exclude_indexes=IMASdd.index_no_sawtooth)
total_source1d = total_sources(dd.core_sources, cp1d; time0=dd.global_time, exclude_indexes)
fill!(source1d, total_source1d)
else
# this will return an empty source
Expand Down