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.
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 fromMineral.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.