Skip to content

Commit

Permalink
Add a doco file since the MaterialOutputAciton is now registered to a…
Browse files Browse the repository at this point in the history
… syntax
  • Loading branch information
GiudGiud committed Jan 22, 2025
1 parent 45ea0f2 commit 09a6922
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
9 changes: 9 additions & 0 deletions framework/doc/content/source/actions/MaterialOutputAction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# MaterialOutputAction

!syntax description /Outputs/MaterialOutputAction

This [Action.md] is used to output the material properties computed by a [Material](syntax/Materials/index.md)
or a [FunctorMaterial](syntax/FunctorMaterials/index.md) to an auxiliary variable.
Vector, tensor, and array-valued properties can be output to variables prefixed with the component or index.

!syntax parameters /Outputs/MaterialOutputAction
2 changes: 2 additions & 0 deletions framework/src/actions/MaterialOutputAction.C
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ InputParameters
MaterialOutputAction::validParams()
{
InputParameters params = Action::validParams();
params.addClassDescription("Outputs material properties to various Outputs objects, based on the "
"parameters set in each Material");
/// A flag to tell this action whether or not to print the unsupported properties
/// Note: A derived class can set this to false, override materialOutput and output
/// a particular property that is not supported by this class.
Expand Down

0 comments on commit 09a6922

Please sign in to comment.