From 51e2f9125539b201c7626caecc14f19823eab530 Mon Sep 17 00:00:00 2001 From: Ishaan Desai Date: Tue, 11 Jun 2024 10:10:14 +0200 Subject: [PATCH] Use micro_dt instead of micro_time_window_size --- CHANGELOG.md | 2 +- docs/configuration.md | 2 +- examples/micro-manager-cpp-adaptivity-config.json | 2 +- examples/micro-manager-cpp-config.json | 2 +- examples/micro-manager-python-adaptivity-config.json | 2 +- examples/micro-manager-python-config.json | 2 +- micro_manager/config.py | 8 ++++---- micro_manager/micro_manager_base.py | 2 +- .../micro-manager-config-global-adaptivity-parallel.json | 2 +- .../micro-manager-config-global-adaptivity.json | 2 +- .../micro-manager-config-local-adaptivity.json | 2 +- .../test_unit_cube/micro-manager-config-parallel-1.json | 2 +- .../test_unit_cube/micro-manager-config-parallel-2.json | 2 +- tests/unit/micro-manager-config.json | 2 +- tests/unit/micro-manager-config_crash.json | 2 +- 15 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9746afc..4536e55 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## latest -- Set initial time window size of micro simulation in the configuration, and use it in the coupling https://github.com/precice/micro-manager/pull/112 +- Set time step of micro simulation in the configuration, and use it in the coupling https://github.com/precice/micro-manager/pull/112 - Add a base class called `MicroManager` with minimal API and member function definitions, rename the existing `MicroManager` class to `MicroManagerCoupling` https://github.com/precice/micro-manager/pull/111 - Handle calling `initialize()` function of micro simulations written in languages other than Python https://github.com/precice/micro-manager/pull/110 - Check if initial data returned from the micro simulation is the data that the adaptivity computation requires https://github.com/precice/micro-manager/pull/109 diff --git a/docs/configuration.md b/docs/configuration.md index 873531c..2575d81 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -42,7 +42,7 @@ Parameter | Description `macro_mesh_name` | Name of the macro mesh as stated in the preCICE configuration. `read_data_names` | A Python dictionary with the names of the data to be read from preCICE as keys and `"scalar"` or `"vector"` as values depending on the nature of the data. `write_data_names` | A Python dictionary with the names of the data to be written to preCICE as keys and `"scalar"` or `"vector"` as values depending on the nature of the data. -`micro_time_window_size` | Initial time window size (dt) of the micro simulation. +`micro_dt` | Initial time window size (dt) of the micro simulation. ## Simulation Parameters diff --git a/examples/micro-manager-cpp-adaptivity-config.json b/examples/micro-manager-cpp-adaptivity-config.json index 7d1644c..2f36e07 100644 --- a/examples/micro-manager-cpp-adaptivity-config.json +++ b/examples/micro-manager-cpp-adaptivity-config.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0.0, 25.0, 0.0, 25.0, 0.0, 25.0], diff --git a/examples/micro-manager-cpp-config.json b/examples/micro-manager-cpp-config.json index 33a87d0..01a15e0 100644 --- a/examples/micro-manager-cpp-config.json +++ b/examples/micro-manager-cpp-config.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0.0, 25.0, 0.0, 25.0, 0.0, 25.0] diff --git a/examples/micro-manager-python-adaptivity-config.json b/examples/micro-manager-python-adaptivity-config.json index f3ad55a..595aee8 100644 --- a/examples/micro-manager-python-adaptivity-config.json +++ b/examples/micro-manager-python-adaptivity-config.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0.0, 25.0, 0.0, 25.0, 0.0, 25.0], diff --git a/examples/micro-manager-python-config.json b/examples/micro-manager-python-config.json index 2d581d0..cc170d8 100644 --- a/examples/micro-manager-python-config.json +++ b/examples/micro-manager-python-config.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0.0, 25.0, 0.0, 25.0, 0.0, 25.0] diff --git a/micro_manager/config.py b/micro_manager/config.py index 40b2d9a..55aef23 100644 --- a/micro_manager/config.py +++ b/micro_manager/config.py @@ -30,7 +30,7 @@ def __init__(self, logger, config_filename): self._macro_mesh_name = None self._read_data_names = dict() self._write_data_names = dict() - self._micro_time_window_size = None + self._micro_dt = None self._macro_domain_bounds = None self._ranks_per_axis = None @@ -115,7 +115,7 @@ def read_json(self, config_filename): "No read data names provided. Micro manager will only write data to preCICE." ) - self._micro_time_window_size = data["coupling_params"]["micro_time_window_size"] + self._micro_dt = data["coupling_params"]["micro_dt"] self._macro_domain_bounds = data["simulation_params"]["macro_domain_bounds"] @@ -435,7 +435,7 @@ def is_adaptivity_required_in_every_implicit_iteration(self): """ return self._adaptivity_every_implicit_iteration - def get_micro_time_window_size(self): + def get_micro_dt(self): """ Get the size of the micro time window. @@ -444,4 +444,4 @@ def get_micro_time_window_size(self): micro_time_window : float Size of the micro time window. """ - return self._micro_time_window_size + return self._micro_dt diff --git a/micro_manager/micro_manager_base.py b/micro_manager/micro_manager_base.py index ef6eaa9..29dfdf8 100644 --- a/micro_manager/micro_manager_base.py +++ b/micro_manager/micro_manager_base.py @@ -76,7 +76,7 @@ def __init__(self, config_file): self._logger.info("Provided configuration file: {}".format(config_file)) self._config = Config(self._logger, config_file) - self._micro_dt = self._config.get_micro_time_window_size() + self._micro_dt = self._config.get_micro_dt() def initialize(self): """ diff --git a/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity-parallel.json b/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity-parallel.json index 81a49fc..50da60f 100644 --- a/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity-parallel.json +++ b/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity-parallel.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-cube-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0, 1, 0, 1, 0, 1], diff --git a/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity.json b/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity.json index 6f5a52a..835b983 100644 --- a/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity.json +++ b/tests/integration/test_unit_cube/micro-manager-config-global-adaptivity.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-cube-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0, 1, 0, 1, 0, 1], diff --git a/tests/integration/test_unit_cube/micro-manager-config-local-adaptivity.json b/tests/integration/test_unit_cube/micro-manager-config-local-adaptivity.json index ad25237..5a6581c 100644 --- a/tests/integration/test_unit_cube/micro-manager-config-local-adaptivity.json +++ b/tests/integration/test_unit_cube/micro-manager-config-local-adaptivity.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-cube-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0, 1, 0, 1, 0, 1], diff --git a/tests/integration/test_unit_cube/micro-manager-config-parallel-1.json b/tests/integration/test_unit_cube/micro-manager-config-parallel-1.json index af33f50..aaece10 100644 --- a/tests/integration/test_unit_cube/micro-manager-config-parallel-1.json +++ b/tests/integration/test_unit_cube/micro-manager-config-parallel-1.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-cube-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0, 1, 0, 1, 0, 1], diff --git a/tests/integration/test_unit_cube/micro-manager-config-parallel-2.json b/tests/integration/test_unit_cube/micro-manager-config-parallel-2.json index b97d819..7c8b065 100644 --- a/tests/integration/test_unit_cube/micro-manager-config-parallel-2.json +++ b/tests/integration/test_unit_cube/micro-manager-config-parallel-2.json @@ -5,7 +5,7 @@ "macro_mesh_name": "macro-cube-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0, 1, 0, 1, 0, 1], diff --git a/tests/unit/micro-manager-config.json b/tests/unit/micro-manager-config.json index f5b52fb..e5c5aa7 100644 --- a/tests/unit/micro-manager-config.json +++ b/tests/unit/micro-manager-config.json @@ -5,7 +5,7 @@ "macro_mesh_name": "dummy-macro-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 0.1 + "micro_dt": 0.1 }, "simulation_params": { "macro_domain_bounds": [0.0, 25.0, 0.0, 25.0, 0.0, 25.0], diff --git a/tests/unit/micro-manager-config_crash.json b/tests/unit/micro-manager-config_crash.json index 104c769..455bb1d 100644 --- a/tests/unit/micro-manager-config_crash.json +++ b/tests/unit/micro-manager-config_crash.json @@ -5,7 +5,7 @@ "macro_mesh_name": "dummy-macro-mesh", "read_data_names": {"macro-scalar-data": "scalar", "macro-vector-data": "vector"}, "write_data_names": {"micro-scalar-data": "scalar", "micro-vector-data": "vector"}, - "micro_time_window_size": 1.0 + "micro_dt": 1.0 }, "simulation_params": { "macro_domain_bounds": [0.0, 25.0, 0.0, 25.0, 0.0, 25.0],