Skip to content

Commit

Permalink
#73: Describe structure of the new dictionary
Browse files Browse the repository at this point in the history
  • Loading branch information
ddundo committed Dec 15, 2024
1 parent 792d57c commit abdb7ce
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions goalie/go_mesh_seq.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ def _detect_changing_coefficients(self, export_idx):
change over time. If they do, store the changed coefficients so we can update
them in :meth:`~.GoalOrientedMeshSeq.indicate_errors`.
Changed coefficients are stored in a dictionary with the following structure:
``{field: {coeff_idx: {export_timestep_idx: coefficient}}}``, where
``coefficient=forms[field].coefficients()[coeff_idx]`` at export timestep
``export_timestep_idx``.
:arg export_idx: index of the current export timestep within the subinterval
:type export_idx: :class:`int`
"""
Expand Down

0 comments on commit abdb7ce

Please sign in to comment.