Extending axial expansion classes #1920

drewj-tp · 2024-09-30T23:42:49Z

What is the change?

A handful of improvements to allow subclasses of axial expansion things more control. A general theme was to take large methods and break them up so subclasses can override at their discretion.

Some documentation has been added to axial expansion related classes. It's by no means complete, nor to the level of #935. But as I fumbled through the code and got helped from @albeanth, I added what I could to the docstrings.

Why is the change being made?

I am working on features internally that need more control over performing axial expansion that require these changes.

Closes #1453

Closes #1918

Checklist

This PR has only one purpose or idea.
Tests have been added/updated to verify any new/changed code.

The code style follows good practices.
The commit message(s) follow good practices.

The release notes have been updated if necessary.
The documentation is still up-to-date in the doc folder.
The dependencies are still up-to-date in pyproject.toml.

Use early `return` statements to dedent the function. Renamed to `areAxiallyLinked` to be a bit more declarative, even though this function lives in the axial expansion routine. Add some type hints

The values in the linkage dictionaries on `AssemblyAxialLinkage` were lists of two items where the position meant something: `0` for linked item below the current thing, and `1` for linked item above the current thing. Some functionality was based on `links[1] is not None` which is not super readable unless you're familiar with what's going on. This introduces a small data class with two attributes: `lower` and `upper` such that `links.lower is links[0]` and `links.upper is links[1]`. This improves readability and extensibility by making a more explicit and declarative thing. The position-based getters and setters are retained and tested. The class is "templated" with a `typing.Generic[typing.TypeVar]` that could be either `Block` or `Component`. This is because the the two linked dictionaries on the `AssemblyAxialLinkage` class only differ based on the types of their values. We still need to know lower/upper as determined by the values, but for the block link dict we want blocks and then components from the component link dict.

Also rename componentLst to components in setExpansionFactors in an effort to remove type names from variable names

Single method that iterate over all blocks in an assembly and then all components in each block is now broken across a per-block method and a per-component method. This distinction will also allow subclasses to provide specific expansion methods on a more granular level.

The getSolidComponents produces a list which may not be needed in all situations. Lots of usage of getSolidComponents was for iteration, e.g., `for c in getSolidComponents(b)` where producing an iterable is sufficient.

Move docstring to class definition and outside `__init__` for consistency.

Useful for testing what you get is what you expect. Tests added to this effect. Renamed an internal variable from `componentWFlag` to `candidates` because the name implied `componentWFlag` was a single component when it was a (potentially empty) list of components. Finally, bring out the setting of the target component to a separate method. This is useful for subclasses that may need custom logic to determine their target component, but want to perform the same actions on the setter.

Useful for subclasses to override. Calls back to existing function for small code change.

Closes #1453

armi/reactor/converters/axialExpansionChanger/assemblyAxialLinkage.py

