terrapower / armi / 5978350895

90%

master: 87%

push

github

Refactor armi.reactor.grids to wider submodule; Grids as ABC (#1373)

* Move grids.py to own module armi.reactor.grids

Goal is to introduce separate files for each grid type, but still
make those importable from armi.reactor.grids

* Add armi.reactor.grids.constants

Intended to share some constants and type hints across the
`armi.reactor.grids` submodule. Intentionally sparse.

Items will be imported into `armi.reactor.grids` to help with
back compatibility.

* Add armi.reactor.grids.locations

Provides abstract `LocationBase` as the interface defining base class.
Concrete subclasses `IndexLocation`, `MultiIndexLocation`, and
`CoordinateLocation` are also defined.

There is little to no implementation differences in this change. Only
that `LocationBase` is a proper abstract base class, so subclasses that
don't override the necessary abstract methods will need to change. Some
other key changes

- `LocationBase.__eq__` returns `NotImplemented` if the RHS argument
  is not a tuple nor a `LocationBase`

The four main classes defined are imported into `armi.reactor.grids`
to maintain back compatibility.

* Move reactor/tests/test_grids to grids/tests

* Add armi.reactor.grids.grid for Grid base class

Imported into `armi.reactor.grids` so still back compatible

* Add armi.reactor.grids.cartesian for CartesianGrid

* Add armi.reactor.grids.hexagonal

* Add armi.reactor.grids.thetarz

* Remove six.cPickle -> pickle in test_grids.py

* Add armi.reactor.grids.axial with AxialGrid class

Replaces grids.axialUnitGrid

* Move duplicated grids.addingIsValid to grids.locations

* Refactor Grid to be ABC, intermediate StructuredGrid

Heavier lift, but the classes defined in `armi.reactor.grids`
follow this inheritance pattern

- `Grid(abc.ABC)` :: abstract interface for _a_ grid, or things that reside in
  space
  - `StructuredGrid(Grid)` :: still abstract, but for things that have
    some structure, known... (continued)

752 of 752 new or added lines in 9 files covered. (100.0%)

26854 of 30494 relevant lines covered (88.06%)

0.88 hits per line