Update parameter descriptions to use new API #397

HiddenRoom · 2024-07-03T20:21:27Z

Using param.setDocUnit(...) to document the units of parameters that currently have units listed in their descriptions. This causes the units to show up in a separate part of the documentation page.

…b#396

bwspenc · 2024-07-03T20:45:24Z

src/materials/ConcreteASREigenstrain.C

@@ -275,7 +278,7 @@ ConcreteASREigenstrain::computeResidual(unsigned qp, Real scalar)
  // Convert current temperature to Kelvin
  const Real T = _temperature[qp] + _temp_offset;

-  // ASR characteristic and latency times (in days)
+  // ASR characteristic and latency times (in )


Leave this one as it was. Same with the one below (Line 315)

bwspenc · 2024-07-03T20:45:57Z

src/materials/ConcreteExpansionMicrocrackingDamage.C

-      "microcracking_initiation_strain",
-      "microcracking_initiation_strain > 0",
-      "Linear strain at which the microcracking initiates (in [m/m])");
+  // WGA - [m/m] ???


Strain is unitless, so just don't even set it.

bwspenc · 2024-07-03T20:47:13Z

src/materials/DamagePlasticityStressUpdate.C

@@ -39,6 +39,7 @@ DamagePlasticityStressUpdate::validParams()
      "ft_ep_slope_factor_at_zero_ep",
      "ft_ep_slope_factor_at_zero_ep <= 1 & ft_ep_slope_factor_at_zero_ep >= 0",
      "slope of ft vs plastic strain curve at zero plastic strain");
+  // WGA - unit needed for this?


Damage is unitless. Stress and strain have units, but I believe we're flexible on what system the user chooses.

bwspenc · 2024-07-03T20:48:50Z

src/materials/ConcreteLogarithmicCreepModel.C

-  params.addCoupledVar("temperature", "Temperature variable [in Celsius]");
+  // WGA - using 0C for degrees celcius
+  params.addCoupledVar("temperature", "Temperature variable");
+  params.setDocUnit("temperature", "0C");


I think we just use "C" for Celsius, but need to confirm.

bwspenc · 2024-07-12T21:28:04Z

src/materials/ConcreteASREigenstrain.C

-                                "Latency ASR time (in days) at reference temprature (tau_L(T_0))");
+                                "Latency ASR time at reference temprature (tau_L(T_0))");
+  params.setDocUnit("latency_time", "d");
+  // WGA - energy units?


The units for characteristic_activation_energy and latency_activation_energy are K. That's a little odd since they're temperature rather than energy units, so it's not really quite right to call them energies, but that's how the model is.

I'd also suggest adding these two in the appropriate locations. I'm not sure if the API will support this, but I want to capture that we need to deal with this:

params.setDocUnit("temperature", "Unit defined by 'temperature_units'"); params.setDocUnit("reference_temperature", "Unit defined by 'temperature_units'");

src/materials/ConcreteExpansionEigenstrainBase.C

bwspenc · 2024-07-12T21:35:06Z

src/materials/ConcreteExpansionMicrocrackingDamage.C

-      "Linear strain at which the microcracking initiates (in [m/m])");
+  params.addRequiredRangeCheckedParam<Real>("microcracking_initiation_strain",
+                                            "microcracking_initiation_strain > 0",
+                                            "Linear strain at which the microcracking initiates (in [m/m])");


Suggested change

"Linear strain at which the microcracking initiates (in [m/m])");

"Linear strain at which the microcracking initiates");

Strain is unitless, so defining it in m/m isn't really helpful in my opinion. Same goes for the microcracking_strain_branch parameter below.

bwspenc · 2024-07-12T21:36:23Z

src/materials/ConcreteLogarithmicCreepModel.C

@@ -38,11 +38,15 @@ ConcreteLogarithmicCreepModel::validParams()
                                    1,
                                    "long_term_characteristic_time > 0",
                                    "Rate at which the long_term viscosity increases");
-  params.addCoupledVar("temperature", "Temperature variable [in Celsius]");
+  // WGA - using C for degrees celcius


