Issue 1500 - Print parameter info by submodel

CHANGELOG.md

@@ -11,6 +11,7 @@
 - Serialisation added so models can be written to/read from JSON ([#3397](https://github.com/pybamm-team/PyBaMM/pull/3397))
 - Added a `get_parameter_info` method for models and modified "print_parameter_info" functionality to extract all parameters and their type in a tabular and readable format ([#3584](https://github.com/pybamm-team/PyBaMM/pull/3584))
 - Mechanical parameters are now a function of stoichiometry and temperature ([#3576](https://github.com/pybamm-team/PyBaMM/pull/3576))
+- Added `by_submodel` feature in `print_parameter_info` method to allow users to print parameters and types of submodels in a tabular and readable format ([#3628](https://github.com/pybamm-team/PyBaMM/pull/3628))
 
 
 ## Bug fixes

pybamm/models/base_model.py

@@ -447,37 +447,52 @@ def get_parameter_info(self):
 
         return parameter_info
 
-    def print_parameter_info(self):
-        """Print parameter information in a formatted table from a dictionary of parameters"""
-        info = self.get_parameter_info()
-        max_param_name_length = 0
-        max_param_type_length = 0
-
-        for param, param_type in info.values():
-            param_name_length = len(getattr(param, 'name', str(param)))
-            param_type_length = len(param_type)
-            max_param_name_length = max(max_param_name_length, param_name_length)
-            max_param_type_length = max(max_param_type_length, param_type_length)
-
-        header_format = f"| {{:<{max_param_name_length}}} | {{:<{max_param_type_length}}} |"
-        row_format = f"| {{:<{max_param_name_length}}} | {{:<{max_param_type_length}}} |"
-
-        table = [header_format.format("Parameter", "Type of parameter"),
-                 header_format.format("=" * max_param_name_length, "=" * max_param_type_length)]
-
-        for param, param_type in info.values():
-            param_name = getattr(param, 'name', str(param))
-            param_name_lines = [param_name[i:i + max_param_name_length] for i in range(0, len(param_name), max_param_name_length)]
-            param_type_lines = [param_type[i:i + max_param_type_length] for i in range(0, len(param_type), max_param_type_length)]
-            max_lines = max(len(param_name_lines), len(param_type_lines))
-
-            for i in range(max_lines):
-                param_line = param_name_lines[i] if i < len(param_name_lines) else ""
-                type_line = param_type_lines[i] if i < len(param_type_lines) else ""
-                table.append(row_format.format(param_line, type_line))
-
-        for line in table:
-            print(line)
+    def print_parameter_info(self, by_submodel=False):
+        """
+        Print parameter information in a formatted table from a dictionary of parameters
+
+        Parameters
+        ----------
+        by_submodel : bool, optional
+            Whether to print the parameter info submodel wise or not (default False)
+        """
+        if by_submodel:
+            for submodel_name, submodel in self.submodels.items():
+                submodel_info = submodel.get_parameter_info()
+                if not submodel_info:
+                    print(f"'{submodel_name}' submodel parameters: \nNo parameters\n")
+                else:
+                    print(f"'{submodel_name}' submodel parameters:")
+                    submodel.print_parameter_info()
+        else:
+            info = self.get_parameter_info()
+            max_param_name_length = 0
+            max_param_type_length = 0
+
+            for param, param_type in info.values():
+                param_name_length = len(getattr(param, 'name', str(param)))
+                param_type_length = len(param_type)
+                max_param_name_length = max(max_param_name_length, param_name_length)
+                max_param_type_length = max(max_param_type_length, param_type_length)
+
+            header_format = f"| {{:<{max_param_name_length}}} | {{:<{max_param_type_length}}} |"
+            row_format = f"| {{:<{max_param_name_length}}} | {{:<{max_param_type_length}}} |"
+
+            table = [header_format.format("Parameter", "Type of parameter"),
+                     header_format.format("=" * max_param_name_length, "=" * max_param_type_length)]
+
+            for param, param_type in info.values():
+                param_name = getattr(param, 'name', str(param))
+                param_name_lines = [param_name[i:i + max_param_name_length] for i in range(0, len(param_name), max_param_name_length)]
+                param_type_lines = [param_type[i:i + max_param_type_length] for i in range(0, len(param_type), max_param_type_length)]
+                max_lines = max(len(param_name_lines), len(param_type_lines))
+
+                for i in range(max_lines):
+                    param_line = param_name_lines[i] if i < len(param_name_lines) else ""
+                    type_line = param_type_lines[i] if i < len(param_type_lines) else ""
+                    table.append(row_format.format(param_line, type_line))
+
+            print("\n".join(table) + "\n")
 
     def _find_symbols(self, typ):
         """Find all the instances of `typ` in the model"""
@@ -565,9 +580,8 @@ def build_coupled_variables(self):
                         )
                     )
                     try:
-                        self.variables.update(
-                            submodel.get_coupled_variables(self.variables)
-                        )
+                        submodel_coupled_vars = submodel.get_coupled_variables(self.variables)
+                        self.variables[submodel_name] = submodel_coupled_vars
                         submodels.remove(submodel_name)
                     except KeyError as key:
                         if len(submodels) == 1 or count == 100:

pybamm/models/submodels/base_submodel.py

@@ -135,6 +135,22 @@ def domain(self, domain):
     def domain_Domain(self):
         return self._domain, self._Domain
 
+    def get_parameter_info(self):
+        """
+        Extracts the parameter information and returns it as a dictionary.
+        To get a list of all parameter-like objects without extra information,
+        use :py:attr:`model.parameters`.
+
+        Returns
+        -------
+        NotImplementedError:
+            This method is not available for direct use on submodels. It is recommended to use on the full model.
+        """
+        raise NotImplementedError(
+            "Cannot use get_parameter_info directly on a submodel. "
+            "Please use it on the full model."
+        )
+
     def get_fundamental_variables(self):
         """
         A public method that creates and returns the variables in a submodel which can