- metric_variable_nameThe name of the variable based on which clustering will be done
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable based on which clustering will be done
- tolerance_percentageFractional tolerance used to define the acceptable range around the reference value.
C++ Type:double
Unit:(no unit assumed)
Range:tolerance_percentage>0 & tolerance_percentage<1
Controllable:No
Description:Fractional tolerance used to define the acceptable range around the reference value.
- valueThe reference value to decide if an element is close enough to be clustered
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The reference value to decide if an element is close enough to be clustered
ValueRangeHeuristicUserObject
Description
ValueRangeHeuristicUserObject implements the clustering heuristic if the metric variable values of two adjacent elements are both within a range. The range is calculated as
\being{equation} S_{\text{lower}} = (1 - \text{tolerance_percentage}) \times \text{value} \end{equation}
where value and tolerance_percentage are user-provided inputs.
Example Input File
The following input block declares a ValueRangeHeuristicUserObject which is then used by BooleanComboClusteringUserObject where the mesh walking and clustering process is implemented.
[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
[generated_mesh]
type = GeneratedMeshGenerator<<<{"description": "Create a line, square, or cube mesh with uniformly spaced or biased elements.", "href": "../meshgenerators/GeneratedMeshGenerator.html"}>>>
dim<<<{"description": "The dimension of the mesh to be generated"}>>> = 2
nx<<<{"description": "Number of elements in the X direction"}>>> = 10
ny<<<{"description": "Number of elements in the Y direction"}>>> = 10
xmin<<<{"description": "Lower X Coordinate of the generated mesh"}>>> = 0
xmax<<<{"description": "Upper X Coordinate of the generated mesh"}>>> = 10
ymin<<<{"description": "Lower Y Coordinate of the generated mesh"}>>> = 0
ymax<<<{"description": "Upper Y Coordinate of the generated mesh"}>>> = 10
extra_element_integers<<<{"description": "Names of extra element integers"}>>> = 'boolean'
[]
[]
[AuxVariables<<<{"href": "../../syntax/AuxVariables/index.html"}>>>]
[metric_var]
order<<<{"description": "Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)"}>>> = CONSTANT
family<<<{"description": "Specifies the family of FE shape functions to use for this variable"}>>> = MONOMIAL
[]
[cluster_id_aux]
order<<<{"description": "Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)"}>>> = CONSTANT
family<<<{"description": "Specifies the family of FE shape functions to use for this variable"}>>> = MONOMIAL
[]
[]
[AuxKernels<<<{"href": "../../syntax/AuxKernels/index.html"}>>>]
[create_metric]
type = FunctionAux<<<{"description": "Auxiliary Kernel that creates and updates a field variable by sampling a function through space and time.", "href": "../auxkernels/FunctionAux.html"}>>>
variable<<<{"description": "The name of the variable that this object applies to"}>>> = metric_var
function<<<{"description": "The function to use as the value"}>>> = 'sqrt(x*x + y*y)'
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."}>>> = 'TIMESTEP_BEGIN'
[]
[store_element_id]
type=ExtraElementIDAux<<<{"description": "Puts element extra IDs into an aux variable.", "href": "../auxkernels/ExtraElementIDAux.html"}>>>
extra_id_name<<<{"description": "The extra ID name in the mesh"}>>> ="boolean"
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."}>>> = 'TIMESTEP_BEGIN'
variable<<<{"description": "The name of the variable that this object applies to"}>>>=cluster_id_aux
[]
[]
[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
[value_range_1]
type = ValueRangeHeuristicUserObject<<<{"description": "Clusters elements if their value is within the tolerance of the value provided.", "href": "ValueRangeHeuristicUserObject.html"}>>>
metric_variable_name<<<{"description": "The name of the variable based on which clustering will be done"}>>> = 'metric_var'
tolerance_percentage<<<{"description": "Fractional tolerance used to define the acceptable range around the reference value."}>>> = 0.2
value<<<{"description": "The reference value to decide if an element is close enough to be clustered"}>>> = 1
[]
[value_range_2]
type = ValueRangeHeuristicUserObject<<<{"description": "Clusters elements if their value is within the tolerance of the value provided.", "href": "ValueRangeHeuristicUserObject.html"}>>>
metric_variable_name<<<{"description": "The name of the variable based on which clustering will be done"}>>> = 'metric_var'
tolerance_percentage<<<{"description": "Fractional tolerance used to define the acceptable range around the reference value."}>>> = 0.4
value<<<{"description": "The reference value to decide if an element is close enough to be clustered"}>>> = 4
[]
[boolean_combo]
type = BooleanComboClusteringUserObject<<<{"description": "Takes various heuristic user objects and applies a user defined boolean logic operation on them.", "href": "BooleanComboClusteringUserObject.html"}>>>
expression<<<{"description": "boolean logic operation expression"}>>> = "( value_range_2 or value_range_1 )"
id_name<<<{"description": "extra_element_integer_id name"}>>> = "boolean"
[]
[]
[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
type = FEProblem
solve = false
[]
[Executioner<<<{"href": "../../syntax/Executioner/index.html"}>>>]
type = Transient
solve = false
dt = 0.1
num_steps = 2
[]
[Outputs<<<{"href": "../../syntax/Outputs/index.html"}>>>]
exodus<<<{"description": "Output the results using the default settings for Exodus output."}>>> = true
[]Input 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
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.
- 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.