Generic system scalar Depends on PR#328

[ke7kto]

Adds a generic system scalar kernel that handles the time-dependent mass balance of system components. Closes #329
Depends on PR#328

Reason

The fuel cycle examples are unwieldy and prone to copy-paste errors. Adding a custom scalar kernel will allow easier extensibility for specific component and system modeling.

Design

A new templated kernel which allows functor inputs and coupled variables to determine the residual. Assumes first-order dependence on "input" variables.

Impact

Re-implements the fuel cycle capabilities in a more explicit way.

[ke7kto]

This should be ready-to-go, but it depends on an open PR

[moosebuild]

Job Documentation, step Sync to remote on ec9d175 wanted to post the following:

View the site here

This comment will be updated on new commits.

[simopier]

You can rebase this PR now that #328 is merged.

[simopier]

@ke7kto, how do you want to tackle this? Do you want to fix the tests or should I start reviewing this?

[simopier]

Need any help on this one, @ke7kto?

[simopier]

Thank you! This will indeed make fuel cycle simulations much easier to set up!

I left some comments throughout. Also, these two tests are failing in recover mode:

[0.588s] [ 135MB]     DIFF test:fuel_cycle_Abdou.fuel_cycle_kernel FAILED (CSVDIFF) [recover]
[0.596s] [ 101MB]     DIFF test:fuel_cycle_Abdou.fuel_cycle_kernel_AD FAILED (CSVDIFF) [recover]

which I imagine highlights an issue with _is_implicit. But the ss_kernel tests pass, so I'm not currently sure.

[moosebuild]

Job Precheck, step Format Check Clang on b510a23 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/tmap8/docs/PRs/334/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 c94cbdde2a25c92d4c9413ef45131bd24200eb3a

[moosebuild]

Job Precheck, step Python: black format on b510a23 wanted to post the following:

Python black formatting

Your code requires style changes.

A patch was generated and copied here.

You can directly apply the patch by running the following at the top level of your repository:

curl -s https://mooseframework.inl.gov/tmap8/docs/PRs/334/black/black.patch | git apply -v

Alternatively, you can run the following at the top level of your repository:

black --config pyproject.toml --workers 1 .

[moosebuild]

Job Coverage, step Generate coverage on ec9d175 wanted to post the following:

Coverage

	c94cbd	#334 ec9d17
	Total	Total	+/-	New
Rate	91.37%	91.74%	+0.38%	100.00%
Hits	1090	1178	+88	110
Misses	103	106	+3	0

Diff coverage report

Full coverage report

This comment will be updated on new commits.

[simopier]

A minor fix.
Also, could you add a section towards the end of the documentation that explains the different input files and how they connect to each other, and how to run a case?

I think this is valuable to users.

[simopier]

Thank you @ke7kto, I have two comments regarding the documentation, things look great otherwise.

[moosebuild]

Job Build test summary, step Build test summary on ec9d175 wanted to post the following:

Test summary

Compared against c94cbdd in job civet.inl.gov/job/3717731.

Added tests

Test	Time (s)	Memory (MB)
test:fuel_cycle_Abdou.fuel_cycle_kernel	3.89	90.91
test:fuel_cycle_Abdou.fuel_cycle_kernel_AD	1.60	57.57
test:fuel_cycle_Abdou.fuel_cycle_kernel_ss	0.58	40.03
test:fuel_cycle_Abdou.fuel_cycle_kernel_implicit	0.49	49.09
test:fuel_cycle_Abdou.fuel_cycle_kernel_implicit_ss	0.35	20.83
test:fuel_cycle_Abdou.fuel_cycle_kernel_invalid_coupling	0.27	30.94
test:fuel_cycle_Abdou.fuel_cycle_kernel_inputs_mismatch	0.27	0.00

[simopier]

Looks good to me, thank you @ke7kto, this will make fuel cycle calculations much simpler to set up!