Rename `IncompressibleModel` to `NonhydrostaticModel` #1870

navidcy · 2021-07-18T12:34:42Z

Closes #1620.

navidcy · 2021-07-18T12:35:54Z

This first commit is just a search-and-replace. Let's go through the changes to find any possible mishaps.

navidcy · 2021-07-18T12:37:39Z

We may need to rename some files, e.g., IncompressibleModels.jl, incompressible_model.jl...

navidcy · 2021-07-18T12:42:49Z

oh @glwagner, did you already did this in #1867?
If so then close this... :) (and link #1620 to #1867)

glwagner · 2021-07-18T12:47:33Z

oh @glwagner, did you already did this in #1867?
If so then close this... :) (and link #1620 to #1867)

No, I didn't! #1867 is just an issue, not a PR. ?

glwagner · 2021-07-18T12:47:46Z

We may need to rename some files, e.g., IncompressibleModels.jl, incompressible_model.jl...

Quite!

navidcy · 2021-07-18T12:49:48Z

oh @glwagner, did you already did this in #1867?
If so then close this... :) (and link #1620 to #1867)

No, I didn't! #1867 is just an issue, not a PR. ?

I simply got confused... :)

…model.jl

glwagner · 2021-07-18T13:16:00Z

So good

src/Models/NonhydrostaticModels/nonhydrostatic_model.jl

…b.com:CliMA/Oceananigans.jl into ncc-glw/incompressible-becomes-nonhydrostatic

glwagner

It's... breathtaking...

navidcy · 2021-07-18T20:44:47Z

It's... breathtaking...

Keep calm

tomchor · 2021-07-18T23:39:40Z

Docs are here BTW: https://clima.github.io/OceananigansDocumentation/previews/PR1870/

Might be good to search for "Incompressible model" (separate words) to catch instances like the title of this page: https://clima.github.io/OceananigansDocumentation/previews/PR1870/physics/nonhydrostatic_model/

tomchor · 2021-07-19T00:44:03Z

This is what I found:

(base) tomas@np900:~/repos/Oceananigans.jl$ grep -ri "incompressible model" *
benchmark/benchmark_incompressible_model.jl:          xlabel="Nx", ylabel="Times (ms)", title="Incompressible Model Benchmarks: CPU vs GPU")
benchmark/benchmark_incompressible_model.jl:            xlabel="Nx", ylabel="Speedup Ratio", title="Incompressible Model Benchmarks: CPU/GPU")
benchmark/benchmark_incompressible_model.jl:benchmarks_pretty_table(df, title="Incompressible model benchmarks")
benchmark/benchmark_incompressible_model.jl:    benchmarks_pretty_table(df_Δ, title="Incompressible model CPU to GPU speedup")
benchmark/strong_scaling_incompressible_model.jl:    @info "Benchmarking distributed incompressible model strong scaling with $(typeof(decomposition)) decomposition [N=($Nx, $Ny, $Nz), ranks=($Rx, $Ry, $Rz)]..."
benchmark/strong_scaling_incompressible_model.jl:benchmarks_pretty_table(df, title="Incompressible model strong scaling benchmark")
benchmark/strong_scaling_incompressible_model.jl:benchmarks_pretty_table(df_Δ, title="Incompressible model strong scaling speedup")
benchmark/README.md:Running the `benchmark_regression.jl` script will run the incompressible model tests on the current branch and on the master branch for comparison. This is useful to test whether the current branch slows down the code or introduces any performance regression.
benchmark/benchmark_vertically_stretched_incompressible_model.jl:benchmarks_pretty_table(df, title="Vertically-stretched incompressible model benchmarks")
benchmark/benchmark_vertically_stretched_incompressible_model.jl:    benchmarks_pretty_table(df_Δ, title="Vertically-stretched incompressible model CPU to GPU speedup")
benchmark/strong_scaling_incompressible_model_single.jl:@info "Setting up distributed incompressible model with N=($Nx, $Ny, $Nz) grid points and ranks=($Rx, $Ry, $Rz) ($decomposition decomposition) on rank $local_rank..."
benchmark/strong_scaling_incompressible_model_single.jl:@info "Warming up distributed incompressible model on rank $local_rank..."
benchmark/strong_scaling_incompressible_model_single.jl:@info "Benchmarking distributed incompressible model on rank $local_rank..."
docs/src/physics/incompressible_model.md:# Incompressible model
docs/src/numerical_implementation/time_stepping.md:where, e.g., for the incompressible model, 
docs/make.jl:        "Incompressible model" => "physics/incompressible_model.md",
src/Distributed/distributed_incompressible_model.jl:##### Distributed incompressible model constructor
validation/immersed_boundaries/flow_around_cylinder.jl:# setting up incompressible model with immersed boundary