…xial-linkage * origin/main: Alphabetizing Flags.toString results (#1912) Organizing test settings files by category (#1914)

This implementation an O(N^2) iteration where each block also iterates over all blocks in the assembly. The use of itertools.chain and itertools.islice provide a more efficient and streamlined iteration look. The call signature is for a `Sequence[Block]` which could just as easily be `Assembly`. We can't use just `Iterable[Block]` because we need to perform multiple iterations on the object at once. And things like a generator may get consumed part way through the iteration. And for testing, passing a list of blocks gets the same behavior as passing one assembly. Tests for zero blocks, one block, and multiple blocks added.

armi/reactor/converters/axialExpansionChanger/assemblyAxialLinkage.py

armi/reactor/converters/axialExpansionChanger/expansionData.py

Co-authored-by: Tony Alberti <[email protected]>

…e' into drewj/improve-assem-axial-linkage * origin/drewj/improve-assem-axial-linkage: Apply suggestions from code review

…inking criteria

Only really provided for back compatability with the existing list API. But this is far enough down the axial expansion API, which already has dubious widespread usage, that we're okay removing this unceremoniously.

…xial-linkage * origin/main: Adding support for ex-core structures (#1891) Fixing edge case in assemblyBlueprint._checkParamConsistency (#1929) Improving the robustness of HexBlock._rotatePins() (#1859) Removing unnecessary column in print-out (#1925) Updating parameter-related docs (#1919)

armi/reactor/converters/tests/test_axialExpansionChanger.py

albeanth · 2024-10-08T19:06:34Z

@john-science this PR is apart of a larger downstream internal change, so please hold off on merging this. thank you!

…xial-linkage * origin/main: Relaxing copyInterfaceInputs to not require a valid Setting (#1934) Moving C5G7 into its own test dir (#1941) Transposing pinMgFluxes so that the leading dimension represents pin index (#1937)

…xial-linkage * origin/main: Removing defunct comment from getPinCoordinates (#1931)

Co-authored-by: Tony Alberti <[email protected]>

…-axial-linkage' into drewj/improve-assem-axial-linkage * refs/remotes/origin/drewj/improve-assem-axial-linkage: Black Update armi/reactor/converters/tests/test_axialExpansionChanger.py

…xial-linkage * origin/main: New plugin hook for before reactor construction (#1945) Removing DoseResultsMapper (#1952) Adding logic so HexAssemblies are hexagonal (#1935) Adding Block.getInputHeight (#1927) Removing Assembly.doubleResolution (#1951) Adding DeprecationWarning for HistoryTrackerInterface (#1950) Removing tabulate as a dependency (#1948)

…xial-linkage * origin/main: Loading some ARMI DBs without the App that created them (#1917) Revert "Revert "Updating cluster settings (#1958)" (#1965)" (#1969) Allowing users to define flag names with digits (#1966) Revert "Updating cluster settings (#1958)" (#1965) Updating cluster settings (#1958) Reducing warnings while building the docs (#1959) Moving anl-afci-177 test files to their own directory (#1957)

john-science · 2024-10-23T15:22:51Z

Holler when you guys want this merged. I see it is doubly approved.

albeanth · 2024-10-23T15:55:57Z

Holler when you guys want this merged. I see it is doubly approved.

This is getting run on additional downstream testing. If all goes well, it should be good to go today. I'll ping you when we're ready.

* main: Skipping XS generation when using tight coupling (#1963) Renaming Database3 to Database, but preserving the API (#1961) Changing default of syncDbAfterWrite to True (#1968) Removing upper bound pin on HDF5 (#1932)

john-science · 2024-10-24T14:12:13Z

@drewj-tp I see this as approved, and we have a release coming up. Any status on when this might get merged?

albeanth · 2024-10-24T14:14:17Z

@drewj-tp I see this as approved, and we have a release coming up. Any status on when this might get merged?

Same status as yesterday. Blocked by downstream testing going awry. @drewj-tp, @mgjarrett, and myself need to troubleshoot today.

…xial-linkage * origin/main: Adding some missing nuclides to nuclides.dat (#1903) Improving efficiency of reaction rate calcs (#1887) Adding description of EOL time node in DB (#1967)

…xial-linkage * origin/main: Ensuring reaction rate parameters are set after calc (#1971)

john-science · 2024-10-28T16:47:29Z

bump

drewj-tp · 2024-10-29T15:37:34Z

bump

I think today's the day!

* main: Fixing HexBlock docstrings (#1981) Removing a duplicate hex rotation impl tag (#1979) Avoiding closing plots that are meant to be interactive (#1978) Ensuring HexBlock.rotate updates child spatial locators (#1943) Add new memory runLog info to memoryProfiler.py (#1970) Fixing various doc build issues (#1974) Hiding sphinx-needs warnings during doc build (#1973) Fixing warnings in CLI startup (#1972)

* main: Extending axial expansion classes (#1920)

drewj-tp added 16 commits September 30, 2024 16:20

Flatten and rename determine axial linkage function

56b81fb

Use early `return` statements to dedent the function. Renamed to `areAxiallyLinked` to be a bit more declarative, even though this function lives in the axial expansion routine. Add some type hints

Only warn about missing linked components if no linked block

727d04d

Streamline check for component axial linkage a bit more

4b9f67d

Add type hints for ExpansionData methods

9e0550d

Also rename componentLst to components in setExpansionFactors in an effort to remove type names from variable names

Combine check for zero and negative expansion factors

bfbdc46

Provide axialExpansionChanger.iterSolidComponents

00ce21e

The getSolidComponents produces a list which may not be needed in all situations. Lots of usage of getSolidComponents was for iteration, e.g., `for c in getSolidComponents(b)` where producing an iterable is sufficient.

Update ExpansionData docstring

fa283cc

Move docstring to class definition and outside `__init__` for consistency.

Add some type hints for AxialExpansionChanger

9a90311

Remove type name from componentLst in favor of components

319e474

Provide and use AssemblyAxialLinkage.areAxiallyLinked

2ddda07

Useful for subclasses to override. Calls back to existing function for small code change.

Skip setting target component for dummy block axial expansion

d93b537

Closes #1453

Update ExpansionData.determineTargetComponent docstring

11352a4

Use _setExpansionTarget in _isFuelLocked

3a785b6

drewj-tp added the enhancement New feature or request label Sep 30, 2024

drewj-tp requested review from john-science and albeanth September 30, 2024 23:42

drewj-tp self-assigned this Sep 30, 2024

drewj-tp commented Sep 30, 2024

View reviewed changes

armi/reactor/converters/axialExpansionChanger/assemblyAxialLinkage.py Show resolved Hide resolved

drewj-tp added 5 commits October 1, 2024 09:00

Release notes

5d39876

Merge remote-tracking branch 'origin/main' into drewj/improve-assem-a…

71f0cb7

…xial-linkage * origin/main: Alphabetizing Flags.toString results (#1912) Organizing test settings files by category (#1914)

Simplify type hints for AssemblyAxialLinkage block and component links

d4080bc

Refactor AssemblyAxialLinkage._getLinkedComponents

0ca94ce

john-science marked this pull request as ready for review October 2, 2024 20:18

john-science reviewed Oct 3, 2024

View reviewed changes

armi/reactor/converters/axialExpansionChanger/assemblyAxialLinkage.py Outdated Show resolved Hide resolved

john-science reviewed Oct 3, 2024

View reviewed changes

armi/reactor/converters/axialExpansionChanger/assemblyAxialLinkage.py Outdated Show resolved Hide resolved

john-science reviewed Oct 3, 2024

View reviewed changes

armi/reactor/converters/axialExpansionChanger/expansionData.py Show resolved Hide resolved

drewj-tp and others added 6 commits October 7, 2024 12:02

Apply suggestions from code review

46a3f55

Co-authored-by: Tony Alberti <[email protected]>

Merge remote-tracking branch 'origin/drewj/improve-assem-axial-linkag…

9b57c06

…e' into drewj/improve-assem-axial-linkage * origin/drewj/improve-assem-axial-linkage: Apply suggestions from code review

Point AssemblyAxialLinkage.areAxiallyLinked doc to the function for l…

e1ccf0e

…inking criteria

Require axially linked components to have identical types

74fcd30

Remove getitem, setitem, iter on AxialLink

1cc156a

Only really provided for back compatability with the existing list API. But this is far enough down the axial expansion API, which already has dubious widespread usage, that we're okay removing this unceremoniously.

albeanth approved these changes Oct 8, 2024

View reviewed changes

armi/reactor/converters/tests/test_axialExpansionChanger.py Outdated Show resolved Hide resolved

john-science and others added 8 commits October 9, 2024 10:54

Merge branch 'main' into drewj/improve-assem-axial-linkage

dbea10c

Merge remote-tracking branch 'origin/main' into drewj/improve-assem-a…

2228880

…xial-linkage * origin/main: Removing defunct comment from getPinCoordinates (#1931)

Update armi/reactor/converters/tests/test_axialExpansionChanger.py

df8ad61

Co-authored-by: Tony Alberti <[email protected]>

Black

7f4c8ff

Merge remote-tracking branch 'refs/remotes/origin/drewj/improve-assem…

83ee423

…-axial-linkage' into drewj/improve-assem-axial-linkage * refs/remotes/origin/drewj/improve-assem-axial-linkage: Black Update armi/reactor/converters/tests/test_axialExpansionChanger.py

Merge branch 'main' into drewj/improve-assem-axial-linkage

ab9b61b

* main: Skipping XS generation when using tight coupling (#1963) Renaming Database3 to Database, but preserving the API (#1961) Changing default of syncDbAfterWrite to True (#1968) Removing upper bound pin on HDF5 (#1932)

john-science changed the title ~~Extensibility improvements to axial expansion classes~~ Extending axial expansion classes Oct 24, 2024

drewj-tp added 2 commits October 24, 2024 09:45

Merge remote-tracking branch 'origin/main' into drewj/improve-assem-a…

e2dc917

…xial-linkage * origin/main: Adding some missing nuclides to nuclides.dat (#1903) Improving efficiency of reaction rate calcs (#1887) Adding description of EOL time node in DB (#1967)

Merge remote-tracking branch 'origin/main' into drewj/improve-assem-a…

71c7497

…xial-linkage * origin/main: Ensuring reaction rate parameters are set after calc (#1971)

john-science merged commit 0a6995b into main Oct 29, 2024
19 checks passed

john-science deleted the drewj/improve-assem-axial-linkage branch October 29, 2024 17:02

drewj-tp added a commit that referenced this pull request Oct 29, 2024

Merge branch 'main' into drewj/bu-eq-rotate

6499707

* main: Extending axial expansion classes (#1920)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extending axial expansion classes #1920

Extending axial expansion classes #1920

drewj-tp commented Sep 30, 2024 •

edited

Loading

albeanth commented Oct 8, 2024

john-science commented Oct 23, 2024

albeanth commented Oct 23, 2024

john-science commented Oct 24, 2024

albeanth commented Oct 24, 2024 •

edited

Loading

john-science commented Oct 28, 2024

drewj-tp commented Oct 29, 2024

Extending axial expansion classes #1920

Extending axial expansion classes #1920

Conversation

drewj-tp commented Sep 30, 2024 • edited Loading

What is the change?

Why is the change being made?

Checklist

albeanth commented Oct 8, 2024

john-science commented Oct 23, 2024

albeanth commented Oct 23, 2024

john-science commented Oct 24, 2024

albeanth commented Oct 24, 2024 • edited Loading

john-science commented Oct 28, 2024

drewj-tp commented Oct 29, 2024

drewj-tp commented Sep 30, 2024 •

edited

Loading

albeanth commented Oct 24, 2024 •

edited

Loading