search

idaholab / moose

Multiphysics Object Oriented Simulation Environment
https://www.mooseframework.org
GNU Lesser General Public License v2.1
1.78k stars 1.05k forks source link

Rename NSFVFrictionFlowDiodeMaterial #21899

Open snschune opened 2 years ago

snschune commented 2 years ago

Reason

The name of NSFVFrictionFlowDiodeMaterial is suggesting that the object is a directional flow resistance, but it is really a controllable resistance.

Design

Rename object.

Impact

Changes in test input files

snschune commented 2 years ago

@lindsayad @GiudGiud do I need to deprecate the old object and add a new one? Should the deprecated object fail or warn? I would rename NSFVFrictionFlowDiodeMaterial to NSFVControllableFrictionMaterial.

GiudGiud commented 2 years ago

registerobjectRename will do everything you want. Are you working on a better design?

snschune commented 2 years ago

I'm just looking to rename it at this point. How do you think should this be redesigned?

GiudGiud commented 2 years ago

Not sure it needs to be re-designed. Do you have an input where it fails which you can share with me?

snschune commented 2 years ago

No I don't. The only objective of this is renaming. The name suggests that this object does something it doesn't do.

GiudGiud commented 2 years ago

it does do a directional friction flow diode if you use the control system to turn it on and off. The diode is not self-contained in this material, that's true, but it's still part of it. It needs better documentation, and probably an example. I dont object to a rename, and for a rename you only need to: