Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some logic so HexAssemblies are hexagonal #1528

Open
john-science opened this issue Dec 7, 2023 · 1 comment
Open

Add some logic so HexAssemblies are hexagonal #1528

john-science opened this issue Dec 7, 2023 · 1 comment
Labels
enhancement New feature or request feature request Smaller user request

Comments

@john-science
Copy link
Member

Right now, the classes HexAssembly and CartesianAssembly are just empty slates:

class HexAssembly(Assembly):
"""Placeholder, so users can explicitly define a hex-based assembly.
.. impl:: Assembly of hex blocks.
:id: I_ARMI_ASSEM_HEX
:implements: R_ARMI_ASSEM_HEX
"""
pass

class CartesianAssembly(Assembly):
pass

But they give people the assumption they can trust these assemblies have a shape, or the blocks inside them do. But obviously no.

I recommend that we override the superclass method Assembly.add() here to check the shape of the Blocks added to assemblies of these types. That will give users some trust, anyway, that instances of these classes are what you'd think at first glance.

@john-science john-science added enhancement New feature or request feature request Smaller user request labels Dec 7, 2023
@john-science
Copy link
Member Author

@jeffbaylor @alexhjames Here is our ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature request Smaller user request
Projects
None yet
Development

No branches or pull requests

1 participant