ElementExtremeFunctorValue

Finds either the min or max elemental value of a functor over the domain.

You can optionally provide a "proxy_functor", which will change the behavior of this postprocessor to find the element at which the proxy functor reaches the max/min value, and then return the value of the specified functor at that element.

commentnote

Like the ElementExtremeValue postprocessor, this postprocessor can also operate on both elemental and nodal variables. However, unlike the ElementExtremeValue postprocessor, this postprocessor does not examine the quadrature point values, but instead passes the element argument to the functor.

Example Input File Syntax

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [max_u]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = 'u'
  []
  [min_w_f]
    type = ElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = 'w_f'
    value_type<<<{"description": "Type of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value."}>>> = min
  []
  [max_v_x]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = 'v_x'
  []
  [min_v_y]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = 'v_y'
    value_type<<<{"description": "Type of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value."}>>> = min
  []

  # because we set v_x and v_y equal to the x and y coordinates, these two postprocessors
  # should just return the point at which u reaches a maximum value
  [max_v_from_proxy_x]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = v_x
    proxy_functor<<<{"description": "The name of the functor to use to identify the location at which the functor value should be taken; if not provided, this defaults to the 'functor' parameter. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = u
    value_type<<<{"description": "Type of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value."}>>> = max
  []
  [max_v_from_proxy_y]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = v_y
    proxy_functor<<<{"description": "The name of the functor to use to identify the location at which the functor value should be taken; if not provided, this defaults to the 'functor' parameter. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = u
    value_type<<<{"description": "Type of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value."}>>> = max
  []

  # because we set v_x and v_y equal to the x and y coordinates, these two postprocessors
  # should just return the point at which w reaches a minimum value
  [min_v_from_proxy_x]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = v_x
    proxy_functor<<<{"description": "The name of the functor to use to identify the location at which the functor value should be taken; if not provided, this defaults to the 'functor' parameter. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = w
    value_type<<<{"description": "Type of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value."}>>> = min
  []
  [min_v_from_proxy_y]
    type = ADElementExtremeFunctorValue<<<{"description": "Finds either the min or max elemental value of a functor over the domain.", "href": "ElementExtremeFunctorValue.html"}>>>
    functor<<<{"description": "The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = v_y
    proxy_functor<<<{"description": "The name of the functor to use to identify the location at which the functor value should be taken; if not provided, this defaults to the 'functor' parameter. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number."}>>> = w
    value_type<<<{"description": "Type of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value."}>>> = min
  []
[]
(test/tests/postprocessors/element_extreme_functor_value/extreme_proxy_value.i)

Input Parameters

  • functorThe name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the functor for which to find the extrema. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

Required Parameters

  • 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

  • proxy_functorThe name of the functor to use to identify the location at which the functor value should be taken; if not provided, this defaults to the 'functor' parameter. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the functor to use to identify the location at which the functor value should be taken; if not provided, this defaults to the 'functor' parameter. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • scale1Scaling factor to apply to functor value

    Default:1

    C++ Type:Real

    Unit:(no unit assumed)

    Controllable:No

    Description:Scaling factor to apply to functor value

  • value_typemaxType of extreme value to return. 'max' returns the maximum value. 'min' returns the minimum value. 'max_abs' returns the maximum of the absolute value.

    Default:max

    C++ Type:MooseEnum

    Options:max, min, max_abs

    Controllable:No

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

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, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, 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, MULTISYSTEM_FIXED_POINT_ITERATION_END, 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

Input Files