ElementExtremeMaterialPropertyReporter

This reporter computes the minimum or maximum value of a specified material property from all volumetric quadrature points. It reports that extreme value, as well as the coordinates of the point with the extreme value. In addition, it can optionally report the values of other material properties at that point.

Example input syntax

In this example, the minimum and maximum of the material property mat_prop are being sampled by two ElementExtremeMaterialPropertyReporter objects. The values of other material properties are also reported at the locations of those extreme values.

[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
  [mat]
    type = GenericFunctionMaterial<<<{"description": "Material object for declaring properties that are populated by evaluation of Function object.", "href": "../materials/GenericFunctionMaterial.html"}>>>
    prop_names<<<{"description": "The names of the properties this material will have"}>>> = 'mat_prop'
    prop_values<<<{"description": "The corresponding names of the functions that are going to provide the values for the variables"}>>> = 'fn'
  []
  [mat2]
    type = GenericFunctionMaterial<<<{"description": "Material object for declaring properties that are populated by evaluation of Function object.", "href": "../materials/GenericFunctionMaterial.html"}>>>
    prop_names<<<{"description": "The names of the properties this material will have"}>>> = 'mat_prop2'
    prop_values<<<{"description": "The corresponding names of the functions that are going to provide the values for the variables"}>>> = 'fn2'
  []
  [mat3]
    type = GenericFunctionMaterial<<<{"description": "Material object for declaring properties that are populated by evaluation of Function object.", "href": "../materials/GenericFunctionMaterial.html"}>>>
    prop_names<<<{"description": "The names of the properties this material will have"}>>> = 'mat_prop3'
    prop_values<<<{"description": "The corresponding names of the functions that are going to provide the values for the variables"}>>> = 'fn3'
  []
[]

[Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
  [min]
    type = ElementExtremeMaterialPropertyReporter<<<{"description": "Determines the location of the minimum or maximum value of a material property over a volume, and provides its coordinates and optionally other requested data at that location.", "href": "ElementExtremeMaterialPropertyReporter.html"}>>>
    material_property<<<{"description": "Material property for which to find the extreme. The value of this property is always reported."}>>> = mat_prop
    value_type<<<{"description": "Type of extreme value to report: 'max' reports the maximum value and 'min' reports the minimum value."}>>> = min
    execute_on<<<{"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."}>>> = 'INITIAL'
    additional_reported_properties<<<{"description": "Additional material properties reported at the location of the extreme value"}>>> = 'mat_prop2 mat_prop3'
  []
  [max]
    type = ElementExtremeMaterialPropertyReporter<<<{"description": "Determines the location of the minimum or maximum value of a material property over a volume, and provides its coordinates and optionally other requested data at that location.", "href": "ElementExtremeMaterialPropertyReporter.html"}>>>
    material_property<<<{"description": "Material property for which to find the extreme. The value of this property is always reported."}>>> = mat_prop
    value_type<<<{"description": "Type of extreme value to report: 'max' reports the maximum value and 'min' reports the minimum value."}>>> = max
    execute_on<<<{"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."}>>> = 'INITIAL'
    additional_reported_properties<<<{"description": "Additional material properties reported at the location of the extreme value"}>>> = 'mat_prop2 mat_prop3'
  []
[]
(moose/test/tests/reporters/element_extreme_material_property_reporter/element_extreme_material_property_reporter.i)

Input Parameters

  • material_propertyMaterial property for which to find the extreme. The value of this property is always reported.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:Material property for which to find the extreme. The value of this property is always reported.

  • value_typeType of extreme value to report: 'max' reports the maximum value and 'min' reports the minimum value.

    C++ Type:MooseEnum

    Options:max, min

    Controllable:No

    Description:Type of extreme value to report: 'max' reports the maximum value and 'min' reports the minimum value.

Required Parameters

  • additional_reported_propertiesAdditional material properties reported at the location of the extreme value

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Additional material properties reported at the location of the extreme value

  • blockThe list of blocks (ids or names) that this object will be applied

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

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

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

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

  • 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

    Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, 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.

  • 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

    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

    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

    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

    Controllable:No

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

Execution Scheduling Parameters

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

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

    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

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

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

    Default:True

    C++ Type:bool

    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>

    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

    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

    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

  • 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

    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.

Material Property Retrieval Parameters