- functorFunctor to evaluate to assign points/elements to the bins. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
C++ Type:MooseFunctorName
Unit:(no unit assumed)
Controllable:No
Description:Functor to evaluate to assign points/elements to the bins. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.
- max_valueMaximum value of the functor for the binning
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Maximum value of the functor for the binning
- min_valueMinimum value of the functor for the binning
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Minimum value of the functor for the binning
- num_binsNumber of uniform bins in functor values
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Number of uniform bins in functor values
FunctorBinnedValuesDivision
Divide the mesh along based on uniformly binned values of a functor.
The number of divisions is simply equal to the number of bins.
Points that lie outside the (min_value, max_value) interval may be assigned to the outer bins using the "assign_out_of_bounds_to_extreme_bins" parameter.
The FunctorBinnedValuesDivision will bin elements using the ElemArg functor argument. Where this is evaluated depends on the functor, but tends to be at the element vertex average (approximation of the centroid). The FunctorBinnedValuesDivision will bin points using the ElemPointArg functor argument. The evaluation is also functor-implementation dependent. The element is located using the mesh point locator. If the point is located near several elements, then the one with the lowest ID is used.
commentnote
For points laying within the standard tolerance of an internal boundary of the bins, this object will output a warning. If you do not mind the indetermination on which bins they belong to but do mind that a warning is output, please reach out to a MOOSE (or any MOOSE app) developer.
Input Parameters
- assign_out_of_bounds_to_extreme_binsFalseWhether to map functor values outside of the [min,max] range to the lowest and highest bins, or to use the invalid division index
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to map functor values outside of the [min,max] range to the lowest and highest bins, or to use the invalid division index
Optional Parameters
- 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:No
Description:Set the enabled status of the MooseObject.