This repository has been archived by the owner on Mar 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
2172: Add mutating flux-source knl fallbacks in BL r=charleskawczynski a=charleskawczynski ### Description This PR adds - `flux_first_order!` - `flux_second_order!` - and `source!` fallbacks in `BalanceLaws/`, and removes the implementation in `AtmosModel.jl`. We can also remove the implementations in the land model once #2136 lands. I guess one benefit of keeping these implementations would be for simpler debugging when we start coupling models, so I'd like to hear feedback about this idea. Co-authored-by: Charles Kawczynski <[email protected]>
- Loading branch information
Showing
5 changed files
with
147 additions
and
165 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
|
|
||
| """ | ||
| flux_first_order!( | ||
| bl::BalanceLaw, | ||
| flux::Grad, | ||
| state::Vars, | ||
| aux::Vars, | ||
| t::Real | ||
| ) | ||
| Computes (and assembles) flux terms `F¹(Y)` in: | ||
| ``` | ||
| ∂Y | ||
| -- + ∇ • F¹(Y) + ∇ • F²(Y,G) = S(Y, G), G = ∇Y | ||
| ∂t | ||
| ``` | ||
| Computes and assembles non-diffusive | ||
| fluxes in the model equations. | ||
| For this fallback to work, several methods must be defined: | ||
| - [`prognostic_vars`](@ref) | ||
| - [`eq_tends`](@ref) | ||
| - [`get_prog_state`](@ref) | ||
| optionally, | ||
| - [`precompute`](@ref) | ||
| and individual [`flux`](@ref) kernels that | ||
| are defined for each type that `eq_tends` returns. | ||
| """ | ||
| @inline function flux_first_order!( | ||
| bl::BalanceLaw, | ||
| flux, | ||
| state, | ||
| aux, | ||
| t, | ||
| direction, | ||
| ) | ||
|
|
||
| tend = Flux{FirstOrder}() | ||
| _args = (; state, aux, t, direction) | ||
| args = merge(_args, (precomputed = precompute(bl, _args, tend),)) | ||
|
|
||
| map(prognostic_vars(bl)) do prog | ||
| var, name = get_prog_state(flux, prog) | ||
| val = Σfluxes(prog, eq_tends(prog, bl, tend), bl, args) | ||
| setproperty!(var, name, val) | ||
| end | ||
| nothing | ||
| end | ||
|
|
||
| """ | ||
| flux_second_order!( | ||
| bl::BalanceLaw, | ||
| flux::Grad, | ||
| state::Vars, | ||
| diffusive::Vars, | ||
| hyperdiffusive::Vars, | ||
| aux::Vars, | ||
| t::Real | ||
| ) | ||
| Computes (and assembles) flux terms `F²(Y, G)` in: | ||
| ``` | ||
| ∂Y | ||
| -- + ∇ • F¹(Y) + ∇ • F²(Y,G) = S(Y, G), G = ∇Y | ||
| ∂t | ||
| ``` | ||
| Diffusive fluxes in BalanceLaw. Viscosity, diffusivity are calculated | ||
| in the turbulence subcomponent and accessed within the diffusive flux | ||
| function. Contributions from subcomponents are then assembled (pointwise). | ||
| For this fallback to work, several methods must be defined: | ||
| - [`prognostic_vars`](@ref) | ||
| - [`eq_tends`](@ref) | ||
| - [`get_prog_state`](@ref) | ||
| optionally, | ||
| - [`precompute`](@ref) | ||
| and individual [`flux`](@ref) kernels that | ||
| are defined for each type that `eq_tends` returns. | ||
| """ | ||
| @inline function flux_second_order!( | ||
| bl::BalanceLaw, | ||
| flux, | ||
| state, | ||
| diffusive, | ||
| hyperdiffusive, | ||
| aux, | ||
| t, | ||
| ) | ||
| tend = Flux{SecondOrder}() | ||
| _args = (; state, aux, t, diffusive, hyperdiffusive) | ||
| args = merge(_args, (precomputed = precompute(bl, _args, tend),)) | ||
|
|
||
| map(prognostic_vars(bl)) do prog | ||
| var, name = get_prog_state(flux, prog) | ||
| val = Σfluxes(prog, eq_tends(prog, bl, tend), bl, args) | ||
| setproperty!(var, name, val) | ||
| end | ||
| nothing | ||
| end | ||
|
|
||
| """ | ||
| source!( | ||
| bl::BalanceLaw, | ||
| source::Vars, | ||
| state::Vars, | ||
| diffusive::Vars, | ||
| aux::Vars, | ||
| t::Real, | ||
| direction::Direction, | ||
| ) | ||
| Computes (and assembles) source terms `S(Y)` in: | ||
| ``` | ||
| ∂Y | ||
| -- + ∇ • F¹(Y) + ∇ • F²(Y,G) = S(Y, G), G = ∇Y | ||
| ∂t | ||
| ``` | ||
| For this fallback to work, several methods must be defined: | ||
| - [`prognostic_vars`](@ref) | ||
| - [`eq_tends`](@ref) | ||
| - [`get_prog_state`](@ref) | ||
| optionally, | ||
| - [`precompute`](@ref) | ||
| and individual [`source`](@ref) kernels that | ||
| are defined for each type that `eq_tends` returns. | ||
| """ | ||
| function source!(bl::BalanceLaw, source, state, diffusive, aux, t, direction) | ||
| tend = Source() | ||
| _args = (; state, aux, t, direction, diffusive) | ||
| args = merge(_args, (precomputed = precompute(bl, _args, tend),)) | ||
|
|
||
| map(prognostic_vars(bl)) do prog | ||
| var, name = get_prog_state(source, prog) | ||
| val = Σsources(prog, eq_tends(prog, bl, tend), bl, args) | ||
| setproperty!(var, name, val) | ||
| end | ||
| nothing | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters