NekVolumeExtremeValue

Extreme value (max/min) of a field over the NekRS mesh

Description

This postprocessor computes the extreme value (maximum or minimum) of a specified field over the volume of the NekRS mesh. For value_type = max, this postprocessor computes

where is the value of the postprocessor, is the volume of the NekRS mesh, and is the specified field. For value_type = min, this postprocessor instead computes

To be clear, this postprocessor is not evaluated on the NekRSMesh mesh mirror, but instead on the mesh actually used for computation in NekRS. For those familiar with the legacy Nek5000 fortran functions, this postprocessor is equivalent to glamax and glamin.

The field is specified with the field parameter, which may be one of:

  • pressure: pressure

  • temperature: temperature, a.k.a. zeroth passive scalar

  • velocity: magnitude of velocity

  • velocity_x: -component of velocity

  • velocity_y: -component of velocity

  • velocity_z: -component of velocity

  • velocity_x_squared: -component of velocity, squared

  • velocity_y_squared: -component of velocity, squared

  • velocity_z_squared: -component of velocity, squared

  • velocity_component: velocity vector dotted against another vector

  • scalar01: first passive scalar

  • scalar02: second passive scalar

  • scalar03: third passive scalar

  • unity: the value 1.0

Setting field = unity is equivalent to computing 1, since the extreme value of unity is 1 (unity is of more use for other postprocessors).

If running NekRS in non-dimensional form (and you have indicated the appropriate nondimensional scales with the Dimensionalize sub-block for the [Problem]) then the value of this object is shown in dimensional units.

Example Input Syntax

As an example, the max_T postprocessor will evaluate the maximum temperature over the volume of the NekRS mesh.

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [outlet_T]
    type = NekMassFluxWeightedSideAverage<<<{"description": "Mass flux weighted average of a field over a boundary in the NekRS mesh", "href": "NekMassFluxWeightedSideAverage.html"}>>>
    field<<<{"description": "Field to apply this object to"}>>> = temperature
    boundary<<<{"description": "Boundary ID(s) for which to compute the postprocessor"}>>> = '3'
  []
  [max_T]
    type = NekVolumeExtremeValue<<<{"description": "Extreme value (max/min) of a field over the NekRS mesh", "href": "NekVolumeExtremeValue.html"}>>>
    field<<<{"description": "Field to apply this object to"}>>> = temperature
  []
[]
(tutorials/pincell_multiphysics/nek.i)

Input Parameters

  • fieldField to apply this object to

    C++ Type:MooseEnum

    Options:velocity_x, velocity_y, velocity_z, velocity, velocity_component, velocity_x_squared, velocity_y_squared, velocity_z_squared, temperature, pressure, scalar01, scalar02, scalar03, unity, usrwrk00, usrwrk01, usrwrk02

    Controllable:No

    Description:Field to apply this object to

Required Parameters

  • meshallNekRS mesh to compute postprocessor on

    Default:all

    C++ Type:MooseEnum

    Options:fluid, solid, all

    Controllable:No

    Description:NekRS mesh to compute postprocessor on

  • value_typemaxWhether to give the maximum or minimum extreme value

    Default:max

    C++ Type:MooseEnum

    Options:max, min, average

    Controllable:No

    Description:Whether to give the maximum or minimum extreme value

  • velocity_componentuserDirection in which to evaluate velocity when 'field = velocity_component.' Options: user (you then need to specify a direction with 'velocity_direction'); normal

    Default:user

    C++ Type:MooseEnum

    Options:normal, user

    Controllable:No

    Description:Direction in which to evaluate velocity when 'field = velocity_component.' Options: user (you then need to specify a direction with 'velocity_direction'); normal

  • velocity_directionUnit vector to dot with velocity, for 'field = velocity_component'. For example, velocity_direction = '1 1 0' will get the velocity dotted with (1/sqrt(2), 1/sqrt(2), 0).

    C++ Type:libMesh::Point

    Controllable:No

    Description:Unit vector to dot with velocity, for 'field = velocity_component'. For example, velocity_direction = '1 1 0' will get the velocity dotted with (1/sqrt(2), 1/sqrt(2), 0).

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:NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, 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.

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

  • 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

  • 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