Rheology and conductivity modification for the entropy plugin #5254

RanpengLi · 2023-07-10T19:53:18Z

I added the following features to the current entropy plugin

plasticity controlled by cohesion and frictional angle
lateral variation limit of viscosity from the reference profile
depth dependent prefactor profile for lateral viscosity change
selecting between constant and p-T dependent thermal conductivity

For all pull requests:

I have followed the instructions for indenting my code.

For new features/models or changes of existing features:

I have tested my new feature locally to ensure it is correct.
I have created a testcase for the new feature/benchmark in the tests/ directory.
I have added a changelog entry in the doc/modules/changes directory that will inform other users of my change.

gassmoeller · 2023-07-11T05:26:45Z

/rebuild

gassmoeller

Thanks this looks good, but I have few small comments. A bigger comment is that you can probably remove the LateralViscosityLookup class and use the class from the steinberger.h directly, without copying the code. Let me know when you have addressed the comments.

Also please add a changelog entry in the doc/modules/changes, see here for a description: https://github.com/geodynamics/aspect/blob/main/CONTRIBUTING.md#changelog-entries

gassmoeller · 2023-07-12T22:16:49Z

benchmarks/entropy_adiabat/plugins/entropy_model.h


 namespace aspect
 {
  namespace MaterialModel
  {
    using namespace dealii;

+    namespace internal


You should be able to add #include <aspect/material_model/steinberger.h> at the top of the file, then you can delete this class declaration here. This does only work if you did not change something in the implementation of the LaterialViscosityLookup class.

gassmoeller · 2023-07-12T22:17:34Z

benchmarks/entropy_adiabat/plugins/entropy_model.h

        /**
         * Minimum/Maximum viscosity and lateral viscosity variations.
         */
-        double lateral_viscosity_prefactor;
+        //double lateral_viscosity_prefactor;


remove this line

gassmoeller · 2023-07-12T22:25:09Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc


 namespace aspect
 {
  namespace MaterialModel
  {
+    namespace internal


If you use the same class as the steinberger material model you can delete all of this copy (as long as you #include <aspect/material_model/steinberger.h at the top).

gassmoeller · 2023-07-12T22:25:54Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

    }


-


Keep this empty line. In fact our convention is to have three empty lines between functions in .cc files (and one empty line in .h files).

gassmoeller · 2023-07-12T22:35:26Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

+          const double p_dependence = reference_thermal_conductivities[layer_index] + conductivity_pressure_dependencies[layer_index] * pressure;
+
+          // Make reasonably sure we will not compute any invalid values due to the temperature-dependence.
+          // Since both the temperature-dependence and the saturation term scale with (Tref/T), we have to


Suggested change

// Since both the temperature-dependence and the saturation term scale with (Tref/T), we have to

// Since both the temperature-dependence and the saturation time scale with (Tref/T), we have to

time scalehas not been addressed

gassmoeller · 2023-07-12T22:42:53Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

+          // prm.declare_entry ("Lateral viscosity prefactor", "0.0",
+          //                    Patterns::Double(0),
+          //                    "The lateral viscosity prefactor used for computing the temperature"
+          //                    "dependence of viscosity. This corresponds to H/nR (where H is the "
+          //                    "activation enthalpy, n is the stress exponent and R is the gas "
+          //                    "constant) in an Arrhenius-type viscosity law, and is modeled after "
+          //                    "the law for lateral viscosity variations given in Steinberger and "
+          //                    "Calderwood, 2006. "
+          //                    "\n\n"
+          //                    "Units: $1/K$");


Remove all commented source code. We never merge commented code, because it will be impossible in the future to decide if this is is outdated code, or if it is code to be fixed and included in the future.

gassmoeller · 2023-07-12T22:43:08Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

+          //                    "Units: $1/K$");
+          prm.declare_entry ("Lateral viscosity prefactor file name", "temp-viscosity-prefactor.txt",
+                             Patterns::Anything (),
+                             "The file name of the lateral viscosity prefactor. ");


Suggested change

"The file name of the lateral viscosity prefactor. ");

"The file name of the lateral viscosity prefactor.");

gassmoeller · 2023-07-12T22:45:13Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

+                             Patterns::List(Patterns::Double (0.)),
+                             "A list of depth values that indicate where the transitions between "
+                             "the different conductivity parameter sets should occur in the "
+                             "'p-T-dependent' Thermal conductivity formulation (in most cases, "


Suggested change

"'p-T-dependent' Thermal conductivity formulation (in most cases, "

"'p-T-dependent' thermal conductivity formulation (in most cases, "

gassmoeller · 2023-07-12T22:45:35Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

+          prm.declare_entry ("Reference thermal conductivities", "2.47, 3.81, 3.52, 4.9",
+                             Patterns::List(Patterns::Double (0.)),
+                             "A list of base values of the thermal conductivity for each of the "
+                             "horizontal layers in the 'p-T-dependent' Thermal conductivity "


Here and all the other parameter descriptions.

Suggested change

"horizontal layers in the 'p-T-dependent' Thermal conductivity "

"horizontal layers in the 'p-T-dependent' thermal conductivity "

gassmoeller · 2023-07-12T22:46:58Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

@@ -209,11 +422,47 @@ namespace aspect
        {
          data_directory              = Utilities::expand_ASPECT_SOURCE_DIR(prm.get ("Data directory"));
          material_file_name          = prm.get ("Material file name");
-          lateral_viscosity_prefactor = prm.get_double ("Lateral viscosity prefactor");
+          lateral_viscosity_prefactor_file_name  = prm.get ("Lateral viscosity prefactor file name");
+          //lateral_viscosity_prefactor = prm.get_double ("Lateral viscosity prefactor");


remove commented line

RanpengLi · 2023-07-13T06:29:38Z

Thank you! I have addressed all the comments and added a changelog.

gassmoeller

Much closer, just a few more comments.

gassmoeller · 2023-07-13T17:49:14Z

benchmarks/entropy_adiabat/plugins/entropy_model.cc

+          const double p_dependence = reference_thermal_conductivities[layer_index] + conductivity_pressure_dependencies[layer_index] * pressure;
+
+          // Make reasonably sure we will not compute any invalid values due to the temperature-dependence.
+          // Since both the temperature-dependence and the saturation term scale with (Tref/T), we have to


time scalehas not been addressed

gassmoeller · 2023-07-13T17:51:37Z

doc/modules/changes/20230712_ranpengli

+Changed: The entropy plugin now includes a plasticity rheology, which can be set by cohesion and frictional angle. It can also use a viscosity prefactor profile, set the lateral viscosity variation limit, and choose p-T dependent conductivity
+
+<br>
+(Ranpeng Li, 2023/07/12)


this file is currently missing a newline at the end of the file. This is an annoying default property of VS code, you can check here how to change the behavior: https://stackoverflow.com/questions/44704968/visual-studio-code-insert-newline-at-the-end-of-files

gassmoeller · 2023-07-13T17:52:23Z

doc/modules/changes/20230712_ranpengli

+Changed: The entropy plugin now includes a plasticity rheology, which can be set by cohesion and frictional angle. It can also use a viscosity prefactor profile, set the lateral viscosity variation limit, and choose p-T dependent conductivity
+
+<br>
+(Ranpeng Li, 2023/07/12)


You probably want to include Juliane as author here as well, or did you do all of these changes on your own?

RanpengLi · 2023-07-13T18:20:47Z

I just fixed them. Sorry!

gassmoeller · 2023-07-13T18:28:03Z

Thanks for addressing the comments. Ready to merge when the testers are done.

gassmoeller · 2023-07-13T19:01:08Z

I think you will have to update the test results (or something changed in the test results)

gassmoeller · 2023-07-13T19:06:30Z

/rebuild

gassmoeller · 2023-07-13T20:17:27Z

It looks like the linux/tests tester also failed, so likely something changed on the main branch. Just update the test results again with the reference tester results and it should pass.

jdannberg added the ready to test label Jul 11, 2023

gassmoeller reviewed Jul 12, 2023

View reviewed changes

gassmoeller reviewed Jul 13, 2023

View reviewed changes

gassmoeller added the ready to merge label Jul 13, 2023

viscosity, thermal conductivity modification

1dabb85

RanpengLi force-pushed the viscosity_change_in_plugin branch from a4b10c5 to 1dabb85 Compare July 13, 2023 21:05

gassmoeller approved these changes Jul 13, 2023

View reviewed changes

gassmoeller merged commit 1f1b1f5 into geodynamics:main Jul 13, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rheology and conductivity modification for the entropy plugin #5254

Rheology and conductivity modification for the entropy plugin #5254

RanpengLi commented Jul 10, 2023 •

edited

gassmoeller commented Jul 11, 2023

gassmoeller left a comment

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 13, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

gassmoeller Jul 12, 2023

RanpengLi commented Jul 13, 2023

gassmoeller left a comment

gassmoeller Jul 13, 2023

gassmoeller Jul 13, 2023

gassmoeller Jul 13, 2023

RanpengLi commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

	// Since both the temperature-dependence and the saturation term scale with (Tref/T), we have to
	// Since both the temperature-dependence and the saturation time scale with (Tref/T), we have to

	"The file name of the lateral viscosity prefactor. ");
	"The file name of the lateral viscosity prefactor.");

	"'p-T-dependent' Thermal conductivity formulation (in most cases, "
	"'p-T-dependent' thermal conductivity formulation (in most cases, "

	"horizontal layers in the 'p-T-dependent' Thermal conductivity "
	"horizontal layers in the 'p-T-dependent' thermal conductivity "

Rheology and conductivity modification for the entropy plugin #5254

Rheology and conductivity modification for the entropy plugin #5254

Conversation

RanpengLi commented Jul 10, 2023 • edited

For all pull requests:

For new features/models or changes of existing features:

gassmoeller commented Jul 11, 2023

gassmoeller left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RanpengLi commented Jul 13, 2023

gassmoeller left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RanpengLi commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

gassmoeller commented Jul 13, 2023

RanpengLi commented Jul 10, 2023 •

edited