Merge pull request #334 from FormingWorlds/hn/dev

AGNI no-solve configuration and minor changes
FormingWorlds · Feb 11, 2025 · ed649c4 · ed649c4
2 parents d2ade18 + 24315ff
commit ed649c4
Show file tree

Hide file tree

Showing 32 changed files with 660 additions and 789 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,6 +10,7 @@
     "python.analysis.exclude": [
         "**/__pycache__", "petsc", ".git", "SPIDER", "output"
     ],
+    "python.analysis.diagnosticMode": "openFilesOnly",
     "julia.environmentPath": "${workspaceFolder}/AGNI",
     "fortran.fortls.disabled": true
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -28,6 +28,15 @@ conda activate proteus
 pip install -e .[develop]
 ```
 
+### Code style
+
+Variables should be written in lowercase with underscores: `example_variable`.
+Functions should be written in lowercase with underscores: `example_function()`.
+Constants should be written in block capitals: `CONSTANT_VALUE`.
+Lines of code should avoid being longer than 92 characters.
+Functions should include a docstring where possible, describing their purpose and params.
+Indentation deeper than 3 levels should be avoided.
+
 ### Linting
 
 Linting is a term for static code analysis to flag programming errors,

diff --git a/input/default.toml b/input/default.toml
@@ -51,6 +51,9 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
     #     Set enabled=true/false in each section to enable/disable that termination criterion
     [params.stop]
 
+        # Require criteria to be satisfied twice before model will exit?
+        strict = false
+
         # required number of iterations
         [params.stop.iters]
             enabled = true
@@ -146,6 +149,7 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
         num_levels      = 250           # Number of atmospheric grid levels
         chemistry       = "none"        # "none" | "eq"
         surf_material   = "greybody"    # surface material file for scattering
+        solve_energy    = true         # solve for energy-conserving atmosphere profile
         solution_atol   = 1e-3          # solver absolute tolerance
         solution_rtol   = 2e-2          # solver relative tolerance
         overlap_method    = "ee"          # gas overlap method

diff --git a/input/demos/aragog.toml b/input/demos/aragog.toml
@@ -51,6 +51,9 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
     #     Set enabled=true/false in each section to enable/disable that termination criterion
     [params.stop]
 
+        # Require criteria to be satisfied twice before model will exit?
+        strict = false
+
         # required number of iterations
         [params.stop.iters]
             enabled = true
@@ -146,6 +149,7 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
         num_levels      = 40            # Number of atmospheric grid levels
         chemistry       = "none"        # "none" | "eq"
         surf_material   = "greybody"    # surface material file for scattering
+        solve_energy    = false         # solve for energy-conserving atmosphere profile
         solution_atol   = 1e-3          # solver absolute tolerance
         solution_rtol   = 2e-2          # solver relative tolerance
         overlap_method  = "ee"          # gas overlap method
@@ -182,7 +186,7 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
     grain_size      = 0.1   # crystal settling grain size [m]
     F_initial       = 1e6   # Initial heat flux guess [W m-2]
     radiogenic_heat = false  # enable radiogenic heat production
-    tidal_heat      = true  # enable tidal heat production
+    tidal_heat      = false  # enable tidal heat production
     rheo_phi_loc    = 0.4    # Centre of rheological transition
     rheo_phi_wid    = 0.15   # Width of rheological transition
     bulk_modulus    = 260e9   # Bulk modulus [Pa]

diff --git a/input/demos/dummy.toml b/input/demos/dummy.toml
@@ -51,6 +51,9 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
     #     Set enabled=true/false in each section to enable/disable that termination criterion
     [params.stop]
 
+        # Require criteria to be satisfied twice before model will exit?
+        strict = false
+
         # required number of iterations
         [params.stop.iters]
             enabled = true
@@ -146,6 +149,7 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
         num_levels      = 40           # Number of atmospheric grid levels
         chemistry       = "none"        # "none" | "eq"
         surf_material   = "greybody"    # surface material file for scattering
+        solve_energy    = false         # solve for energy-conserving atmosphere profile
         solution_atol   = 1e-3          # solver absolute tolerance
         solution_rtol   = 2e-2          # solver relative tolerance
         overlap_method    = "ee"          # gas overlap method

diff --git a/input/demos/escape.toml b/input/demos/escape.toml
@@ -51,6 +51,9 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
     #     Set enabled=true/false in each section to enable/disable that termination criterion
     [params.stop]
 
+        # Require criteria to be satisfied twice before model will exit?
+        strict = false
+
         # required number of iterations
         [params.stop.iters]
             enabled = true
@@ -146,6 +149,7 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
         num_levels      = 250           # Number of atmospheric grid levels
         chemistry       = "none"        # "none" | "eq"
         surf_material   = "greybody"    # surface material file for scattering
+        solve_energy    = false         # solve for energy-conserving atmosphere profile
         solution_atol   = 1e-3          # solver absolute tolerance
         solution_rtol   = 2e-2          # solver relative tolerance
         overlap_method  = "ee"          # gas overlap method

diff --git a/input/demos/spider.toml b/input/demos/spider.toml
diff --git a/input/planets/hd63433d.toml b/input/planets/hd63433d.toml
@@ -51,6 +51,9 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
     #     Set enabled=true/false in each section to enable/disable that termination criterion
     [params.stop]
 
+        # Require criteria to be satisfied twice before model will exit?
+        strict = false
+
         # required number of iterations
         [params.stop.iters]
             enabled = true
@@ -146,6 +149,7 @@ author  = "Harrison Nicholls, Tim Lichtenberg"
         num_levels      = 60            # Number of atmospheric grid levels
         chemistry       = "none"        # "none" | "eq"
         surf_material   = "greybody"    # surface material file for scattering
+        solve_energy    = true         # solve for energy-conserving atmosphere profile
         solution_atol   = 1e-2          # solver absolute tolerance
         solution_rtol   = 5e-2          # solver relative tolerance
         overlap_method    = "ee"          # gas overlap method