CliMA / ClimaSeaIce.jl

🧊 Coupled and stand-alone simulations of sea ice for Earth system modeling
https://clima.github.io/ClimaSeaIceDocumentation/dev/
Apache License 2.0
13 stars 1 forks source link

Change "thermal" to "heat" (in most places) #21

Closed glwagner closed 8 months ago

glwagner commented 8 months ago

After a bit of rumination I think we should use the term "heat flux" not "thermal flux". It's more standard. Sorry for any pain this causes...

@jlk9

jlk9 commented 8 months ago

You need to change the directory and file names from "Thermal" to "Heat" too, in "ThermalBoundaryConditions" at least

glwagner commented 8 months ago

You need to change the directory and file names from "Thermal" to "Heat" too, in "ThermalBoundaryConditions" at least

thank you!

codecov[bot] commented 8 months ago

Codecov Report

Attention: 30 lines in your changes are missing coverage. Please review.

Comparison is base (05086bb) 22.80% compared to head (de6d239) 22.80%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #21 +/- ## ======================================= Coverage 22.80% 22.80% ======================================= Files 11 11 Lines 307 307 ======================================= Hits 70 70 Misses 237 237 ``` | [Files](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA) | Coverage Δ | | |---|---|---| | [src/ClimaSeaIce.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL0NsaW1hU2VhSWNlLmps) | `6.66% <ø> (ø)` | | | [...c/HeatBoundaryConditions/HeatBoundaryConditions.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL0hlYXRCb3VuZGFyeUNvbmRpdGlvbnMvSGVhdEJvdW5kYXJ5Q29uZGl0aW9ucy5qbA==) | `50.00% <100.00%> (ø)` | | | [src/HeatBoundaryConditions/boundary\_fluxes.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL0hlYXRCb3VuZGFyeUNvbmRpdGlvbnMvYm91bmRhcnlfZmx1eGVzLmps) | `0.00% <ø> (ø)` | | | [...ndaryConditions/bottom\_heat\_boundary\_conditions.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL0hlYXRCb3VuZGFyeUNvbmRpdGlvbnMvYm90dG9tX2hlYXRfYm91bmRhcnlfY29uZGl0aW9ucy5qbA==) | `0.00% <0.00%> (ø)` | | | [...BoundaryConditions/top\_heat\_boundary\_conditions.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL0hlYXRCb3VuZGFyeUNvbmRpdGlvbnMvdG9wX2hlYXRfYm91bmRhcnlfY29uZGl0aW9ucy5qbA==) | `0.00% <0.00%> (ø)` | | | [...rc/SlabSeaIceModels/slab\_heat\_and\_tracer\_fluxes.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NsYWJTZWFJY2VNb2RlbHMvc2xhYl9oZWF0X2FuZF90cmFjZXJfZmx1eGVzLmps) | `0.00% <0.00%> (ø)` | | | [...SlabSeaIceModels/slab\_tendency\_kernel\_functions.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NsYWJTZWFJY2VNb2RlbHMvc2xhYl90ZW5kZW5jeV9rZXJuZWxfZnVuY3Rpb25zLmps) | `0.00% <0.00%> (ø)` | | | [src/SlabSeaIceModels/slab\_time\_stepping.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NsYWJTZWFJY2VNb2RlbHMvc2xhYl90aW1lX3N0ZXBwaW5nLmps) | `0.00% <0.00%> (ø)` | | | [src/SlabSeaIceModels/slab\_sea\_ice\_model.jl](https://app.codecov.io/gh/CliMA/ClimaSeaIce.jl/pull/21?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CliMA#diff-c3JjL1NsYWJTZWFJY2VNb2RlbHMvc2xhYl9zZWFfaWNlX21vZGVsLmps) | `0.00% <0.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

glwagner commented 8 months ago

Did you want to change the name of IceWaterThermalEquilibrium as well?

I thought "thermal equilibrium" made sense to keep since that's the typical expression. For fluxes though we usually say "heat flux" not "thermal flux", that motivates the changes we've put in so far. What do you think?

glwagner commented 8 months ago

For example

https://en.wikipedia.org/wiki/Thermal_equilibrium

but

https://en.wikipedia.org/wiki/Heat_equation

jlk9 commented 8 months ago

I agree, that's how I've usually heard fluxes / equilibrium referred to as well, just wanted to make sure.

glwagner commented 8 months ago

great!