From abdb7ce66aeabf45302e287181e721a9a7054fc7 Mon Sep 17 00:00:00 2001
From: Davor Dundovic <33790330+ddundo@users.noreply.github.com>
Date: Sun, 15 Dec 2024 21:44:10 +0000
Subject: [PATCH] #73: Describe structure of the new dictionary

---
 goalie/go_mesh_seq.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/goalie/go_mesh_seq.py b/goalie/go_mesh_seq.py
index 347a7af..be35ca4 100644
--- a/goalie/go_mesh_seq.py
+++ b/goalie/go_mesh_seq.py
@@ -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`
         """