ENH: Resetable Funcified Methods

[giovaniceotto]

Pull request type

Please check the type of change your PR introduces:

• Code base additions (bugfix, features)

Pull request checklist

Please check if your PR fulfills the following requirements, depending on the type of PR:

• Code base additions (for bug fixes / features):

  • Tests for the changes have been added
  • Docs have been reviewed and added / updated if needed
  • Lint (black rocketpy) has passed locally and any fixes were made
  • All tests (pytest --runslow) have passed locally

What is the current behavior?

All methods that use the funcify_method decorator from the Function class are cached. Once an underlying quantity that effects the value of these funcified methods is changed, they cannot be easily updated to incorporate the changes made to the class instance.

What is the new behavior?

A simple function called reset_funcified_methods has been created in the Function module. It can be imported by any multable class which makes use of the funcify_method decorator.

Both HybridMotors and LiquidMotors have been updated to incorporate the function reset_funcified_methods in end of their ´addTank´ method.

Does this introduce a breaking change?

• Yes
• No

Other information

This can be further incorporated in other parts of the code if judged as a good implementation.

This PR does not consider resetting cached properties. In a simple understanding, such methods can be decorated simply by @property instead of @cached_property. If caching is still useful, a similar approach to what was implemented in the reset_funcified_methods can be done to provide the desired functionality.

[Gui-FernandesBR]

For future reference, here are the classes that could start using this resetable function:

• SolidMotor (evaluateGeometry method)
• Rocket (evaluate..... several methods)

[Gui-FernandesBR]

Great fix, many thanks @giovaniceotto !

I hereby confirm that I've tested in the notebooks and it was running perfectly.
Before the v1.0.0 we should definitely apply this reset feature to other classes too.

[giovaniceotto]

Thanks for all the feedbacks.

@Gui-FernandesBR, I have added the new method to the evaluateGeometry method in the SolidMotor class. However, I have not added it to the Rocket class since it does not have any funcified methods.

I believe all the concerns have already been thoroughly discussed and addressed. Feel free to merge.