If you're okay with it I can make these alterations myself (idk what are the protocols about modifying other people's PRs...)

navidcy · 2021-07-19T00:50:24Z

This is what I found:

(base) tomas@np900:~/repos/Oceananigans.jl$ grep -ri "incompressible model" *
benchmark/benchmark_incompressible_model.jl:          xlabel="Nx", ylabel="Times (ms)", title="Incompressible Model Benchmarks: CPU vs GPU")
benchmark/benchmark_incompressible_model.jl:            xlabel="Nx", ylabel="Speedup Ratio", title="Incompressible Model Benchmarks: CPU/GPU")
benchmark/benchmark_incompressible_model.jl:benchmarks_pretty_table(df, title="Incompressible model benchmarks")
benchmark/benchmark_incompressible_model.jl:    benchmarks_pretty_table(df_Δ, title="Incompressible model CPU to GPU speedup")
benchmark/strong_scaling_incompressible_model.jl:    @info "Benchmarking distributed incompressible model strong scaling with $(typeof(decomposition)) decomposition [N=($Nx, $Ny, $Nz), ranks=($Rx, $Ry, $Rz)]..."
benchmark/strong_scaling_incompressible_model.jl:benchmarks_pretty_table(df, title="Incompressible model strong scaling benchmark")
benchmark/strong_scaling_incompressible_model.jl:benchmarks_pretty_table(df_Δ, title="Incompressible model strong scaling speedup")
benchmark/README.md:Running the `benchmark_regression.jl` script will run the incompressible model tests on the current branch and on the master branch for comparison. This is useful to test whether the current branch slows down the code or introduces any performance regression.
benchmark/benchmark_vertically_stretched_incompressible_model.jl:benchmarks_pretty_table(df, title="Vertically-stretched incompressible model benchmarks")
benchmark/benchmark_vertically_stretched_incompressible_model.jl:    benchmarks_pretty_table(df_Δ, title="Vertically-stretched incompressible model CPU to GPU speedup")
benchmark/strong_scaling_incompressible_model_single.jl:@info "Setting up distributed incompressible model with N=($Nx, $Ny, $Nz) grid points and ranks=($Rx, $Ry, $Rz) ($decomposition decomposition) on rank $local_rank..."
benchmark/strong_scaling_incompressible_model_single.jl:@info "Warming up distributed incompressible model on rank $local_rank..."
benchmark/strong_scaling_incompressible_model_single.jl:@info "Benchmarking distributed incompressible model on rank $local_rank..."
docs/src/physics/incompressible_model.md:# Incompressible model
docs/src/numerical_implementation/time_stepping.md:where, e.g., for the incompressible model, 
docs/make.jl:        "Incompressible model" => "physics/incompressible_model.md",
src/Distributed/distributed_incompressible_model.jl:##### Distributed incompressible model constructor
validation/immersed_boundaries/flow_around_cylinder.jl:# setting up incompressible model with immersed boundary

If you're okay with it I can make these alterations myself (idk what are the protocols about modifying other people's PRs...)

Thanks that's helpful!
Hm... Are you sure you are looking at the latest version? Because some of those incompressible things I've changed already!

…b.com:CliMA/Oceananigans.jl into ncc-glw/incompressible-becomes-nonhydrostatic

navidcy · 2021-07-19T00:58:30Z

but, @tomchor, I'd be definitely more than happy if you'd made these changes since they are trivial and need not be discussed or what not ;)

(just saying in response to your protocol concerns..!)

thanks for reviewing!

IncompressibleModel->NonhydrostaticModel

