forked from idaholab/moose
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for the vector functor matprop -> auxvariable auxke…
…rnel, refs idaholab#19382
- Loading branch information
Showing
3 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
framework/doc/content/source/auxkernels/FunctorVectorMatPropElementalAux.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# FunctorVectorMatPropElementalAux | ||
|
||
!syntax description /AuxKernels/FunctorVectorMatPropElementalAux | ||
|
||
## Overview | ||
|
||
This object populates an elemental auxiliary variable by evaluating a functor vector | ||
material property with an element argument, and selecting one of its component using the | ||
[!param](/AuxKernels/FunctorVectorMatPropElementalAux/component) parameter. | ||
|
||
!alert note | ||
The version of this material for automatic differentiation (AD) material properties is | ||
`FunctorADVectorMatPropElementalAux`. | ||
|
||
!syntax parameters /AuxKernels/FunctorVectorMatPropElementalAux | ||
|
||
!syntax inputs /AuxKernels/FunctorVectorMatPropElementalAux | ||
|
||
!syntax children /AuxKernels/FunctorVectorMatPropElementalAux |
File renamed without changes.