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.

Sign up for GitHub

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

Jump to bottom

Rename misleading connection names #50

Closed
philippkraft opened this issue Jul 31, 2018 · 4 comments
Closed

Rename misleading connection names #50

philippkraft opened this issue Jul 31, 2018 · 4 comments
Assignees
@philippkraft
Labels
C++ Need to change C++ files (.h, .cpp) documentation enhancement python Need to change Python file (.py) swig Need to change SWIG-interface files (.i)
Milestone
v2.0

Comments

@philippkraft
Copy link
Owner

philippkraft commented Jul 31, 2018 •
edited
Loading

Some of the connection names in cmf are misleading. This issue is the place to collect these connections. If you find some connection name not really fitting (or if you dislike a proposal below), please write it here as a comment.

Starting with cmf 1.4, new names should be available as alternative (aka from future import), for cmf 2.0, the new names will be mandatory. For cmf 2.0 a tool to translate old scripts to the new names should be available.
@philippkraft
Copy link
Owner Author

philippkraft commented Jul 31, 2018 •
edited
Loading

cmf::water::TechnicalFlux → cmf::water::ConstantFlux
cmf::water::statecontrol_connection → cmf::water:ConstantStateFlux
cmf::water::waterbalance_connection → cmf::water::WaterBalanceFlux (I am not sure about this one)

@philippkraft philippkraft self-assigned this Aug 3, 2018
@philippkraft philippkraft added enhancement documentation python Need to change Python file (.py) swig Need to change SWIG-interface files (.i) C++ Need to change C++ files (.h, .cpp) labels Aug 3, 2018
@philippkraft philippkraft added this to the v2.0 milestone Aug 3, 2018
@philippkraft
Copy link
Owner Author

cmf::water::SimpleInfiltration → cmf::water::LumpedInfiltration

@philippkraft
Copy link
Owner Author

cmf::water::SimplRichards
Either delete from CMF or find a better name

@philippkraft
Copy link
Owner Author

philippkraft commented Apr 9, 2019 •
edited
Loading

  • cmf::water::TechnicalFlux → cmf::water::ConstantFlux
  • generic_gradient_connection -> LinearGradientFlux
  • cmf::water::statecontrol_connection → cmf::water:ConstantStateFlux
  • cmf::water::waterbalance_connection → cmf::water::WaterBalanceFlux (I am not sure about this one)
  • cmf::water::SimpleInfiltration → cmf::water::ConceptualInfiltration
  • cmf::water::SimplRichards -> Delete
  • bidirectional_kinematic_exchange -> Delete
  • external_control_connection -> ExternallyControlledFlux
  • kinematic_wave -> delete
  • SimpleTIndexSnowMelt -> TempIndexSnowMelt
  • constraint_kinematic_wave -> delete

philippkraft pushed a commit that referenced this issue Apr 10, 2019
Fixed #50 and adapted all usages in this package
312fbab
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philippkraft philippkraft

Labels
C++ Need to change C++ files (.h, .cpp) documentation enhancement python Need to change Python file (.py) swig Need to change SWIG-interface files (.i)
Projects
None yet
Milestone
v2.0
Development

No branches or pull requests
1 participant
@philippkraft