Suggested change

// WGA - using C for degrees celcius

Also, some of the parameters above need units:

params.setDocUnit("youngs_modulus", "Model-specific stress unit"); params.setDocUnit("recoverable_youngs_modulus", "Model-specific stress unit"); params.setDocUnit("recoverable_viscosity", "Model-specific time unit"); params.setDocUnit("long_term_viscosity", "Model-specific time unit"); params.setDocUnit("long_term_characteristic_time", "Model-specific time unit");

src/materials/ConcreteLogarithmicCreepModel.C

src/materials/ConcreteThermalMoisture.C

moosebuild · 2024-07-15T18:53:06Z

Job Precheck on 6c53cdf wanted to post the following:

Your code requires style changes.

A patch was auto generated and copied here
You can directly apply the patch by running, in the top level of your repository:

curl -s https://mooseframework.inl.gov/blackbear/docs/PRs/397/clang_format/style.patch | git apply -v

Alternatively, with your repository up to date and in the top level of your repository:

git clang-format 5abd7fd40683c59900039aeaa55c5a602db79d24

bwspenc

All of the prior comments that are not marked as resolved should still be addressed too.

bwspenc · 2024-07-16T21:45:03Z

src/materials/ConcreteExpansionEigenstrainBase.C

@@ -24,12 +24,16 @@ ConcreteExpansionEigenstrainBase::validParams()
      "expansion_type", expansion_type, "Type of expansion resulting from volumetric strain");
  params.addRangeCheckedParam<Real>(
      "compressive_strength", "compressive_strength > 0", "Compressive strength of concrete");
+  // WGA - unclear if units are needed?


Delete this comment now.

Co-authored-by: Ben Spencer <[email protected]>

Triggered by CIVET job https://civet.inl.gov/job/2312477

Triggered by CIVET job https://civet.inl.gov/job/2315029

Triggered by CIVET job https://civet.inl.gov/job/2320969

Triggered by CIVET job https://civet.inl.gov/job/2323264

Triggered by CIVET job https://civet.inl.gov/job/2325808

Triggered by CIVET job https://civet.inl.gov/job/2328699

Triggered by CIVET job https://civet.inl.gov/job/2330312

Triggered by CIVET job https://civet.inl.gov/job/2333183

