Repository navigation
Unitful getters and setters for natural units #1810
Description
Activity
I think 2 is a good idea. I think the most important one to include is things that are durations; the schema is in
min, but some operational durations (such astime_limits) are more commonly (and currently in PSY) defined in hours. Would be great to have a NU interface to handle that, and also keep the default user-facing side in hours instead of switching it to min.Some of these are likely not important, like
radcategory, but if we're going to do it for durations, then I think there's no harm in having AI do it for most of them. Then people can double-check their values are stored correctly if they want to.
Several PSY structs have fields in fixed natural units. How do we want to handle them? 3 options:
get_foo(comp, unit)andget_foo_unitful(comp, unit).get_foo(comp),get_foo(comp, unit)(convert, returns float), andget_foo_unitful(comp, unit)(convert, returns unitful) are all accepted.get_foo(comp)only.Moreover, we don't have to pick the same thing for every single field: we could have some where units are not supported, and others where units are optional.
Pros of 1: uniformity.
get_active_powerrequires units.Pros of 2: the best of both worlds. Units, but only when you want them; reverse-compatible.
Pros of 3: lowest effort.
Here's a sampling of the various things that are in natural units:
ACBusbase_voltageACBusangleThermalStandardtime_limitsbase_powerLineangle_limitsHydroTurbinepowerhouse_elevationTwoTerminalLCCLinescheduled_dc_voltageI tend towards "units optional" everywhere, or almost everywhere (might be a few edge cases where it's a headache).