-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #128 from gaelforget/v0p3p6e
add FaIR module, increase coverage
- Loading branch information
Showing
10 changed files
with
631 additions
and
9 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,109 @@ | ||
|
|
||
| module ClimateModelsOceananigansExt | ||
|
|
||
| using Oceananigans, ClimateModels | ||
| import ClimateModels: JLD2, @printf, Oceananigans_launch | ||
| import ClimateModels: Oceananigans_setup_grid, Oceananigans_setup_BC | ||
| import ClimateModels: Oceananigans_build_model, Oceananigans_build_simulation | ||
|
|
||
| import Oceananigans.Units: minute, minutes, hour | ||
|
|
||
| function Oceananigans_setup_grid(Nz=50,Lz=50) | ||
| #Nz = 50 # number of points in the vertical direction | ||
| #Lz = 50 # (m) domain depth | ||
| fz(k)=-Lz*(Nz+1-k)/Nz #fz.(1:Nz+1) gives the vertical grid for w points | ||
| return RectilinearGrid(size = (32, 32, Nz), x = (0, 64), y = (0, 64), z = fz) | ||
| end | ||
|
|
||
| function Oceananigans_setup_BC(Qʰ,u₁₀,Ev) | ||
| dTdz = 0.1 # K m⁻¹, bottom boundary condition | ||
| ρₒ = 1026 # kg m⁻³, average density at the surface of the world ocean | ||
| cᴾ = 3991 # J K⁻¹ kg⁻¹, typical heat capacity for seawater | ||
| Qᵀ(x, y, t) = Qʰ(t) / (ρₒ * cᴾ) # K m s⁻¹, surface _temperature_ flux | ||
| T_bcs = FieldBoundaryConditions(top = FluxBoundaryCondition(Qᵀ), | ||
| bottom = GradientBoundaryCondition(dTdz)) | ||
|
|
||
| cᴰ = 2.5e-3 # dimensionless drag coefficient | ||
| ρₐ = 1.225 # kg m⁻³, average density of air at sea-level | ||
| Qᵘ(x, y, t) = - ρₐ / ρₒ * cᴰ * u₁₀(t) * abs(u₁₀(t)) # m² s⁻² | ||
| u_bcs = FieldBoundaryConditions(top = FluxBoundaryCondition(Qᵘ)) | ||
|
|
||
| Qˢ(x, y, t, S) = - Ev(t) * S # [salinity unit] m s⁻¹ | ||
| evaporation_bc = FluxBoundaryCondition(Qˢ, field_dependencies=:S) | ||
| S_bcs = FieldBoundaryConditions(top=evaporation_bc) | ||
|
|
||
| return (u=u_bcs,T=T_bcs,S=S_bcs) | ||
| end | ||
|
|
||
| ## | ||
|
|
||
| function Oceananigans_build_model(grid,BC,IC) | ||
|
|
||
| buoyancy = SeawaterBuoyancy(equation_of_state=LinearEquationOfState(thermal_expansion=2e-4, haline_contraction=8e-4)) | ||
|
|
||
| model = NonhydrostaticModel( | ||
| advection = UpwindBiasedFifthOrder(), | ||
| timestepper = :RungeKutta3, | ||
| grid = grid, | ||
| tracers = (:T, :S), | ||
| coriolis = FPlane(f=1e-4), | ||
| buoyancy = buoyancy, | ||
| closure = AnisotropicMinimumDissipation(), | ||
| boundary_conditions = (u=BC.u, T=BC.T, S=BC.S)) | ||
|
|
||
| # initial conditions (as functions of x,y,z) | ||
| set!(model, u=IC.u, w=IC.u, T=IC.T, S=IC.S) | ||
|
|
||
| return model | ||
| end | ||
|
|
||
| function Oceananigans_build_simulation(model,Nh,rundir) | ||
| simulation = Simulation(model, Δt=10.0, stop_time=Nh*60minutes) | ||
|
|
||
| wizard = TimeStepWizard(cfl=1.0, max_change=1.1, max_Δt=20.0) | ||
| simulation.callbacks[:wizard] = Callback(wizard, IterationInterval(10)) | ||
|
|
||
| progress_message(sim) = | ||
| @printf("Iteration: %04d, time: %s, Δt: %s, max(|w|) = %.1e ms⁻¹, wall time: %s\n", | ||
| iteration(sim),prettytime(sim),prettytime(sim.Δt), | ||
| maximum(abs, sim.model.velocities.w),prettytime(sim.run_wall_time)) | ||
| simulation.callbacks[:progress] = Callback(progress_message, IterationInterval(1minute)) | ||
|
|
||
| eddy_viscosity = (; νₑ = model.diffusivity_fields.νₑ) | ||
| simulation.output_writers[:slices] = | ||
| JLD2OutputWriter(model, merge(model.velocities, model.tracers, eddy_viscosity), | ||
| dir = rundir, | ||
| filename = "daily_cycle.jld2", | ||
| indices = (:,Int(model.grid.Ny/2),:), | ||
| schedule = TimeInterval(1minute), | ||
| overwrite_existing = true) | ||
|
|
||
| simulation.output_writers[:checkpointer] = | ||
| Checkpointer(model, schedule=TimeInterval(24hour), dir = rundir, prefix="model_checkpoint") | ||
|
|
||
| ## | ||
|
|
||
| fil=simulation.output_writers[:slices].filepath | ||
|
|
||
| xw, yw, zw = nodes(model.velocities.w) | ||
| xT, yT, zT = nodes(model.tracers.T) | ||
| coords=(xw, yw, zw, xT, yT, zT) | ||
|
|
||
| fil_coords=joinpath(rundir,"coords.jld2") | ||
| JLD2.jldopen(fil_coords, "w") do file | ||
| mygroup = JLD2.Group(file, "coords") | ||
| mygroup["xw"] = xw | ||
| mygroup["yw"] = yw | ||
| mygroup["zw"] = zw | ||
| mygroup["xT"] = xT | ||
| mygroup["yT"] = yT | ||
| mygroup["zT"] = zT | ||
| end | ||
|
|
||
| return simulation | ||
| end | ||
|
|
||
| Oceananigans_launch(x::OceananigansConfig) = run!(x.outputs["simulation"], pickup=true) | ||
|
|
||
| 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
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,76 @@ | ||
|
|
||
| module FaIR | ||
|
|
||
| import ClimateModels | ||
| import ClimateModels: setup, AbstractModelConfig | ||
|
|
||
| uuid4=ClimateModels.uuid4 | ||
| UUID=ClimateModels.UUID | ||
| OrderedDict=ClimateModels.OrderedDict | ||
|
|
||
| function loop_over_scenarios() | ||
| scenarios=[:rcp26,:rcp45,:rcp60,:rcp85] | ||
| temperatures=[] | ||
|
|
||
| (fair,forward,RCPs)=ClimateModels.pyimport(:fair) | ||
|
|
||
| for i in scenarios | ||
| emissions=RCPs[i].Emissions.emissions | ||
| C,F,T = forward.fair_scm(emissions=emissions) | ||
| push!(temperatures,T) | ||
| end | ||
|
|
||
| scenarios,temperatures | ||
| end | ||
|
|
||
| """ | ||
| struct FaIRConfig <: AbstractModelConfig | ||
| Concrete type of `AbstractModelConfig` for `FaIR` model. | ||
| """ | ||
| Base.@kwdef struct FaIRConfig <: AbstractModelConfig | ||
| model :: String = "FaIR" | ||
| configuration :: String = "rcp45" | ||
| inputs :: OrderedDict{Any,Any} = OrderedDict{Any,Any}() | ||
| outputs :: OrderedDict{Any,Any} = OrderedDict(:C=>Float64[],:F=>Float64[],:T=>Float64[]) | ||
| status :: OrderedDict{Any,Any} = OrderedDict{Any,Any}() | ||
| channel :: Channel{Any} = Channel{Any}(10) | ||
| folder :: String = tempdir() | ||
| ID :: UUID = uuid4() | ||
| end | ||
|
|
||
| function setup(x :: FaIRConfig) | ||
| !isdir(x.folder) ? mkdir(x.folder) : nothing | ||
| !isdir(pathof(x)) ? mkdir(pathof(x)) : nothing | ||
| try | ||
| ClimateModels.pyimport(:fair) | ||
| catch | ||
| ClimateModels.conda(:fair) | ||
| end | ||
| !isdir(joinpath(pathof(x),"log")) ? log(x,"initial setup",init=true) : nothing | ||
| put!(x.channel,FaIR_launch) | ||
| end | ||
|
|
||
| function FaIR_launch(x::FaIRConfig) | ||
| pth0=pwd() | ||
| cd(pathof(x)) | ||
|
|
||
| (fair,forward,RCPs)=ClimateModels.pyimport(:fair) | ||
|
|
||
| emissions=RCPs.rcp85.Emissions.emissions | ||
| C,F,T = forward.fair_scm(emissions=emissions) | ||
|
|
||
| if isempty(x.outputs[:C]) | ||
| push!.(Ref(x.outputs[:C]),C[:]) | ||
| push!.(Ref(x.outputs[:F]),F[:]) | ||
| push!.(Ref(x.outputs[:T]),T[:]) | ||
| else | ||
| x.outputs[:C]=C[:] | ||
| x.outputs[:F]=F[:] | ||
| x.outputs[:T]=T[:] | ||
| end | ||
|
|
||
| cd(pth0) | ||
| end | ||
|
|
||
| end |
Oops, something went wrong.