micro-manager-precice 0.0.0__tar.gz

micro_manager_precice-0.0.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

micro_manager_precice-0.0.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: micro-manager-precice
+Version: 0.0.0
+Summary: A tool which facilitates two-scale macro-micro coupled simulations using preCICE.
+Author-email: The preCICE Developers <info@precice.org>
+Maintainer-email: Ishaan Desai <ishaan.desai@ipvs.uni-stuttgart.de>
+License: GPLv3
+Project-URL: Homepage, https://precice.org
+Project-URL: Documentation, https://precice.org/tooling-micro-manager-overview.html
+Project-URL: Repository, https://github.com/precice/micro-manager
+Project-URL: Bug Tracker, https://github.com/precice/micro-manager/issues
+Keywords: preCICE,multiscale,coupling
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyprecice>=3.0.0.0
+Requires-Dist: numpy
+Requires-Dist: mpi4py
+Requires-Dist: scikit-learn
+
+# Micro Manager
+
+<a style="text-decoration: none" href="https://github.com/precice/micro-manager/blob/develop/LICENSE" target="_blank">
+    <img src="https://img.shields.io/github/license/precice/micro-manager.svg" alt="GNU LGPL license">
+</a>
+
+<a style="text-decoration: none" href="https://github.com/precice/fenics-adapter/actions/workflows/build-and-test.yml" target="_blank">
+    <img src="https://github.com/precice/micro-manager/actions/workflows/run-adaptivity-test.yml/badge.svg" alt="Test Adaptivity">
+</a>
+
+<a style="text-decoration: none" href="https://pypi.org/project/micro-manager-precice/" target="_blank">
+    <img src="https://github.com/precice/micro-manager/actions/workflows/pythonpublish.yml/badge.svg" alt="Upload Python Package">
+</a>
+
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.05842/status.svg)](https://doi.org/10.21105/joss.05842)
+
+A tool to facilitate solving two-scale (macro-micro) coupled problems using the coupling library [preCICE](https://precice.org/).
+
+The main documentation is rendered on the [preCICE website](https://precice.org/tooling-micro-manager-overview.html).
+
+Please report any [issues](https://github.com/precice/micro-manager/issues) and give us feedback through [one of our community channels](https://precice.org/community-channels.html).

micro_manager_precice-0.0.0/README.md

@@ -0,0 +1,21 @@
+# Micro Manager
+
+<a style="text-decoration: none" href="https://github.com/precice/micro-manager/blob/develop/LICENSE" target="_blank">
+    <img src="https://img.shields.io/github/license/precice/micro-manager.svg" alt="GNU LGPL license">
+</a>
+
+<a style="text-decoration: none" href="https://github.com/precice/fenics-adapter/actions/workflows/build-and-test.yml" target="_blank">
+    <img src="https://github.com/precice/micro-manager/actions/workflows/run-adaptivity-test.yml/badge.svg" alt="Test Adaptivity">
+</a>
+
+<a style="text-decoration: none" href="https://pypi.org/project/micro-manager-precice/" target="_blank">
+    <img src="https://github.com/precice/micro-manager/actions/workflows/pythonpublish.yml/badge.svg" alt="Upload Python Package">
+</a>
+
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.05842/status.svg)](https://doi.org/10.21105/joss.05842)
+
+A tool to facilitate solving two-scale (macro-micro) coupled problems using the coupling library [preCICE](https://precice.org/).
+
+The main documentation is rendered on the [preCICE website](https://precice.org/tooling-micro-manager-overview.html).
+
+Please report any [issues](https://github.com/precice/micro-manager/issues) and give us feedback through [one of our community channels](https://precice.org/community-channels.html).

micro_manager_precice-0.0.0/micro_manager/__init__.py

@@ -0,0 +1,2 @@
+from .config import Config
+from .micro_manager import MicroManager

micro_manager_precice-0.0.0/micro_manager/adaptivity/adaptivity.py

@@ -0,0 +1,318 @@
+"""
+Functionality for adaptive initialization and control of micro simulations
+"""
+import sys
+from math import exp
+from typing import Callable
+from warnings import warn
+
+import numpy as np
+
+
+class AdaptivityCalculator:
+    def __init__(self, configurator, logger) -> None:
+        """
+        Class constructor.
+
+        Parameters
+        ----------
+        configurator : object of class Config
+            Object which has getter functions to get parameters defined in the configuration file.
+        logger : Logger defined from the standard package logging
+        """
+        self._refine_const = configurator.get_adaptivity_refining_const()
+        self._coarse_const = configurator.get_adaptivity_coarsening_const()
+        self._hist_param = configurator.get_adaptivity_hist_param()
+        self._adaptivity_data_names = configurator.get_data_for_adaptivity()
+        self._adaptivity_type = configurator.get_adaptivity_type()
+
+        self._logger = logger
+
+        self._coarse_tol = 0.0
+        self._ref_tol = 0.0
+
+        self._similarity_measure = self._get_similarity_measure(
+            configurator.get_adaptivity_similarity_measure()
+        )
+
+    def _get_similarity_dists(
+        self, dt: float, similarity_dists: np.ndarray, data: dict
+    ) -> np.ndarray:
+        """
+        Calculate metric which determines if two micro simulations are similar enough to have one of them deactivated.
+
+        Parameters
+        ----------
+        dt : float
+            Current time step
+        similarity_dists : numpy array
+            2D array having similarity distances between each micro simulation pair
+        data : dict
+            Data to be used in similarity distance calculation
+
+        Returns
+        -------
+        similarity_dists : numpy array
+            Updated 2D array having similarity distances between each micro simulation pair
+        """
+        _similarity_dists = np.copy(similarity_dists)
+
+        data_diff = np.zeros_like(_similarity_dists)
+        for name in data.keys():
+            data_vals = data[name]
+            if data_vals.ndim == 1:
+                # If the adaptivity-data is a scalar for each simulation,
+                # expand the dimension to make it a 2D array to unify the calculation.
+                # The axis is later reduced with a norm.
+                data_vals = np.expand_dims(data_vals, axis=1)
+
+            data_diff += self._similarity_measure(data_vals)
+
+        return exp(-self._hist_param * dt) * _similarity_dists + dt * data_diff
+
+    def _update_active_sims(
+        self, similarity_dists: np.ndarray, is_sim_active: np.ndarray
+    ) -> np.ndarray:
+        """
+        Update set of active micro simulations. Active micro simulations are compared to each other
+        and if found similar, one of them is deactivated.
+
+        Parameters
+        ----------
+        similarity_dists : numpy array
+            2D array having similarity distances between each micro simulation pair
+        is_sim_active : numpy array
+            1D array having state (active or inactive) of each micro simulation
+
+        Returns
+        -------
+        _is_sim_active : numpy array
+            Updated 1D array having state (active or inactive) of each micro simulation
+        """
+        max_similarity_dist = np.amax(similarity_dists)
+
+        if max_similarity_dist == 0.0:
+            warn(
+                "All similarity distances are zero, probably because all the data for adaptivity is the same. Coarsening tolerance will be manually set to minimum float number."
+            )
+            self._coarse_tol = sys.float_info.min
+        else:
+            self._coarse_tol = (
+                self._coarse_const * self._refine_const * max_similarity_dist
+            )
+
+        _is_sim_active = np.copy(
+            is_sim_active
+        )  # Input is_sim_active is not longer used after this point
+
+        # Update the set of active micro sims
+        for i in range(_is_sim_active.size):
+            if _is_sim_active[i]:  # if sim is active
+                if self._check_for_deactivation(i, similarity_dists, _is_sim_active):
+                    _is_sim_active[i] = False
+
+        return _is_sim_active
+
+    def _associate_inactive_to_active(
+        self,
+        similarity_dists: np.ndarray,
+        is_sim_active: np.ndarray,
+        sim_is_associated_to: np.ndarray,
+    ) -> np.ndarray:
+        """
+        Associate inactive micro simulations to most similar active micro simulation.
+
+        Parameters
+        ----------
+        similarity_dists : numpy array
+            2D array having similarity distances between each micro simulation pair
+        is_sim_active : numpy array
+            1D array having state (active or inactive) of each micro simulation
+        sim_is_associated_to : numpy array
+            1D array with values of associated simulations of inactive simulations. Active simulations have None
+
+        Returns
+        -------
+        _sim_is_associated_to : numpy array
+            1D array with values of associated simulations of inactive simulations. Active simulations have None
+        """
+        active_ids = np.where(is_sim_active)[0]
+        inactive_ids = np.where(is_sim_active == False)[0]
+
+        _sim_is_associated_to = np.copy(sim_is_associated_to)
+
+        # Associate inactive micro sims to active micro sims
+        for inactive_id in inactive_ids:
+            dist_min = sys.float_info.max
+            for active_id in active_ids:
+                # Find most similar active sim for every inactive sim
+                if similarity_dists[inactive_id, active_id] < dist_min:
+                    associated_active_id = active_id
+                    dist_min = similarity_dists[inactive_id, active_id]
+
+            _sim_is_associated_to[inactive_id] = associated_active_id
+
+        return _sim_is_associated_to
+
+    def _check_for_activation(
+        self, inactive_id: int, similarity_dists: np.ndarray, is_sim_active: np.ndarray
+    ) -> bool:
+        """
+        Check if an inactive simulation needs to be activated.
+
+        Parameters
+        ----------
+        inactive_id : int
+            ID of inactive simulation which is checked for activation.
+        similarity_dists : numpy array
+            2D array having similarity distances between each micro simulation pair.
+        is_sim_active : numpy array
+            1D array having state (active or inactive) of each micro simulation.
+
+        Return
+        ------
+        tag : bool
+            True if the inactive simulation needs to be activated, False otherwise.
+        """
+        active_sim_ids = np.where(is_sim_active)[0]
+
+        dists = similarity_dists[inactive_id, active_sim_ids]
+
+        # If inactive sim is not similar to any active sim, activate it
+        return min(dists) > self._ref_tol
+
+    def _check_for_deactivation(
+        self, active_id: int, similarity_dists: np.ndarray, is_sim_active: np.ndarray
+    ) -> bool:
+        """
+        Check if an active simulation needs to be deactivated.
+
+        Parameters
+        ----------
+        active_id : int
+            ID of active simulation which is checked for deactivation.
+        similarity_dists : numpy array
+            2D array having similarity distances between each micro simulation pair.
+        is_sim_active : numpy array
+            1D array having state (active or inactive) of each micro simulation.
+
+        Return
+        ------
+        tag : bool
+            True if the active simulation needs to be deactivated, False otherwise.
+        """
+        active_sim_ids = np.where(is_sim_active)[0]
+
+        for active_id_2 in active_sim_ids:
+            if active_id != active_id_2:  # don't compare active sim to itself
+                # If active sim is similar to another active sim, deactivate it
+                if similarity_dists[active_id, active_id_2] < self._coarse_tol:
+                    return True
+        return False
+
+    def _get_similarity_measure(
+        self, similarity_measure: str
+    ) -> Callable[[np.ndarray], np.ndarray]:
+        """
+        Get similarity measure to be used for similarity calculation
+
+        Parameters
+        ----------
+        similarity_measure : str
+            String specifying the similarity measure to be used
+
+        Returns
+        -------
+        similarity_measure : function
+            Function to be used for similarity calculation. Takes data as input and returns similarity measure
+        """
+        if similarity_measure == "L1":
+            return self._l1
+        elif similarity_measure == "L2":
+            return self._l2
+        elif similarity_measure == "L1rel":
+            return self._l1rel
+        elif similarity_measure == "L2rel":
+            return self._l2rel
+        else:
+            raise ValueError(
+                'Similarity measure not supported. Currently supported similarity measures are "L1", "L2", "L1rel", "L2rel".'
+            )
+
+    def _l1(self, data: np.ndarray) -> np.ndarray:
+        """
+        Calculate L1 norm of data
+
+        Parameters
+        ----------
+        data : numpy array
+            Data to be used in similarity distance calculation
+
+        Returns
+        -------
+        similarity_dists : numpy array
+            Updated 2D array having similarity distances between each micro simulation pair
+        """
+        return np.linalg.norm(data[np.newaxis, :] - data[:, np.newaxis], ord=1, axis=-1)
+
+    def _l2(self, data: np.ndarray) -> np.ndarray:
+        """
+        Calculate L2 norm of data
+
+        Parameters
+        ----------
+        data : numpy array
+            Data to be used in similarity distance calculation
+
+        Returns
+        -------
+        similarity_dists : numpy array
+            Updated 2D array having similarity distances between each micro simulation pair
+        """
+        return np.linalg.norm(data[np.newaxis, :] - data[:, np.newaxis], ord=2, axis=-1)
+
+    def _l1rel(self, data: np.ndarray) -> np.ndarray:
+        """
+        Calculate L1 norm of relative difference of data.
+        The relative difference is calculated by dividing the difference of two data points by the maximum of the two data points.
+
+        Parameters
+        ----------
+        data : numpy array
+            Data to be used in similarity distance calculation
+
+        Returns
+        -------
+        similarity_dists : numpy array
+            Updated 2D array having similarity distances between each micro simulation pair
+        """
+        pointwise_diff = data[np.newaxis, :] - data[:, np.newaxis]
+        # divide by data to get relative difference
+        # divide i,j by max(data[i],data[j]) to get relative difference
+        relative = np.nan_to_num(
+            (pointwise_diff / np.maximum(data[np.newaxis, :], data[:, np.newaxis]))
+        )
+        return np.linalg.norm(relative, ord=1, axis=-1)
+
+    def _l2rel(self, data: np.ndarray) -> np.ndarray:
+        """
+        Calculate L2 norm of relative difference of data.
+        The relative difference is calculated by dividing the difference of two data points by the maximum of the two data points.
+
+        Parameters
+        ----------
+        data : numpy array
+            Data to be used in similarity distance calculation
+
+        Returns
+        -------
+        similarity_dists : numpy array
+            Updated 2D array having similarity distances between each micro simulation pair
+        """
+        pointwise_diff = data[np.newaxis, :] - data[:, np.newaxis]
+        # divide by data to get relative difference
+        # divide i,j by max(data[i],data[j]) to get relative difference
+        relative = np.nan_to_num(
+            (pointwise_diff / np.maximum(data[np.newaxis, :], data[:, np.newaxis]))
+        )
+        return np.linalg.norm(relative, ord=2, axis=-1)