seismic-anisotropy / PyDRex

Simulate crystallographic preferred orientation evolution in polycrystals
https://seismic-anisotropy.github.io/PyDRex/
GNU General Public License v3.0
3 stars 2 forks source link

Documentation for `update_orientations` should clarify the importance of `deformation_gradient` #176

Closed adigitoleo closed 7 months ago

adigitoleo commented 7 months ago

The docstring should be updated, it sort of implies that deformation_gradient is only the initial tensor but actually it needs to be fed the updated one at each timestep. Add a docstring/doctest example showing a simple 10 step loop and feeding the returned deformation gradient from Mineral.update_orientations back into the next call. This is basically the "most public" part of the API so it's good to get this right.