83bb2f6

navidcy requested a review from glwagner July 18, 2021 12:34

rename directory/files

702b15c

navidcy added 2 commits July 18, 2021 22:59

incompressible -> nonhydrostatic

b2a197a

Rename benchmark_incompressible_model.jl to benchmark_nonhydrostatic_…

fc332ec

…model.jl

tomchor mentioned this pull request Jul 18, 2021

Boussinesq model vs incompressible model #1620

Closed

tomchor reviewed Jul 18, 2021

View reviewed changes

src/Models/NonhydrostaticModels/nonhydrostatic_model.jl Show resolved Hide resolved

navidcy added 6 commits July 19, 2021 05:55

update constructor docstring

ef0e230

incompressible -> nonhydrostatic

37fb3e9

incompressible -> nonhydrostatic

d86947f

Merge branch 'ncc-glw/incompressible-becomes-nonhydrostatic' of githu…

87bb900

…b.com:CliMA/Oceananigans.jl into ncc-glw/incompressible-becomes-nonhydrostatic

incompressible -> nonhydrostatic in docs

74e8360

incompressible -> nonhydrostatic in docs

8214256

navidcy requested review from ali-ramadhan and francispoulin July 18, 2021 20:10

bump to v0.60.0

02591b9

glwagner approved these changes Jul 18, 2021

View reviewed changes

Merge branch 'master' into ncc-glw/incompressible-becomes-nonhydrostatic

2bd0988

navidcy requested a review from tomchor July 18, 2021 23:21

tomchor approved these changes Jul 19, 2021

View reviewed changes

navidcy added 2 commits July 19, 2021 10:55

incompressible -> nonhydrostatic

3fba691

Merge branch 'ncc-glw/incompressible-becomes-nonhydrostatic' of githu…

3a95ff6

…b.com:CliMA/Oceananigans.jl into ncc-glw/incompressible-becomes-nonhydrostatic

navidcy added 2 commits July 19, 2021 11:00

another incompressible -> nonhydrostatic

382334a

moar incompressible -> nonhydrostatic

56a725d

navidcy merged commit 472bdca into master Jul 19, 2021

navidcy deleted the ncc-glw/incompressible-becomes-nonhydrostatic branch July 19, 2021 03:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename `IncompressibleModel` to `NonhydrostaticModel` #1870

Rename `IncompressibleModel` to `NonhydrostaticModel` #1870

navidcy commented Jul 18, 2021 •

edited

Loading

navidcy commented Jul 18, 2021

navidcy commented Jul 18, 2021

navidcy commented Jul 18, 2021 •

edited

Loading

glwagner commented Jul 18, 2021

glwagner commented Jul 18, 2021

navidcy commented Jul 18, 2021

glwagner commented Jul 18, 2021

glwagner left a comment

navidcy commented Jul 18, 2021

tomchor commented Jul 18, 2021

tomchor commented Jul 19, 2021

navidcy commented Jul 19, 2021

navidcy commented Jul 19, 2021 •

edited

Loading

Rename IncompressibleModel to NonhydrostaticModel #1870

Rename IncompressibleModel to NonhydrostaticModel #1870

Conversation

navidcy commented Jul 18, 2021 • edited Loading

navidcy commented Jul 18, 2021

navidcy commented Jul 18, 2021

navidcy commented Jul 18, 2021 • edited Loading

glwagner commented Jul 18, 2021

glwagner commented Jul 18, 2021

navidcy commented Jul 18, 2021

glwagner commented Jul 18, 2021

glwagner left a comment

Choose a reason for hiding this comment

navidcy commented Jul 18, 2021

tomchor commented Jul 18, 2021

tomchor commented Jul 19, 2021

navidcy commented Jul 19, 2021

navidcy commented Jul 19, 2021 • edited Loading

Rename `IncompressibleModel` to `NonhydrostaticModel` #1870

Rename `IncompressibleModel` to `NonhydrostaticModel` #1870

navidcy commented Jul 18, 2021 •

edited

Loading

navidcy commented Jul 18, 2021 •

edited

Loading

navidcy commented Jul 19, 2021 •

edited

Loading