Skip to content

Commit

Permalink
Fix docs (idaholab#26053)
Browse files Browse the repository at this point in the history
  • Loading branch information
dschwen authored and oanaoana committed Dec 12, 2023
1 parent 347b81e commit 3f9132f
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 19 deletions.
@@ -0,0 +1,15 @@
# ProjectedMaterialPropertyNodalPatchRecoveryAux

This AuxKernel performs nodal patch recovery of a material property component with data prepared by a [ProjectedStatefulMaterialNodalPatchRecovery](ProjectedStatefulMaterialNodalPatchRecovery.md) object with the purpose of projecting the property onto a nodal basis function (e.g. first order Lagrange).

This object is set up by the [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md).

See also [ProjectedStatefulMaterialAux](ProjectedStatefulMaterialAux.md) for the AuxKernel that projects onto elemental basis functions.

!syntax description /AuxKernels/ProjectedMaterialPropertyNodalPatchRecoveryAux

!syntax parameters /AuxKernels/ProjectedMaterialPropertyNodalPatchRecoveryAux

!syntax inputs /AuxKernels/ProjectedMaterialPropertyNodalPatchRecoveryAux

!syntax children /AuxKernels/ProjectedMaterialPropertyNodalPatchRecoveryAux
@@ -1,15 +1,27 @@
# ProjectedStatefulMaterialAux
# ProjectedStatefulMaterial...Aux

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).
This AuxKernel simply returns the value of a given material property (or component of the property value) at a quadrature point with the purpose of projecting the property onto an elemental basis function (e.g. first order monomial).

Variants include:
- `ProjectedStatefulMaterialRealAux`
- `ProjectedStatefulMaterialRealVectorValueAux`
- `ProjectedStatefulMaterialRankTwoTensorAux`
- `ProjectedStatefulMaterialRankFourTensorAux`
- `ADProjectedStatefulMaterialRealAux`
- `ADProjectedStatefulMaterialRealVectorValueAux`
- `ADProjectedStatefulMaterialRankTwoTensorAux`
- `ADProjectedStatefulMaterialRankFourTensorAux`

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
See also [ProjectedMaterialPropertyNodalPatchRecoveryAux](ProjectedMaterialPropertyNodalPatchRecoveryAux.md) for the AuxKernel that projects onto nodal basis functions.

!syntax description /AuxKernels/ProjectedStatefulMaterialRealAux

!syntax parameters /AuxKernels/ProjectedStatefulMaterialAux
!syntax parameters /AuxKernels/ProjectedStatefulMaterialRealAux

!syntax inputs /AuxKernels/ProjectedStatefulMaterialAux
!syntax inputs /AuxKernels/ProjectedStatefulMaterialRealAux

!syntax children /AuxKernels/ProjectedStatefulMaterialAux
!syntax children /AuxKernels/ProjectedStatefulMaterialRealAux
@@ -1,17 +1,23 @@
# InterpolatedStatefulMaterial
# InterpolatedStatefulMaterial...

!syntax description /Materials/InterpolatedStatefulMaterial
!syntax description /Materials/InterpolatedStatefulMaterialReal

## 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.

Variants include:
- `InterpolatedStatefulMaterialReal`
- `InterpolatedStatefulMaterialRealVectorValue`
- `InterpolatedStatefulMaterialRankTwoTensor`
- `InterpolatedStatefulMaterialRankFourTensor`

This object is set up by the [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md).

!syntax parameters /Materials/InterpolatedStatefulMaterial
!syntax parameters /Materials/InterpolatedStatefulMaterialReal

!syntax inputs /Materials/InterpolatedStatefulMaterial
!syntax inputs /Materials/InterpolatedStatefulMaterialReal

!syntax children /Materials/InterpolatedStatefulMaterial
!syntax children /Materials/InterpolatedStatefulMaterialReal

!bibtex bibliography
@@ -1,15 +1,23 @@
# ProjectedStatefulMaterialNodalPatchRecovery
# ProjectedStatefulMaterialNodalPatchRecovery...

This user object is derived from [NodalPatchRecoveryMaterialProperty](NodalPatchRecoveryMaterialProperty.md) and performs patch recovery for a material property component.
This user object 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 time step.

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.
Variants include:
- `ProjectedStatefulMaterialNodalPatchRecoveryReal`
- `ProjectedStatefulMaterialNodalPatchRecoveryRealVectorValue`
- `ProjectedStatefulMaterialNodalPatchRecoveryRankTwoTensor`
- `ProjectedStatefulMaterialNodalPatchRecoveryRankFourTensor`
- `ADProjectedStatefulMaterialNodalPatchRecoveryReal`
- `ADProjectedStatefulMaterialNodalPatchRecoveryRealVectorValue`
- `ADProjectedStatefulMaterialNodalPatchRecoveryRankTwoTensor`
- `ADProjectedStatefulMaterialNodalPatchRecoveryRankFourTensor`

This object is set up by the [ProjectedStatefulMaterialStorageAction](ProjectedStatefulMaterialStorageAction.md).

!syntax description /UserObjects/NodalPatchRecoveryMaterialProperty
!syntax description /UserObjects/ProjectedStatefulMaterialNodalPatchRecoveryReal

!syntax parameters /UserObjects/NodalPatchRecoveryMaterialProperty
!syntax parameters /UserObjects/ProjectedStatefulMaterialNodalPatchRecoveryReal

!syntax inputs /UserObjects/NodalPatchRecoveryMaterialProperty
!syntax inputs /UserObjects/ProjectedStatefulMaterialNodalPatchRecoveryReal

!syntax children /UserObjects/NodalPatchRecoveryMaterialProperty
!syntax children /UserObjects/ProjectedStatefulMaterialNodalPatchRecoveryReal
Expand Up @@ -30,7 +30,9 @@ InputParameters
ProjectedStatefulMaterialNodalPatchRecoveryBase::validParams()
{
InputParameters params = ElementUserObject::validParams();

params.addClassDescription(
"Prepare patches for use in nodal patch recovery based on a material property for material "
"property states projected onto nodal variables.");
params.addRelationshipManager("ElementSideNeighborLayers",
Moose::RelationshipManagerType::ALGEBRAIC,
[](const InputParameters &, InputParameters & rm_params)
Expand Down

0 comments on commit 3f9132f

Please sign in to comment.