From 34ee3b991955dea09a890e16c8d30f1d2ab0f2bf Mon Sep 17 00:00:00 2001 From: Guillaume Giudicelli Date: Mon, 15 Nov 2021 20:18:18 -0700 Subject: [PATCH] Add documentation for the vector functor matprop -> auxvariable auxkernel, refs #19382 --- .../auxkernels/FunctorMatPropElementalAux.md | 4 ++++ .../FunctorVectorMatPropElementalAux.md | 19 +++++++++++++++++++ ...> GenericFunctionVectorFunctorMaterial.md} | 0 3 files changed, 23 insertions(+) create mode 100644 framework/doc/content/source/auxkernels/FunctorVectorMatPropElementalAux.md rename framework/doc/content/source/materials/{GenericFunctionVectorFunctorMaterial.C => GenericFunctionVectorFunctorMaterial.md} (100%) diff --git a/framework/doc/content/source/auxkernels/FunctorMatPropElementalAux.md b/framework/doc/content/source/auxkernels/FunctorMatPropElementalAux.md index 4c942b4eb1a8..77f0ec5b0ef3 100644 --- a/framework/doc/content/source/auxkernels/FunctorMatPropElementalAux.md +++ b/framework/doc/content/source/auxkernels/FunctorMatPropElementalAux.md @@ -7,6 +7,10 @@ This object populates an elemental auxiliary variable by evaluating a functor material property with an element argument. +!alert note +The version of this material for automatic differentiation (AD) material properties is +`FunctorADMatPropElementalAux`. + !syntax parameters /AuxKernels/FunctorMatPropElementalAux !syntax inputs /AuxKernels/FunctorMatPropElementalAux diff --git a/framework/doc/content/source/auxkernels/FunctorVectorMatPropElementalAux.md b/framework/doc/content/source/auxkernels/FunctorVectorMatPropElementalAux.md new file mode 100644 index 000000000000..4f4c3a0a2d1b --- /dev/null +++ b/framework/doc/content/source/auxkernels/FunctorVectorMatPropElementalAux.md @@ -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 diff --git a/framework/doc/content/source/materials/GenericFunctionVectorFunctorMaterial.C b/framework/doc/content/source/materials/GenericFunctionVectorFunctorMaterial.md similarity index 100% rename from framework/doc/content/source/materials/GenericFunctionVectorFunctorMaterial.C rename to framework/doc/content/source/materials/GenericFunctionVectorFunctorMaterial.md