LayeredExtremumMaterialProperty

Compute material property extrema over layers.

How to define the layers

See the LayeredAverage documentation.

How to retrieve the result

The result of a LayeredExtremumMaterialProperty computation can be saved in an auxiliary variable using a SpatialUserObjectAux. It can be output to a CSV file using a SpatialUserObjectVectorPostprocessor.

Additional computation options

See the LayeredAverage documentation for more sampling option. The averaging operation is replaced by an extremum (min or max) operation.

Example input syntax

In this example, the minimum of material property mat is taken over the whole domain in direction y over ten layers. The result of this averaging in stored in the variable layered_extremum using a SpatialUserObjectAux, and output to a CSV file using a SpatialUserObjectVectorPostprocessor

[UserObjects]
  [layered_uo]
    type = LayeredExtremumMaterialProperty
    direction = y
    num_layers = 10
    mat_prop = mat
    value_type = 'min'
    execute_on = 'INITIAL LINEAR'
  []
[]

[AuxKernels]
  [liaux]
    type = SpatialUserObjectAux
    variable = layered_extremum
    user_object = layered_uo
    execute_on = 'INITIAL LINEAR'
  []
[]

[VectorPostprocessors]
  [output]
    type = SpatialUserObjectVectorPostprocessor
    userobject = layered_uo
  []
[]
(moose/test/tests/userobjects/layered_extremum/layered_extremum_matprop.i)

Input Parameters

  • mat_propMaterial property for which to find the extreme

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:Material property for which to find the extreme

  • value_typeType of extreme value to return: 'max' returns the maximum value and 'min' returns the minimum value.

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:max, min

    Controllable:No

    Description:Type of extreme value to return: 'max' returns the maximum value and 'min' returns the minimum value.

Required Parameters

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The list of block ids (SubdomainID) that this object will be applied

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, TRANSFER

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • layer_bounding_blockList of block ids (SubdomainID) that are used to determine the upper and lower geometric bounds for all layers. If this is not specified, the ids specified in 'block' are used for this purpose.

    C++ Type:std::vector<SubdomainName>

    Unit:(no unit assumed)

    Controllable:No

    Description:List of block ids (SubdomainID) that are used to determine the upper and lower geometric bounds for all layers. If this is not specified, the ids specified in 'block' are used for this purpose.

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Unit:(no unit assumed)

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • average_radius1When using 'average' sampling this is how the number of values both above and below the layer that will be averaged.

    Default:1

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:When using 'average' sampling this is how the number of values both above and below the layer that will be averaged.

  • cumulativeFalseWhen true the value in each layer is the sum of the values up to and including that layer

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When true the value in each layer is the sum of the values up to and including that layer

  • positive_cumulative_directionTrueWhen 'cumulative' is true, whether the direction for summing the cumulative value is the positive direction or negative direction

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:When 'cumulative' is true, whether the direction for summing the cumulative value is the positive direction or negative direction

  • sample_typedirectHow to sample the layers. 'direct' means get the value of the layer the point falls in directly (or average if that layer has no value). 'interpolate' does a linear interpolation between the two closest layers. 'average' averages the two closest layers.

    Default:direct

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:direct, interpolate, average

    Controllable:No

    Description:How to sample the layers. 'direct' means get the value of the layer the point falls in directly (or average if that layer has no value). 'interpolate' does a linear interpolation between the two closest layers. 'average' averages the two closest layers.

Value Sampling / Aggregating Parameters

  • boundsThe 'bounding' positions of the layers i.e.: '0, 1.2, 3.7, 4.2' will mean 3 layers between those positions.

    C++ Type:std::vector<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The 'bounding' positions of the layers i.e.: '0, 1.2, 3.7, 4.2' will mean 3 layers between those positions.

  • directionThe direction of the layers.

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:x, y, z

    Controllable:No

    Description:The direction of the layers.

  • direction_maxMaximum coordinate along 'direction' that bounds the layers

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Maximum coordinate along 'direction' that bounds the layers

  • direction_minMinimum coordinate along 'direction' that bounds the layers

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Minimum coordinate along 'direction' that bounds the layers

  • num_layersThe number of layers.

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of layers.

Layers Extent And Definition Parameters