From dc5c55f9eb9653ac31ac48583b32c18183bf4eb2 Mon Sep 17 00:00:00 2001 From: Daniel Schwen Date: Tue, 14 Nov 2023 10:12:06 -0700 Subject: [PATCH] Add documentation (#26053) --- ...rpolatedStatefulMaterialPropertyInterface.md | 4 ++++ .../ProjectedStatefulMaterialStorageAction.md | 7 +++++++ .../auxkernels/ProjectedStatefulMaterialAux.md | 15 +++++++++++++++ .../materials/InterpolatedStatefulMaterial.md | 17 +++++++++++++++++ .../NodalPatchRecoveryMaterialProperty.md | 4 +++- ...ojectedStatefulMaterialNodalPatchRecovery.md | 15 +++++++++++++++ .../ProjectedStatefulMaterialStorage/index.md | 9 +++++++++ 7 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 framework/doc/content/source/interfaces/InterpolatedStatefulMaterialPropertyInterface.md create mode 100644 modules/tensor_mechanics/doc/content/source/actions/ProjectedStatefulMaterialStorageAction.md create mode 100644 modules/tensor_mechanics/doc/content/source/auxkernels/ProjectedStatefulMaterialAux.md create mode 100644 modules/tensor_mechanics/doc/content/source/materials/InterpolatedStatefulMaterial.md create mode 100644 modules/tensor_mechanics/doc/content/source/userobjects/ProjectedStatefulMaterialNodalPatchRecovery.md create mode 100644 modules/tensor_mechanics/doc/content/syntax/ProjectedStatefulMaterialStorage/index.md diff --git a/framework/doc/content/source/interfaces/InterpolatedStatefulMaterialPropertyInterface.md b/framework/doc/content/source/interfaces/InterpolatedStatefulMaterialPropertyInterface.md new file mode 100644 index 000000000000..dce79df9e317 --- /dev/null +++ b/framework/doc/content/source/interfaces/InterpolatedStatefulMaterialPropertyInterface.md @@ -0,0 +1,4 @@ +# InterpolatedStatefulMaterialPropertyInterface + +The InterpolatedStatefulMaterialPropertyInterface provides the `getInterpolatedMaterialPropertyOld` +and `getInterpolatedMaterialPropertyOldByName` methods. This is likely to get integrated into the `MaterialPropertyInterface`. diff --git a/modules/tensor_mechanics/doc/content/source/actions/ProjectedStatefulMaterialStorageAction.md b/modules/tensor_mechanics/doc/content/source/actions/ProjectedStatefulMaterialStorageAction.md new file mode 100644 index 000000000000..6fbe2e82972c --- /dev/null +++ b/modules/tensor_mechanics/doc/content/source/actions/ProjectedStatefulMaterialStorageAction.md @@ -0,0 +1,7 @@ +# ProjectedStatefulMaterialStorageAction + +## Description + +The `ProjectedStatefulMaterialStorageAction` is the main action in the [ProjectedStatefulMaterialStorage](/ProjectedStatefulMaterialStorage/index.md) system which sets up all necessary objects to project material property components onto nodal or elemental basis functions. + +To be expanded. diff --git a/modules/tensor_mechanics/doc/content/source/auxkernels/ProjectedStatefulMaterialAux.md b/modules/tensor_mechanics/doc/content/source/auxkernels/ProjectedStatefulMaterialAux.md new file mode 100644 index 000000000000..053ca642913b --- /dev/null +++ b/modules/tensor_mechanics/doc/content/source/auxkernels/ProjectedStatefulMaterialAux.md @@ -0,0 +1,15 @@ +# ProjectedStatefulMaterialAux + +This AuxKernel simply returns the value of a given material property at a quadrature point with the purpose of projecting the property onto an elemental basis function (e.g. first order monomial). + +At step zero this object will compute the material QP values by explicitly calling `initStatefulProperties` in order to project the state that will correspond to the *old state* in the first timestep. + +This object is set up by the [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md). + +!syntax description /AuxKernels/ProjectedStatefulMaterialAux + +!syntax parameters /AuxKernels/ProjectedStatefulMaterialAux + +!syntax inputs /AuxKernels/ProjectedStatefulMaterialAux + +!syntax children /AuxKernels/ProjectedStatefulMaterialAux diff --git a/modules/tensor_mechanics/doc/content/source/materials/InterpolatedStatefulMaterial.md b/modules/tensor_mechanics/doc/content/source/materials/InterpolatedStatefulMaterial.md new file mode 100644 index 000000000000..8ad2f727e6c1 --- /dev/null +++ b/modules/tensor_mechanics/doc/content/source/materials/InterpolatedStatefulMaterial.md @@ -0,0 +1,17 @@ +# InterpolatedStatefulMaterial + +!syntax description /Materials/InterpolatedStatefulMaterial + +## Description + +`InterpolatedStatefulMaterial` reconstitutes the old state of a material property from the old state of the AuxVariables holding the projected components of the material property. + +This object is set up by the [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md). + +!syntax parameters /Materials/InterpolatedStatefulMaterial + +!syntax inputs /Materials/InterpolatedStatefulMaterial + +!syntax children /Materials/InterpolatedStatefulMaterial + +!bibtex bibliography diff --git a/modules/tensor_mechanics/doc/content/source/userobjects/NodalPatchRecoveryMaterialProperty.md b/modules/tensor_mechanics/doc/content/source/userobjects/NodalPatchRecoveryMaterialProperty.md index acbbb7055977..9b02bcd750ae 100644 --- a/modules/tensor_mechanics/doc/content/source/userobjects/NodalPatchRecoveryMaterialProperty.md +++ b/modules/tensor_mechanics/doc/content/source/userobjects/NodalPatchRecoveryMaterialProperty.md @@ -1,4 +1,6 @@ -# Nodal Patch Recovery RankTwoAux +# NodalPatchRecoveryMaterialProperty + +This user object performs the calculations and parallel communication to perform the Zienkiewicz-Zhu nodal patch recovery for a scalar component of a provided material property. Supported material property types are listed in[IndexableProperty](IndexableProperty.md). !syntax description /UserObjects/NodalPatchRecoveryMaterialProperty diff --git a/modules/tensor_mechanics/doc/content/source/userobjects/ProjectedStatefulMaterialNodalPatchRecovery.md b/modules/tensor_mechanics/doc/content/source/userobjects/ProjectedStatefulMaterialNodalPatchRecovery.md new file mode 100644 index 000000000000..debf7471254a --- /dev/null +++ b/modules/tensor_mechanics/doc/content/source/userobjects/ProjectedStatefulMaterialNodalPatchRecovery.md @@ -0,0 +1,15 @@ +# ProjectedStatefulMaterialNodalPatchRecovery + +This user object is derived from [NodalPatchRecoveryMaterialProperty](NodalPatchRecoveryMaterialProperty.md) and performs patch recovery for a material property component. + +At step zero this object will compute the material QP values by explicitly calling `initStatefulProperties` in order to project the state that will correspond to the *old state* in the first timestep. + +This object is set up by the [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md). + +!syntax description /UserObjects/NodalPatchRecoveryMaterialProperty + +!syntax parameters /UserObjects/NodalPatchRecoveryMaterialProperty + +!syntax inputs /UserObjects/NodalPatchRecoveryMaterialProperty + +!syntax children /UserObjects/NodalPatchRecoveryMaterialProperty diff --git a/modules/tensor_mechanics/doc/content/syntax/ProjectedStatefulMaterialStorage/index.md b/modules/tensor_mechanics/doc/content/syntax/ProjectedStatefulMaterialStorage/index.md new file mode 100644 index 000000000000..2c5c0c7c50f7 --- /dev/null +++ b/modules/tensor_mechanics/doc/content/syntax/ProjectedStatefulMaterialStorage/index.md @@ -0,0 +1,9 @@ +# ProjectedStatefulMaterialStorage System + +The `ProjectedStatefulMaterialStorage` Action sets up the required objects to perform fracture integrals. See the documentation for [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md) for details. + +!syntax list /ProjectedStatefulMaterialStorage objects=True actions=False subsystems=False + +!syntax list /ProjectedStatefulMaterialStorage objects=False actions=False subsystems=True + +!syntax list /ProjectedStatefulMaterialStorage objects=False actions=True subsystems=False