Changeset 27887 for issm/trunk

Timestamp:

08/23/23 17:59:34 (19 months ago)

Author:

musselman

Message:

Added documentation recording known limitations of read/write_netCDF files

File:

• issm/trunk/src/m/contrib/musselman/README.txt (modified) (1 diff)

issm/trunk/src/m/contrib/musselman/README.txt

@@ -59 +59 @@
 To add functionality for these additional cases, one must simply create a function to handle the case and call it using a 
 conditional case within the create_var() function. To read the data from the NetCDF4 file, add the case to the 
-copy_variable_data_to_new_model() function in read_netCDF so that the data can be added to a new model() instance. 
+copy_variable_data_to_new_model() function in read_netCDF so that the data can be added to a new model() instance.
+
+Known issues:
+
+Unlike Python, MATLAB doesn't utilize subclasses in its model class. This leads to a loss of certain subclass instances. 
+For instance, the results.solutionstep() class poses a known issue. In MATLAB, there's no direct equivalent. The fields in 
+'md.results' in MATLAB might correspond to instances of resultsdakota(), solution(), or solutionstep() in Python, but 
+because those classes don't exist in MATLAB, there is no way for python to know which instance it needs. 
+
+The current workaround, while not theoretically sound, involves searching for the class name string in MATLAB's 'results' 
+field names. For instance, 'md.results.TransientSolution' is recorded as a solution() class instance. However, problems arise 
+in cases like 'md.results.StressbalanceSolution', where the code notes a solution() instance, while in Python, it should be a 
+solutionstep() instance.
+
+So far, there have been no recorded problems swapping a solutionstep() instance for a solution() instance.
+
+Potential solutions are:
+
+    - Restructure both Python and MATLAB solve frameworks. In Python, when creating an md.results.<solutionstep()> instance, 
+    embed 'solutionstep' in the class instance name.
+        >> This solution is very involved, and would include the tedious modification of >5 files in total
+    - Create a hash table linking solutions with their corresponding 'md.results.<class>' for reference when saving models to 
+    the netCDF file.