Refs [idaholab/moose#27605](idaholab/moose#27605)

Triggered by CIVET job https://civet.inl.gov/job/2334480

Co-authored-by: Ben Spencer <[email protected]>

bwspenc

Thanks for fixing those up!
There are still a couple of changes to be made. Also, the moose and neml submodules shouldn't be modified by this PR. I can show you how to undo those.

bwspenc · 2024-07-24T16:07:02Z

src/materials/ConcreteThermalMoisture.C

+  params.addParam<Real>("cement_mass", "cement mass per m^3");
+  params.setDocUnit("cement_mass", "kg");
+  params.addParam<Real>("aggregate_mass", "aggregate mass per m^3");
+  params.setDocUnit("aggregate_mass", "kg");
  params.addParam<Real>("water_to_cement_ratio", "water to cement ratio");
  params.addParam<Real>("aggregate_vol_fraction", "volumetric fraction of aggregates");
  params.addParam<Real>("concrete_cure_time", "concrete curing time in days");


This change is still needed.

bwspenc · 2024-07-24T16:09:00Z

test/tests/concrete_drying_shrinkage/tests

@@ -7,23 +7,23 @@
    [shrinkage]
      type = 'Exodiff'
      input = 'shrinkage.i'
-#      abs_zero = 1e-5
+      abs_zero = 2e-5


This file shouldn't be changed. There was another commit that got merged in that modified these.

bwspenc · 2024-07-24T16:11:09Z

test/tests/concrete_expansion_microcracking/tests

@@ -68,7 +68,7 @@
      type = 'CSVDiff'
      input = 'concrete_expansion_microcracking.i'
      csvdiff = 'concrete_expansion_microcracking_5_5_out.csv'
-      abs_zero = 1e-6
+      abs_zero = 2e-6


This file shouldn't be changed either.

William Adelman and others added 4 commits July 3, 2024 11:09

WIP - param.setDocUnit(...) for units for relevant params

0bfce67

Merge branch 'idaholab:devel' into units

9a630e7

WIP - param.setDocUnit(...) for units for relevant params ref idahola…

6ede39d

…b#396

autogenerated style changes

168b001

bwspenc requested changes Jul 3, 2024

View reviewed changes

requested changes

7fc5b8d

bwspenc requested changes Jul 12, 2024

View reviewed changes

William Adelman added 2 commits July 15, 2024 12:47

clarify ambiguity in temperatures and add energy units

e9a1316

add strength and stress units

6c53cdf

updated strain to be unitless

eea17f3

bwspenc requested changes Jul 16, 2024

View reviewed changes

HiddenRoom and others added 18 commits July 18, 2024 15:15

typo

194b8e1

Co-authored-by: Ben Spencer <[email protected]>

Updating stable moose submodule refs #000

48c1392

Triggered by CIVET job https://civet.inl.gov/job/2312477

Updating stable moose submodule refs #000

048f33f

Triggered by CIVET job https://civet.inl.gov/job/2315029

Updating stable moose submodule refs #000

8020fc4

Triggered by CIVET job https://civet.inl.gov/job/2320969

Updating stable moose submodule refs #000

0479c15

Triggered by CIVET job https://civet.inl.gov/job/2323264

Updating stable moose submodule refs #000

db7bb31

Triggered by CIVET job https://civet.inl.gov/job/2325808

Update NEML submodule ref idaholab#66

b5df938

Updating stable moose submodule refs #000

aa528b4

Triggered by CIVET job https://civet.inl.gov/job/2328699

Updating stable moose submodule refs #000

4607275

Triggered by CIVET job https://civet.inl.gov/job/2330312

Updating stable moose submodule refs #000

75fe0cb

Triggered by CIVET job https://civet.inl.gov/job/2333183

Bump some tolerances in concrete tests

faf07cb

Refs [idaholab/moose#27605](idaholab/moose#27605)

Updating stable moose submodule refs #000

ec3ebbb

Triggered by CIVET job https://civet.inl.gov/job/2334480

Additional units and clarifaction

fdc35f0

Update src/materials/ConcreteThermalMoisture.C

175d5b9

Co-authored-by: Ben Spencer <[email protected]>

Update src/materials/ConcreteThermalMoisture.C

3b392f4

Co-authored-by: Ben Spencer <[email protected]>

Update src/materials/ConcreteThermalMoisture.C

4fdc4b1

Co-authored-by: Ben Spencer <[email protected]>

Update src/materials/ConcreteThermalMoisture.C

500568d

Co-authored-by: Ben Spencer <[email protected]>

remove comment

a59aeb0

Celcius units

9075c74

bwspenc reviewed Jul 24, 2024

View reviewed changes

cure time units

679ae58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update parameter descriptions to use new API #397

Update parameter descriptions to use new API #397

HiddenRoom commented Jul 3, 2024

bwspenc Jul 3, 2024

bwspenc Jul 3, 2024

bwspenc Jul 3, 2024

bwspenc Jul 3, 2024

bwspenc Jul 12, 2024

bwspenc Jul 12, 2024

bwspenc Jul 12, 2024

bwspenc Jul 12, 2024

bwspenc Jul 12, 2024

moosebuild commented Jul 15, 2024

bwspenc left a comment

bwspenc Jul 16, 2024

bwspenc left a comment

bwspenc Jul 24, 2024

bwspenc Jul 24, 2024

bwspenc Jul 24, 2024

	"Linear strain at which the microcracking initiates (in [m/m])");
	"Linear strain at which the microcracking initiates");

Update parameter descriptions to use new API #397

Are you sure you want to change the base?

Update parameter descriptions to use new API #397

Conversation

HiddenRoom commented Jul 3, 2024

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

moosebuild commented Jul 15, 2024

bwspenc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bwspenc 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