-
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
improving changelog/185.breaking.rst
Co-authored-by: Nabil Freij <[email protected]>
- Loading branch information
Showing
1 changed file
with
7 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,12 @@ | ||
The ``Asda`` and ``Lamb_Oseen`` classes have been removed and replaced with functions that replicate the original process. | ||
|
||
The following function were renamed: | ||
- gen_vel -> generate_velocity_field | ||
- gamma_values -> calculate_gamma_values | ||
- vortex_property -> get_vortex_properties | ||
- ``gen_vel`` -> ``generate_velocity_field`` | ||
- ``gamma_values`` -> ``calculate_gamma_values`` | ||
- ``vortex_property`` -> ``get_vortex_properties`` | ||
|
||
Now to use, the properties that were previously stored within the class should now be passed through the arguments of the methods in case the method used these arguments. | ||
Ex: lo.gen_vel(index[1], index[0]) -> asda.generate_velocity_field(vx, vy, index[1], index[0], r) | ||
|
||
Example: | ||
|
||
``lo.gen_vel(index[1], index[0])`` -> ``asda.generate_velocity_field(vx, vy, index[1], index[0], r)`` |