add clustering user obejcts #1201

magnoxemo · 2025-08-27T18:57:23Z

closes #1200 and #1127

adding eeid_adder

include/userobjects/ThresholdHeuristicUserObject.h

include/userobjects/ValueFractionHeuristicUserObject.h

include/userobjects/ValueRangeHeuristicUserObject.h

src/meshgenerators/ParsedElementIDMeshGenerator.C

src/userobjects/BooleanComboClusteringUserObject.C

src/meshgenerators/ParsedElementIDMeshGenerator.C

Co-authored-by: April Novak <novak@berkeley.edu>

…neams-th-coe#1200

test/tests/userobjects/clustering/value_range/tests

src/userobjects/ValueFractionHeuristicUserObject.C

src/userobjects/ThresholdHeuristicUserObject.C

src/meshgenerators/ParsedElementIDMeshGenerator.C

aprilnovak · 2026-01-08T16:50:19Z

test/tests/meshgenerators/parsed_extra_element_integer/test

        cli_args="--mesh-only"
        expect_err="Both 'extra_element_integer_names' and 'values' cannot be empty. Please provide at least one param for each."
-        requirement="Number of entries in values needs to be equal to the number of extra_element_integer_names"
+        requirement="Number of entries in 'values' and 'extra_element_integer_names' must be nonzero"


For SQA purposes, the requirement follows kind of specific conventions. These should be written as "requirements", like "The system shall error if the values for extra element integers is empty." For these RunException-type tests, some notion of the system erroring should be in the test requirement.

moosebuild · 2026-01-08T17:17:58Z

Job Precheck, step Clang format on 93f3bd1 wanted to post the following:

Your code requires style changes.

A patch was auto generated and copied here
You can directly apply the patch by running, in the top level of your repository:

curl -s https://mooseframework.inl.gov/cardinal/docs/PRs/1201/clang_format/style.patch | git apply -v

Alternatively, with your repository up to date and in the top level of your repository:

git clang-format 9810264131e80cf841fb6212c8abec025d4544f2

doc/content/source/userobjects/ValueFractionHeuristicUserObject.md

doc/content/source/userobjects/ValueRangeHeuristicUserObject.md

doc/content/source/userobjects/ValueDifferenceHeuristicUserObject.md

doc/content/source/userobjects/ThresholdHeuristicUserObject.md

test/tests/userobjects/clustering/execptions_and_warnings/tests

aprilnovak · 2026-01-08T22:23:25Z

test/tests/userobjects/clustering/threshold_heuristic/tests

+    type = Exodiff
+    input = example_input.i
+    exodiff = example_input_out.e
+    requirement = "The system shall reproduce the clustering pattern by evaluating a


This is a perfectly-written test requirement! :)

aprilnovak · 2026-01-08T22:26:15Z

I realize now that this PR is actually quite consistent with referring to the variable data as a score. I left a few comments which changed that to value, but perhaps it's worth discussing the name and ignoring my name changes. I could envision a world where we use variable data which might not refer to a tally in which case perhaps value is a bit more generic and recognizable. What do you think? @magnoxemo @nuclearkevin @gonuke

aprilnovak · 2026-01-08T22:28:00Z

src/userobjects/BooleanComboClusteringUserObject.C

+  }
+  // check if mesh is replicated. If not then throw a moose error.
+  if (!_mesh.is_replicated())
+    mooseError("Mesh must be replicated");


Since you have two different mooseError which test for replicated mesh (one in this object, one in ClusterHeuristicUserObjectBase), you should technically have two tests isolating the objects so that you can cover both of these errors - if that is possible?

Agreed. I will add another test to catch this error.

Co-authored-by: April Novak <novak@berkeley.edu>

magnoxemo and others added 30 commits June 6, 2025 18:26

seperating files for PR

5322da1

adding eeid_adder

eb4293c

adding different heuristics

8ed0a40

adding doc string, documentation and addresing comments

8400e8d

adding documentation, doc string

2b5864d

adding input param description in the documentation

d975b90

fixing a typo

0e98599

generating docs

29d05dd

addesing comments

c340fb6

addressing suggestions

8163110

fixing markdown issues, grammars and spellings

95ec3e1

fixing documentation

e3883cc

removing the copy right header

5b13536

removing the copy right header

0cf81db

addessing comments

7802897

addressing comments from @aprilnovak

62bdae6

fixing formating issue

8b275b3

Merge pull request #4 from magnoxemo/eeid_adder

181888c

adding eeid_adder

implementing new code design

e3afcb7

updating the documentation

5806c25

fixing typo

f61d04d

Merge pull request #1 from magnoxemo/continious_test

91f0e4d

seperating files for a PR

df6f70d

deleted not relevant files

6b57364

suggestions from @gonuke

a84fb88

update documentation

44dfebb

fixing a bug

86aceb3

Merge branch 'clustering' into different_heuristics

5a6532f

fixing documentation and renaming things

eb16245

removing undefined heuristics

3e68322