-
Notifications
You must be signed in to change notification settings - Fork 188
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.
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
Support for user-defined forcing functions. #85
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e94cf92
Fixed call to BoundaryConditions constructor. Resolves #84
ali-ramadhan f493a7f
Hacky support for user-defined forcing functions.
ali-ramadhan b38c2b5
Hacked in a user-defined forcing function into the 3D deep convection…
ali-ramadhan 93a89e7
Adds forcing tests and tweaks forcing constructors
glwagner 668eb27
Refactored deep convection 3D example to use ifelse forcing.
ali-ramadhan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,109 @@ | ||
| using Statistics: mean | ||
| using Plots | ||
| using Oceananigans | ||
|
|
||
| function deep_convection_3d() | ||
| Nx, Ny, Nz = 100, 100, 50 | ||
| Lx, Ly, Lz = 2000, 2000, 1000 | ||
| Nt, Δt = 500, 20 | ||
|
|
||
| model = Model((Nx, Ny, Nz), (Lx, Ly, Lz)) | ||
| impose_initial_conditions!(model) | ||
|
|
||
| nc_writer = NetCDFFieldWriter(".", "deep_convection_3d", 50) | ||
| push!(model.output_writers, nc_writer) | ||
|
|
||
| time_step!(model; Nt=Nt, Δt=Δt) | ||
| # make_temperature_movies(model, field_writer) | ||
| end | ||
|
|
||
| function impose_cooling_disk!(model::Model) | ||
| g = model.grid | ||
| c = model.constants | ||
|
|
||
| # Parameters for generating initial surface heat flux. | ||
| Rc = 600 # Radius of cooling disk [m]. | ||
| Ts = 20 # Surface temperature [°C]. | ||
| Q₀ = -800 # Cooling disk heat flux [W/m²]. | ||
| Q₁ = 10 # Noise added to cooling disk heat flux [W/m²]. | ||
| Ns = 5 * (c.f * Rc/g.Lz) # Stratification or Brunt–Väisälä frequency [s⁻¹]. | ||
|
|
||
| αᵥ = 2.07e-4 # Volumetric coefficient of thermal expansion for water [K⁻¹]. | ||
| cᵥ = 4181.3 # Isobaric mass heat capacity [J / kg·K]. | ||
|
|
||
| Tz = Ns^2 / (c.g * αᵥ) # Vertical temperature gradient [K/m]. | ||
|
|
||
| # Center horizontal coordinates so that (x,y) = (0,0) corresponds to the center | ||
| # of the domain (and the cooling disk). | ||
| x₀ = g.xC .- mean(g.xC) | ||
| y₀ = g.yC .- mean(g.yC) | ||
|
|
||
| # Calculate vertical temperature profile and convert to Kelvin. | ||
| T_ref = 273.15 .+ Ts .+ Tz .* (g.zC .- mean(Tz * g.zC)) | ||
|
|
||
| # Impose reference temperature profile. | ||
| model.tracers.T.data .= repeat(reshape(T_ref, 1, 1, g.Nz), g.Nx, g.Ny, 1) | ||
|
|
||
| # Set surface heat flux to zero outside of cooling disk of radius Rᶜ. | ||
| r₀² = @. x₀*x₀ + y₀'*y₀' | ||
|
|
||
| # Generate surface heat flux field with small random fluctuations. | ||
| Q = Q₀ .+ Q₁ * (0.5 .+ rand(g.Nx, g.Ny)) | ||
| Q[findall(r₀² .> Rc^2)] .= 0 # Set Q=0 outside cooling disk. | ||
|
|
||
| # Convert surface heat flux into 3D forcing term for use when calculating | ||
| # source terms at each time step. Also convert surface heat flux [W/m²] | ||
| # into a temperature tendency forcing [K/s]. | ||
| @. model.forcings.FT.data[:, :, 1] = (Q / cᵥ) * (g.Az / (model.eos.ρ₀ * g.V)) | ||
| nothing | ||
| end | ||
|
|
||
| function impose_initial_conditions!(model::Model) | ||
| g = model.grid | ||
|
|
||
| impose_cooling_disk!(model) | ||
|
|
||
| @. model.tracers.S.data = model.eos.S₀ | ||
|
|
||
| pHY_profile = [-model.eos.ρ₀ * model.constants.g * h for h in g.zC] | ||
| model.pressures.pHY.data .= repeat(reshape(pHY_profile, 1, 1, g.Nz), g.Nx, g.Ny, 1) | ||
| nothing | ||
| end | ||
|
|
||
| # function make_temperature_movies(model::Model, fw::FieldWriter) | ||
| # n_frames = Int(model.clock.time_step / fw.output_frequency) | ||
| # | ||
| # xC, yC, zC = model.grid.xC, model.grid.yC, model.grid.zC | ||
| # Δt = 20 | ||
| # | ||
| # print("Creating temperature movie... ($n_frames frames)\n") | ||
| # | ||
| # Plots.gr() | ||
| # default(dpi=300) | ||
| # movie = @animate for tidx in 0:n_frames | ||
| # print("\rframe = $tidx / $n_frames ") | ||
| # temperature = read_output(model, fw, "T", tidx*fw.output_frequency*Δt) | ||
| # Plots.heatmap(xC, zC, rotl90(temperature[:, 50, :]) .- 293.15, color=:balance, | ||
| # clims=(-0.1, 0), | ||
| # title="T @ t=$(tidx*fw.output_frequency*Δt)") | ||
| # end | ||
| # | ||
| # mp4(movie, "deep_convection_3d_$(round(Int, time())).mp4", fps = 30) | ||
| # | ||
| # print("Creating surface temperature movie... ($n_frames frames)\n") | ||
| # movie = @animate for tidx in 0:n_frames | ||
| # print("\rframe = $tidx / $n_frames ") | ||
| # temperature = read_output(model, fw, "T", tidx*fw.output_frequency*Δt) | ||
| # Plots.heatmap(xC, yC, temperature[:, :, 1] .- 293.15, color=:balance, | ||
| # clims=(-0.1, 0), | ||
| # title="T @ t=$(tidx*fw.output_frequency*Δt)") | ||
| # end | ||
| # mp4(movie, "deep_convection_3d_$(round(Int, time())).mp4", fps = 30) | ||
| # end | ||
| using Statistics: mean | ||
| using Plots | ||
| using Oceananigans | ||
|
|
||
| function impose_cooling_disk!(model::Model) | ||
| g = model.grid | ||
| c = model.constants | ||
|
|
||
| # Parameters for generating initial surface heat flux. | ||
| Rc = 600 # Radius of cooling disk [m]. | ||
| Ts = 20 # Surface temperature [°C]. | ||
| Q₀ = -800 # Cooling disk heat flux [W/m²]. | ||
| Q₁ = 10 # Noise added to cooling disk heat flux [W/m²]. | ||
| Ns = 5 * (c.f * Rc/g.Lz) # Stratification or Brunt–Väisälä frequency [s⁻¹]. | ||
|
|
||
| αᵥ = 2.07e-4 # Volumetric coefficient of thermal expansion for water [K⁻¹]. | ||
| cᵥ = 4181.3 # Isobaric mass heat capacity [J / kg·K]. | ||
|
|
||
| Tz = Ns^2 / (c.g * αᵥ) # Vertical temperature gradient [K/m]. | ||
|
|
||
| # Center horizontal coordinates so that (x,y) = (0,0) corresponds to the center | ||
| # of the domain (and the cooling disk). | ||
| x₀ = g.xC .- mean(g.xC) | ||
| y₀ = g.yC .- mean(g.yC) | ||
|
|
||
| # Calculate vertical temperature profile and convert to Kelvin. | ||
| T_ref = 273.15 .+ Ts .+ Tz .* (g.zC .- mean(Tz * g.zC)) | ||
|
|
||
| # Impose reference temperature profile. | ||
| model.tracers.T.data .= repeat(reshape(T_ref, 1, 1, g.Nz), g.Nx, g.Ny, 1) | ||
|
|
||
| # Set surface heat flux to zero outside of cooling disk of radius Rᶜ. | ||
| r₀² = @. x₀*x₀ + y₀'*y₀' | ||
|
|
||
| # Generate surface heat flux field with small random fluctuations. | ||
| Q = Q₀ .+ Q₁ * (0.5 .+ rand(g.Nx, g.Ny)) | ||
| Q[findall(r₀² .> Rc^2)] .= 0 # Set Q=0 outside cooling disk. | ||
|
|
||
| # Convert surface heat flux into 3D forcing term for use when calculating | ||
| # source terms at each time step. Also convert surface heat flux [W/m²] | ||
| # into a temperature tendency forcing [K/s]. | ||
| @. model.forcings.FT.data[:, :, 1] = (Q / cᵥ) * (g.Az / (model.eos.ρ₀ * g.V)) | ||
| @show model.forcings.FT.data[50, 50, 1] | ||
| nothing | ||
| end | ||
|
|
||
| function impose_initial_conditions!(model::Model) | ||
| g = model.grid | ||
|
|
||
| impose_cooling_disk!(model) | ||
|
|
||
| @. model.tracers.S.data = model.eos.S₀ | ||
|
|
||
| pHY_profile = [-model.eos.ρ₀ * model.constants.g * h for h in g.zC] | ||
| model.pressures.pHY.data .= repeat(reshape(pHY_profile, 1, 1, g.Nz), g.Nx, g.Ny, 1) | ||
| nothing | ||
| end | ||
|
|
||
| # function make_temperature_movies(model::Model, fw::FieldWriter) | ||
| # n_frames = Int(model.clock.time_step / fw.output_frequency) | ||
| # | ||
| # xC, yC, zC = model.grid.xC, model.grid.yC, model.grid.zC | ||
| # Δt = 20 | ||
| # | ||
| # print("Creating temperature movie... ($n_frames frames)\n") | ||
| # | ||
| # Plots.gr() | ||
| # default(dpi=300) | ||
| # movie = @animate for tidx in 0:n_frames | ||
| # print("\rframe = $tidx / $n_frames ") | ||
| # temperature = read_output(model, fw, "T", tidx*fw.output_frequency*Δt) | ||
| # Plots.heatmap(xC, zC, rotl90(temperature[:, 50, :]) .- 293.15, color=:balance, | ||
| # clims=(-0.1, 0), | ||
| # title="T @ t=$(tidx*fw.output_frequency*Δt)") | ||
| # end | ||
| # | ||
| # mp4(movie, "deep_convection_3d_$(round(Int, time())).mp4", fps = 30) | ||
| # | ||
| # print("Creating surface temperature movie... ($n_frames frames)\n") | ||
| # movie = @animate for tidx in 0:n_frames | ||
| # print("\rframe = $tidx / $n_frames ") | ||
| # temperature = read_output(model, fw, "T", tidx*fw.output_frequency*Δt) | ||
| # Plots.heatmap(xC, yC, temperature[:, :, 1] .- 293.15, color=:balance, | ||
| # clims=(-0.1, 0), | ||
| # title="T @ t=$(tidx*fw.output_frequency*Δt)") | ||
| # end | ||
| # mp4(movie, "deep_convection_3d_$(round(Int, time())).mp4", fps = 30) | ||
| # end | ||
|
|
||
| Nx, Ny, Nz = 100, 100, 50 | ||
| Lx, Ly, Lz = 2000, 2000, 1000 | ||
| Nt, Δt = 1000, 20 | ||
|
|
||
| model = Model((Nx, Ny, Nz), (Lx, Ly, Lz)) | ||
|
|
||
| # impose_initial_conditions!(model) | ||
|
|
||
| # We will impose a surface heat flux of -800 W/m² ≈ -9e-6 K/s in a square | ||
| # on the surface of the domain. | ||
| @inline surface_cooling_disk(u, v, w, T, S, Nx, Ny, Nz, Δx, Δy, Δz, i, j, k) = ifelse(k == 1 && 20 < i < 80 && 20 < j < 80, -9e-6, 0) | ||
|
|
||
| # Only impose surface_cooling_disk on the temperature field. | ||
| model.forcing = Forcing(nothing, nothing, nothing, surface_cooling_disk, nothing) | ||
|
|
||
| nc_writer = NetCDFFieldWriter(".", "deep_convection_3d", 20) | ||
| push!(model.output_writers, nc_writer) | ||
|
|
||
| time_step!(model; Nt=Nt, Δt=Δt) | ||
| # make_temperature_movies(model, field_writer) |
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,28 @@ | ||
| "Dummy function and forcing default." | ||
| @inline zero_func(args...) = 0 | ||
|
|
||
| """ | ||
| Forcing(Fu, Fv, Fw, FF, FS) | ||
|
|
||
| Forcing(; Fu=zero_func, Fv=zero_func, Fw=zero_func, FT=zero_func, FS=zero_func) | ||
|
|
||
| Construct a `Forcing` to specify functions that force `u`, `v`, `w`, `T`, and `S`. | ||
| Forcing functions default to `zero_func`, which does nothing. | ||
| """ | ||
| struct Forcing{Tu,Tv,Tw,TT,TS} | ||
| u::Tu | ||
| v::Tv | ||
| w::Tw | ||
| T::TT | ||
| S::TS | ||
| function Forcing(Fu, Fv, Fw, FT, FS) | ||
| Fu = Fu === nothing ? zero_func : Fu | ||
| Fv = Fv === nothing ? zero_func : Fv | ||
| Fw = Fw === nothing ? zero_func : Fw | ||
| FT = FT === nothing ? zero_func : FT | ||
| FS = FS === nothing ? zero_func : FS | ||
| new{typeof(Fu),typeof(Fv),typeof(Fw),typeof(FT),typeof(FS)}(Fu, Fv, Fw, FT, FS) | ||
| end | ||
| end | ||
|
|
||
| Forcing(; Fu=nothing, Fv=nothing, Fw=nothing, FT=nothing, FS=nothing) = Forcing(Fu, Fv, Fw, FT, FS) |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens if you try to pass
gridinstead ofNx, Ny, Nz, Δx, Δy, Δz?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the GPU it complains that the arguments are not
isbitstype:(There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. So both
Fields andGrids will have to be worked on.