Skip to content

Commit

Permalink
Add documentation (idaholab#26053)
Browse files Browse the repository at this point in the history
  • Loading branch information
dschwen committed Dec 2, 2023
1 parent 3bdf617 commit e417194
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# InterpolatedStatefulMaterialPropertyInterface

The InterpolatedStatefulMaterialPropertyInterface provides the `getInterpolatedMaterialPropertyOld`
and `getInterpolatedMaterialPropertyOldByName` methods. This is likely to get integrated into the `MaterialPropertyInterface`.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e417194

Please sign in to comment.