emerge 0.4.9__py3-none-any.whl → 0.4.11__py3-none-any.whl

emerge/__init__.py

@@ -20,8 +20,8 @@ import os
 
 NTHREADS = "1"
 
-os.environ["OMP_NUM_THREADS"] = NTHREADS
-os.environ["MKL_NUM_THREADS"] = NTHREADS
+os.environ["OMP_NUM_THREADS"] = "4"
+os.environ["MKL_NUM_THREADS"] = "4"
 os.environ["OPENBLAS_NUM_THREADS"] = NTHREADS
 os.environ["VECLIB_MAXIMUM_THREADS"] = NTHREADS
 os.environ["NUMEXPR_NUM_THREADS"] = NTHREADS

emerge/_emerge/mesh3d.py

@@ -87,6 +87,8 @@ class Mesh3D:
         
         self.geometry: Mesher = mesher
 
+        self.exterior_face_tags: list[int] = None
+        
         # All spatial objects
         self.nodes: np.ndarray = None
         self.n_i2t: dict = None

emerge/_emerge/pardiso/pardiso_solver.py

@@ -0,0 +1,455 @@
+# Copyright (c) 2016 Adrian Haas and ETH Zürich
+# Modifications Copyright (c) 2025 Robert Fennis
+#
+# SPDX-License-Identifier: BSD-3-Clause AND GPL-2.0-or-later
+#
+# This file incorporates code from the PyPardiso project, which is
+# distributed under the BSD 3-Clause License.  You may redistribute
+# and/or modify this file under either
+#
+#   * the terms of the BSD 3-Clause License (see below), or
+#   * the terms of the GNU General Public License, version 2 or later.
+#
+# ----------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# 3. Neither the name of ETH Zürich nor the names of its contributors
+#    may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+# DAMAGE.
+# ----------------------------------------------------------------------
+
+# coding: utf-8
+import scipy.sparse as sp
+# coding: utf-8
+import os
+import sys
+import glob
+import ctypes
+import warnings
+import hashlib
+import site
+from ctypes.util import find_library
+
+import numpy as np
+import scipy.sparse as sp
+from scipy.sparse import SparseEfficiencyWarning, csr_matrix
+
+
+_PARDISO_ERROR_CODES = """
+   0 | No error.
+  -1 | Input inconsistent.
+  -2 | Not enough memory.
+  -3 | Reordering problem.
+  -4 | Zero pivot, numerical fac. or iterative refinement problem.
+  -5 | Unclassified (internal) error.
+  -6 | Preordering failed (matrix types 11(real and nonsymmetric), 13(complex and nonsymmetric) only).
+  -7 | Diagonal Matrix problem.
+  -8 | 32-bit integer overflow problem.
+ -10 | No license file pardiso.lic found.
+ -11 | License is expired.
+ -12 | Wrong username or hostname.
+-100 | Reached maximum number of Krylov-subspace iteration in iterative solver.
+-101 | No sufficient convergence in Krylov-subspace iteration within 25 iterations.
+-102 | Error in Krylov-subspace iteration.
+-103 | Bread-Down in Krylov-subspace iteration
+"""
+
+class MKL_Complex16(ctypes.Structure):
+    _fields_ = [("real", ctypes.c_double),
+                ("imag", ctypes.c_double)]
+
+cpx16_p = ctypes.POINTER(MKL_Complex16)
+
+class PyPardisoSolver:
+    """
+    Python interface to the Intel MKL PARDISO library for solving large sparse linear systems of equations Ax=b.
+
+    Pardiso documentation: https://software.intel.com/en-us/node/470282
+
+    --- Basic usage ---
+    matrix type: real (float64) and nonsymetric
+    methods: solve, factorize
+
+    - use the "solve(A,b)" method to solve Ax=b for x, where A is a sparse CSR (or CSC) matrix and b is a numpy array
+    - use the "factorize(A)" method first, if you intend to solve the system more than once for different right-hand
+      sides, the factorization will be reused automatically afterwards
+
+
+    --- Advanced usage ---
+    methods: get_iparm, get_iparms, set_iparm, set_matrix_type, set_phase
+
+    - additional options can be accessed by setting the iparms (see Pardiso documentation for description)
+    - other matrix types can be chosen with the "set_matrix_type" method. complex matrix types are currently not
+      supported. pypardiso is only teste for mtype=11 (real and nonsymetric)
+    - the solving phases can be set with the "set_phase" method
+    - The out-of-core (OOC) solver either fails or crashes my computer, be careful with iparm[60]
+
+
+    --- Statistical info ---
+    methods: set_statistical_info_on, set_statistical_info_off
+
+    - the Pardiso solver writes statistical info to the C stdout if desired
+    - if you use pypardiso from within a jupyter notebook you can turn the statistical info on and capture the output
+      real-time by wrapping your call to "solve" with wurlitzer.sys_pipes() (https://github.com/minrk/wurlitzer,
+      https://pypi.python.org/pypi/wurlitzer/)
+    - wurlitzer dosen't work on windows, info appears in notebook server console window if used from jupyter notebook
+
+
+    --- Memory usage ---
+    methods: remove_stored_factorization, free_memory
+
+    - remove_stored_factorization can be used to delete the wrapper's copy of matrix A
+    - free_memory releases the internal memory of the solver
+
+    """
+
+    def __init__(self, mtype=11, phase=13, size_limit_storage=5e7):
+
+        self.libmkl = None
+
+        # custom mkl_rt path in environment variable
+        mkl_rt = os.environ.get('PYPARDISO_MKL_RT')
+
+        # Look for the mkl_rt shared library with ctypes.util.find_library
+        if mkl_rt is None:
+            mkl_rt = find_library('mkl_rt')
+        # also look for mkl_rt.1, Windows-specific, see
+        # https://github.com/haasad/PyPardisoProject/issues/12
+        if mkl_rt is None:
+            mkl_rt = find_library('mkl_rt.1')
+
+        # If we can't find mkl_rt with find_library, we search the directory
+        # tree, using a few assumptions:
+        # - the shared library can be found in a subdirectory of sys.prefix
+        #   https://docs.python.org/3.9/library/sys.html#sys.prefix
+        #   or in the user site in case of user-local installation like
+        #   `pip install --user`
+        #   https://peps.python.org/pep-0370/
+        #   https://docs.python.org/3/library/site.html#site.USER_BASE
+        # - either in `lib` (linux and macOS) or `Library\bin` (windows)
+        # - if there are multiple matches for `mkl_rt`, try shorter paths
+        #   first
+        if mkl_rt is None:
+            globs = glob.glob(
+                f'{sys.prefix}/[Ll]ib*/**/*mkl_rt*', recursive=True
+            ) or glob.glob(
+                f'{site.USER_BASE}/[Ll]ib*/**/*mkl_rt*', recursive=True
+            )
+            for path in sorted(globs, key=len):
+                try:
+                    self.libmkl = ctypes.CDLL(path)
+                    break
+                except (OSError, ImportError):
+                    pass
+
+            if self.libmkl is None:
+                raise ImportError(
+                    'Shared library mkl_rt not found. '
+                    'Use environment variable PYPARDISO_MKL_RT to provide a custom path.'
+                )
+        else:
+            self.libmkl = ctypes.CDLL(mkl_rt)
+
+        self._mkl_pardiso = self.libmkl.pardiso
+
+        # determine 32bit or 64bit architecture
+        if ctypes.sizeof(ctypes.c_void_p) == 8:
+            self._pt_type = (ctypes.c_int64, np.int64)
+        else:
+            self._pt_type = (ctypes.c_int32, np.int32)
+
+        self._mkl_pardiso.argtypes = [ctypes.POINTER(self._pt_type[0]),    # pt
+                                      ctypes.POINTER(ctypes.c_int32),      # maxfct
+                                      ctypes.POINTER(ctypes.c_int32),      # mnum
+                                      ctypes.POINTER(ctypes.c_int32),      # mtype
+                                      ctypes.POINTER(ctypes.c_int32),      # phase
+                                      ctypes.POINTER(ctypes.c_int32),      # n
+                                      ctypes.POINTER(None),                # a
+                                      ctypes.POINTER(ctypes.c_int32),      # ia
+                                      ctypes.POINTER(ctypes.c_int32),      # ja
+                                      ctypes.POINTER(ctypes.c_int32),      # perm
+                                      ctypes.POINTER(ctypes.c_int32),      # nrhs
+                                      ctypes.POINTER(ctypes.c_int32),      # iparm
+                                      ctypes.POINTER(ctypes.c_int32),      # msglvl
+                                      ctypes.POINTER(None),                # b
+                                      ctypes.POINTER(None),                # x
+                                      ctypes.POINTER(ctypes.c_int32)]      # error
+
+        self._mkl_pardiso.restype = None
+
+        self.pt = np.zeros(64, dtype=self._pt_type[1])
+        self.iparm = np.zeros(64, dtype=np.int32)
+        self.perm = np.zeros(0, dtype=np.int32)
+
+        self.mtype = mtype
+        self.phase = phase
+        self.msglvl = False
+
+        self.factorized_A = csr_matrix((0, 0))
+        self.size_limit_storage = size_limit_storage
+        self._solve_transposed = False
+
+    def factorize(self, A):
+        """
+        Factorize the matrix A, the factorization will automatically be used if the same matrix A is passed to the
+        solve method. This will drastically increase the speed of solve, if solve is called more than once for the
+        same matrix A
+
+        --- Parameters ---
+        A: sparse square CSR matrix (scipy.sparse.csr.csr_matrix), CSC matrix also possible
+        """
+
+        self._check_A(A)
+
+        if A.nnz > self.size_limit_storage:
+            self.factorized_A = self._hash_csr_matrix(A)
+        else:
+            self.factorized_A = A.copy()
+
+        self.set_phase(12)
+        b = np.zeros((A.shape[0], 1))
+        self._call_pardiso(A, b)
+
+    def solve(self, A, b):
+        """
+        solve Ax=b for x
+
+        --- Parameters ---
+        A: sparse square CSR matrix (scipy.sparse.csr.csr_matrix), CSC matrix also possible
+        b: numpy ndarray
+           right-hand side(s), b.shape[0] needs to be the same as A.shape[0]
+
+        --- Returns ---
+        x: numpy ndarray
+           solution of the system of linear equations, same shape as input b
+        """
+
+        self._check_A(A)
+        b = self._check_b(A, b)
+
+        if self._is_already_factorized(A):
+            self.set_phase(33)
+        else:
+            self.set_phase(13)
+
+        x = self._call_pardiso(A, b)
+
+        # it is possible to call the solver with empty columns, but computationally expensive to check this
+        # beforehand, therefore only the result is checked for infinite elements.
+        # if not np.isfinite(x).all():
+        #    warnings.warn('The result contains infinite elements. Make sure that matrix A contains no empty columns.',
+        #                  PyPardisoWarning)
+        # --> this check doesn't work consistently, maybe add an advanced input check method for A
+
+        return x
+
+    def _is_already_factorized(self, A):
+        if isinstance(self.factorized_A, str):
+            return self._hash_csr_matrix(A) == self.factorized_A
+        else:
+            return self._csr_matrix_equal(A, self.factorized_A)
+
+    def _csr_matrix_equal(self, a1, a2):
+        return all((np.array_equal(a1.indptr, a2.indptr),
+                    np.array_equal(a1.indices, a2.indices),
+                    np.array_equal(a1.data, a2.data)))
+
+    def _hash_csr_matrix(self, matrix):
+        return (hashlib.sha1(matrix.indices).hexdigest() +
+                hashlib.sha1(matrix.indptr).hexdigest() +
+                hashlib.sha1(matrix.data).hexdigest())
+
+    def _check_A(self, A):
+        if A.shape[0] != A.shape[1]:
+            raise ValueError('Matrix A needs to be square, but has shape: {}'.format(A.shape))
+
+        if sp.issparse(A) and A.format == "csr":
+            self._solve_transposed = False
+            self.set_iparm(12, 1)
+        elif sp.issparse(A) and A.format == "csc":
+            self._solve_transposed = True
+            self.set_iparm(12, 0)
+        else:
+            msg = 'PyPardiso requires matrix A to be in CSR or CSC format, but matrix A is: {}'.format(type(A))
+            raise TypeError(msg)
+
+        # scipy allows unsorted csr-indices, which lead to completely wrong pardiso results
+        if not A.has_sorted_indices:
+            A.sort_indices()
+
+        # scipy allows csr matrices with empty rows. a square matrix with an empty row is singular. calling
+        # pardiso with a matrix A that contains empty rows leads to a segfault, same applies for csc with
+        # empty columns
+        if not np.diff(A.indptr).all():
+            row_col = 'column' if self._solve_transposed else 'row'
+            raise ValueError('Matrix A is singular, because it contains empty {}(s)'.format(row_col))
+
+    def _check_b(self, A, b):
+        if sp.issparse(b):
+            warnings.warn('PyPardiso requires the right-hand side b to be a dense array for maximum efficiency',
+                          SparseEfficiencyWarning)
+            b = b.todense()
+
+        # pardiso expects fortran (column-major) order for b
+        if not b.flags.f_contiguous:
+            b = np.asfortranarray(b)
+
+        if b.shape[0] != A.shape[0]:
+            raise ValueError("Dimension mismatch: Matrix A {} and array b {}".format(A.shape, b.shape))
+
+        if b.dtype != np.float64:
+            if b.dtype in [np.float16, np.float32, np.int16, np.int32, np.int64]:
+                warnings.warn("Array b's data type was converted from {} to float64".format(str(b.dtype)),
+                              PyPardisoWarning)
+                b = b.astype(np.float64)
+            elif b.dtype in (np.complex128, np.complex64):
+                b = b.astype(np.complex128)
+            else:
+                raise TypeError('Dtype {} for array b is not supported'.format(str(b.dtype)))
+
+        return b
+
+    def _call_pardiso(self, A, b):
+        self.set_iparm(2,3)
+        self.set_iparm(3,6)
+        self.set_iparm(10,13)
+        self.set_iparm(13,2)
+
+        x = np.zeros_like(b)
+        pardiso_error = ctypes.c_int32(0)
+        c_int32_p = ctypes.POINTER(ctypes.c_int32)
+        c_float64_p = ctypes.POINTER(ctypes.c_double)
+
+        # 1-based indexing
+        ia = A.indptr + 1
+        ja = A.indices + 1
+
+        mtype = 3
+        
+        if A.dtype == np.complex128:
+            val_ptr = A.data.ctypes.data_as(cpx16_p)
+            rhs_ptr = b.ctypes.data_as(cpx16_p)
+            x_ptr = x.ctypes.data_as(cpx16_p)
+        else:
+            val_ptr = A.data.ctypes.data_as(c_float64_p)
+            rhs_ptr = b.ctypes.data_as(c_float64_p)
+            x_ptr = x.ctypes.data_as(c_float64_p)
+
+        self._mkl_pardiso(self.pt.ctypes.data_as(ctypes.POINTER(self._pt_type[0])),  # pt
+                          ctypes.byref(ctypes.c_int32(1)),  # maxfct
+                          ctypes.byref(ctypes.c_int32(1)),  # mnum
+                          ctypes.byref(ctypes.c_int32(mtype)),  # mtype -> 11 for real-nonsymetric
+                          ctypes.byref(ctypes.c_int32(self.phase)),  # phase -> 13
+                          ctypes.byref(ctypes.c_int32(A.shape[0])),  # N -> number of equations/size of matrix
+                          val_ptr,  # A -> non-zero entries in matrix
+                          ia.ctypes.data_as(c_int32_p),  # ia -> csr-indptr
+                          ja.ctypes.data_as(c_int32_p),  # ja -> csr-indices
+                          self.perm.ctypes.data_as(c_int32_p),  # perm -> empty
+                          ctypes.byref(ctypes.c_int32(1 if b.ndim == 1 else b.shape[1])),  # nrhs
+                          self.iparm.ctypes.data_as(c_int32_p),  # iparm-array
+                          ctypes.byref(ctypes.c_int32(self.msglvl)),  # msg-level -> 1: statistical info is printed
+                          rhs_ptr,  # b -> right-hand side vector/matrix
+                          x_ptr,  # x -> output
+                          ctypes.byref(pardiso_error))  # pardiso error
+
+        if pardiso_error.value != 0:
+            raise PyPardisoError(pardiso_error.value)
+        else:
+            return np.ascontiguousarray(x)  # change memory-layout back from fortran to c order
+
+    def get_iparms(self):
+        """Returns a dictionary of iparms"""
+        return dict(enumerate(self.iparm, 1))
+
+    def get_iparm(self, i):
+        """Returns the i-th iparm (1-based indexing)"""
+        return self.iparm[i-1]
+
+    def set_iparm(self, i, value):
+        """set the i-th iparm to 'value' (1-based indexing)"""
+        if i not in {1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 18, 19, 21, 24, 25, 27, 28, 31, 34, 35, 36, 37, 56, 60}:
+            warnings.warn('{} is no input iparm. See the Pardiso documentation.'.format(value), PyPardisoWarning)
+        self.iparm[i-1] = value
+
+    def set_matrix_type(self, mtype):
+        """Set the matrix type (see Pardiso documentation)"""
+        self.mtype = mtype
+
+    def set_statistical_info_on(self):
+        """Display statistical info (appears in notebook server console window if pypardiso is
+        used from jupyter notebook, use wurlitzer to redirect info to the notebook)"""
+        self.msglvl = 1
+
+    def set_statistical_info_off(self):
+        """Turns statistical info off"""
+        self.msglvl = 0
+
+    def set_phase(self, phase):
+        """Set the phase(s) for the solver. See the Pardiso documentation for details."""
+        self.phase = phase
+
+    def remove_stored_factorization(self):
+        """removes the stored factorization, this will free the memory in python, but the factorization in pardiso
+        is still accessible with a direct call to self._call_pardiso(A,b) with phase=33"""
+        self.factorized_A = sp.csr_matrix((0, 0))
+
+    def free_memory(self, everything=False):
+        """release mkl's internal memory, either only for the factorization (ie the LU-decomposition) or all of
+        mkl's internal memory if everything=True"""
+        self.remove_stored_factorization()
+        A = sp.csr_matrix((0, 0))
+        b = np.zeros(0)
+        self.set_phase(-1 if everything else 0)
+        self._call_pardiso(A, b)
+        self.set_phase(13)
+
+    def pardiso_solve(self, A: csr_matrix, b: np.ndarray):
+        if sp.issparse(A) and A.format == "csc":
+            A = A.tocsr()  
+
+        self._check_A(A)
+
+        if not self._is_already_factorized(A):
+            self.factorize(A)
+
+        try:
+            x = self.solve(A, b)
+        except PyPardisoError as e:
+            print('Error Codes:')
+            print(_PARDISO_ERROR_CODES)
+
+        return x.squeeze()
+
+class PyPardisoWarning(UserWarning):
+    pass
+
+
+class PyPardisoError(Exception):
+
+    def __init__(self, value):
+        self.value = value
+
+    def __str__(self):
+        return ('The Pardiso solver failed with error code {}. '
+                'See Pardiso documentation for details.'.format(self.value))

emerge/_emerge/physics/microwave/microwave_bc.py

@@ -46,6 +46,13 @@ class MWBoundaryConditionSet(BoundaryConditionSet):
 
         self._cell: PeriodicCell = None
 
+    def get_type(self, bctype: Literal['PEC','ModalPort','LumpedPort','PMC','LumpedElement','RectangularWaveguide','Periodic','FloquetPort']) -> FaceSelection:
+        tags = []
+        for bc in self.boundary_conditions:
+            if bctype in str(bc.__class__):
+                tags.extend(bc.selection.tags)
+        return FaceSelection(tags)
+
     def floquet_port(self, poly: GeoSurface, port_number: int) -> FloquetPort:
         if self._cell is None:
             raise ValueError('Periodic cel must be defined for this simulation.')

emerge/_emerge/physics/microwave/microwave_data.py

@@ -874,6 +874,32 @@ class MWField:
         
         return Eff, Hff
 
+    def optycal(self, faces: FaceSelection | GeoSurface = None) -> tuple:
+        """Export this models exterior to an Optical acceptable dataset
+
+        Args:
+            faces (FaceSelection | GeoSurface): The faces to export. Defaults to None
+
+        Returns:
+            tuple: _description_
+        """
+        if faces is None:
+            tags = self.mesh.exterior_face_tags
+        else:
+            tags = faces.tags
+
+        surface = self.basis.mesh.boundary_surface(tags, None)
+        field = self.interpolate(*surface.exyz)
+        vertices = surface.nodes
+        triangles = surface.tris
+        print(surface._origin, surface._alignment_origin)
+        origin = surface._origin
+        E = field.E
+        H = field.H
+        k0 = self.k0
+        return vertices, triangles, E, H, origin, k0
+        
+
 class MWScalar:
     """The MWDataSet class stores solution data of FEM Time Harmonic simulations.
     """

emerge/_emerge/plot/simple_plots.py

@@ -400,6 +400,7 @@ def plot_ff(
     theta: np.ndarray,
     E: Union[np.ndarray, Sequence[np.ndarray]],
     grid: bool = True,
+    dB: bool = False,
     labels: Optional[List[str]] = None,
     xlabel: str = "Theta (rad)",
     ylabel: str = "|E|",
@@ -453,6 +454,8 @@ def plot_ff(
     fig, ax = plt.subplots()
     for i, Ei in enumerate(E_list):
         mag = np.abs(Ei)
+        if dB:
+            mag = 20*np.log10(mag)
         ax.plot(
             theta, mag,
             linestyle=linestyles[i],

emerge/_emerge/simmodel.py

@@ -277,8 +277,6 @@ class Simulation3D:
         if not self._defined_geometries:
             self.define_geometry()
         
-        
-        
         # Check if frequencies are defined: TODO: Replace with a more generic check
         if self.mw.frequencies is None:
             raise ValueError('No frequencies defined for the simulation. Please set frequencies before generating the mesh.')
@@ -296,6 +294,7 @@ class Simulation3D:
             raise
         
         self.mesh.update(self.mesher._get_periodic_bcs())
+        self.mesh.exterior_face_tags = self.mesher.domain_boundary_face_tags
         gmsh.model.occ.synchronize()
         self.set_mesh(self.mesh)
 

emerge/_emerge/solver.py

@@ -32,32 +32,14 @@ from enum import Enum
 
 _PARDISO_AVAILABLE = False
 _UMFPACK_AVAILABLE = False
-_PARDISO_ERROR_CODES = """
-   0 | No error.
-  -1 | Input inconsistent.
-  -2 | Not enough memory.
-  -3 | Reordering problem.
-  -4 | Zero pivot, numerical fac. or iterative refinement problem.
-  -5 | Unclassified (internal) error.
-  -6 | Preordering failed (matrix types 11(real and nonsymmetric), 13(complex and nonsymmetric) only).
-  -7 | Diagonal Matrix problem.
-  -8 | 32-bit integer overflow problem.
- -10 | No license file pardiso.lic found.
- -11 | License is expired.
- -12 | Wrong username or hostname.
--100 | Reached maximum number of Krylov-subspace iteration in iterative solver.
--101 | No sufficient convergence in Krylov-subspace iteration within 25 iterations.
--102 | Error in Krylov-subspace iteration.
--103 | Bread-Down in Krylov-subspace iteration
-"""
+
 """ Check if the PC runs on a non-ARM architechture
 If so, attempt to import PyPardiso (if its installed)
 """
 
 if 'arm' not in platform.processor():
     try:
-        from pypardiso import spsolve as pardiso_solve
-        from pypardiso.pardiso_wrapper import PyPardisoError
+        from .pardiso.pardiso_solver import PyPardisoSolver, PyPardisoError
         _PARDISO_AVAILABLE = True
     except ModuleNotFoundError as e:
         logger.info('Pardiso not found, defaulting to SuperLU')
@@ -392,7 +374,7 @@ class SolverUMFPACK(Solver):
         super().__init__()
         self.A: np.ndarray = None
         self.b: np.ndarray = None
-        self.up: um.UmfpackContext = um.UmfpackContext('zi')
+        self.up: um.UmfpackContext = um.UmfpackContext('zl')
         self.up.control[um.UMFPACK_PRL] = 0  #less terminal printing
         self.up.control[um.UMFPACK_IRSTEP] = 2
         self.up.control[um.UMFPACK_STRATEGY] = um.UMFPACK_STRATEGY_SYMMETRIC
@@ -401,6 +383,7 @@ class SolverUMFPACK(Solver):
         self.up.control[um.UMFPACK_SYM_PIVOT_TOLERANCE] = 0.001
         self.up.control[um.UMFPACK_BLOCK_SIZE] = 64
         self.up.control[um.UMFPACK_FIXQ] = -1
+        #self.up.control[um.UMFPACK_]
 
         self.fact_symb: bool = False
 
@@ -409,6 +392,8 @@ class SolverUMFPACK(Solver):
 
     def solve(self, A, b, precon, reuse_factorization: bool = False, id: int = -1):
         logger.info(f'Calling UMFPACK Solver. ID={id}')
+        A.indptr  = A.indptr.astype(np.int64)
+        A.indices = A.indices.astype(np.int64)
         if self.fact_symb is False:
             logger.debug('Executing symbollic factorization.')
             self.up.symbolic(A)
@@ -423,12 +408,12 @@ class SolverUMFPACK(Solver):
 
 class SolverPardiso(Solver):
     """ Implements the PARDISO solver through PyPardiso. """
-    real_only: bool = True
+    real_only: bool = False
     req_sorter: bool = False
 
     def __init__(self):
         super().__init__()
-
+        self.solver: PyPardisoSolver = PyPardisoSolver()
         self.A: np.ndarray = None
         self.b: np.ndarray = None
     
@@ -436,11 +421,7 @@ class SolverPardiso(Solver):
         logger.info(f'Calling Pardiso Solver. ID={id}')
         self.A = A
         self.b = b
-        try:
-            x = pardiso_solve(A, b)
-        except PyPardisoError as e:
-            print('Error Codes:')
-            print(_PARDISO_ERROR_CODES)
+        x = self.solver.solve(A, b)
         return x, 0
     
 ## -----  DIRECT EIG SOLVERS --------------------------------------
@@ -647,6 +628,7 @@ class SolveRoutine:
         self.parallel: Literal['SI','MT','MP'] = 'SI'
         self.smart_search: bool = False
         self.forced_solver: list[Solver] = []
+        self.disabled_solver: list[Solver] = []
 
         self.use_sorter: bool = False
         self.use_preconditioner: bool = False
@@ -655,6 +637,49 @@ class SolveRoutine:
     def __str__(self) -> str:
         return f'SolveRoutine({self.sorter},{self.precon},{self.iterative_solver}, {self.direct_solver})'
     
+    def _legal_solver(self, solver: Solver) -> bool:
+        """Checks if a solver is a legal option.
+
+        Args:
+            solver (Solver): The solver to test against
+
+        Returns:
+            bool: If the solver is legal
+        """
+        if any(isinstance(solver, solvertype) for solvertype in self.disabled_solver):
+            return False
+        return True
+    
+    @property
+    def all_solvers(self) -> list[Solver]:
+        return list([solver for solver in self.solvers.values() if not isinstance(solver, EigSolver)])
+    
+    @property
+    def all_eig_solvers(self) -> list[Solver]:
+        return list([solver for solver in self.solvers.values() if isinstance(solver, EigSolver)])
+    
+
+    def _try_solver(self, solver_type: EMSolver) -> Solver:
+        """Try to use the selected solver or else find another one that is working.
+
+        Args:
+            solver_type (EMSolver): The solver type to try
+
+        Raises:
+            RuntimeError: Error if no valid solver is found.
+
+        Returns:
+            Solver: The working solver.
+        """
+        solver = self.solvers[solver_type]
+        if self._legal_solver(solver):
+            return solver
+        for alternative in self.all_solvers:
+            if self._legal_solver(alternative):
+                logger.debug(f'Falling back on legal solver: {alternative}')
+                return alternative
+        raise RuntimeError(f'No legal solver could be found. The following are disabled: {self.disabled_solver}')
+    
     def duplicate(self) -> SolveRoutine:
         """Creates a copy of this SolveRoutine class object.
 
@@ -667,17 +692,30 @@ class SolveRoutine:
         new_routine.forced_solver = self.forced_solver
         return new_routine
     
-    def set_solver(self, *solver: EMSolver | EigSolver | Solver) -> None:
+    def set_solver(self, *solvers: EMSolver | EigSolver | Solver) -> None:
         """Set a given Solver class instance as the main solver. Solvers will be checked on validity for the given problem.
 
         Args:
             solver (EMSolver | Solver): The solver objects
         """
-        if isinstance(solver, EMSolver):
-            self.forced_solver.append(solver.get_solver())
-        else:
-            self.forced_solver.append(solver)
-        
+        for solver in solvers:
+            if isinstance(solver, EMSolver):
+                self.forced_solver.append(solver.get_solver())
+            else:
+                self.forced_solver.append(solver)
+    
+    def disable(self, *solvers: EMSolver) -> None:
+        """Disable a given Solver class instance as the main solver. Solvers will be checked on validity for the given problem.
+
+        Args:
+            solver (EMSolver): The solver objects
+        """
+        for solver in solvers:
+            if isinstance(solver, EMSolver):
+                self.disabled_solver.append(solver.get_solver().__class__)
+            else:
+                self.disabled_solver.append(solver.__class__)
+
     def configure(self, 
                   parallel: Literal['SI','MT','MP'] = 'SI', smart_search: bool = False) -> SolveRoutine:
         """Configure the solver with the given settings
@@ -705,6 +743,7 @@ class SolveRoutine:
         self.parallel: Literal['SI','MT','MP'] = 'SI'
         self.smart_search: bool = False
         self.forced_solver = []
+        self.disabled_solver: list[Solver] = []
 
     def _get_solver(self, A: lil_matrix, b: np.ndarray) -> Solver:
         """Returns the relevant Solver object given a certain matrix and source vector
@@ -720,6 +759,8 @@ class SolveRoutine:
 
         """
         for solver in self.forced_solver:
+            if not self._legal_solver(solver):
+                continue
             if isinstance(solver, Solver):
                 return solver
         return self.pick_solver(A,b)
@@ -738,7 +779,7 @@ class SolveRoutine:
             Solver: Returns the direct solver
 
         """
-        return self.solvers[EMSolver.SUPERLU]
+        return self._try_solver(EMSolver.SUPERLU)
     
     def _get_eig_solver(self, A: lil_matrix, b: lil_matrix, direct: bool = None) -> Solver:
         """Returns the relevant eigenmode Solver object given a certain matrix and source vector
@@ -973,21 +1014,21 @@ class AutomaticRoutine(SolveRoutine):
         """
         N = b.shape[0]
         if N < 10_000:
-            return self.solvers[EMSolver.SUPERLU]
+            return self._try_solver(EMSolver.SUPERLU)
         if self.parallel=='SI':
             if _PARDISO_AVAILABLE:
-                return self.solvers[EMSolver.PARDISO]
+                return self._try_solver(EMSolver.PARDISO)
             elif _UMFPACK_AVAILABLE:
-                return self.solvers[EMSolver.UMFPACK]
+                return self._try_solver(EMSolver.UMFPACK)
             else:
-                return self.solvers[EMSolver.SUPERLU]
+                return self._try_solver(EMSolver.SUPERLU)
         elif self.parallel=='MP':
             if _UMFPACK_AVAILABLE:
-                return self.solvers[EMSolver.UMFPACK]
+                return self._try_solver(EMSolver.UMFPACK)
             else:
-                return self.solvers[EMSolver.SUPERLU]
+                return self._try_solver(EMSolver.SUPERLU)
         elif self.parallel=='MT':
-            return self.solvers[EMSolver.SUPERLU]
-        return self.solvers[EMSolver.SUPERLU]
+            return self._try_solver(EMSolver.SUPERLU)
+        return self._try_solver(EMSolver.SUPERLU)
     
 DEFAULT_ROUTINE = AutomaticRoutine()

{emerge-0.4.9.dist-info → emerge-0.4.11.dist-info}/METADATA

@@ -1,21 +1,21 @@
 Metadata-Version: 2.4
 Name: emerge
-Version: 0.4.9
+Version: 0.4.11
 Summary: An open source EM FEM simulator in Python
 Project-URL: Homepage, https://github.com/FennisRobert/EMerge
 Project-URL: Issues, https://github.com/FennisRobert/EMerge/issues
+License-File: LICENSE
 Requires-Python: <4.0,>=3.10
 Requires-Dist: gmsh>=4.13.1
 Requires-Dist: joblib>=1.5.1
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: matplotlib>=3.8.0
+Requires-Dist: mkl!=2024.0; platform_machine == 'x86_64' or platform_machine == 'AMD64'
 Requires-Dist: numba-progress>=1.1.3
 Requires-Dist: numba>=0.57.0
 Requires-Dist: numpy<2.3,>=1.24
 Requires-Dist: pyvista>=0.45.2
 Requires-Dist: scipy>=1.14.0
-Provides-Extra: pypardiso
-Requires-Dist: pypardiso; (platform_machine == 'x86_64' or platform_machine == 'AMD64') and extra == 'pypardiso'
 Provides-Extra: umfpack
 Requires-Dist: scikit-umfpack; (sys_platform != 'win32') and extra == 'umfpack'
 Description-Content-Type: text/markdown
@@ -31,14 +31,25 @@ If you have suggestions/changes/questions either use the Github issue system or
 
 ## How to install
 
-Clone this repository or download the files. While in the EMerge path containing the src/emerge folder, install the module using:
+You can now install the basic version of emerge from PyPi!
 ```
-pip install .
+pip install emerge
 ```
 If you want to install the library with PyPardiso on Intel machines, you can install the optional dependency with EMerge using:
 ```
-pip install ".[pypardiso]"
+pip install emerge[pypardiso]
 ```
+On MacOS and Linux you can install it with the very fast UMFPACK through scikit-umfpack
+
+```
+pip install emerge[scikit-umfpack]
+```
+On linux and MacOS with intel or AMD chips you can also include both:
+
+```
+pip install emerge[scikit-umfpack, pypardiso]
+```
+The `scikit-umfpack` solver can be installed on Windows as well from binaries with conda. This is a bit more complicated and is described in the installation guide.
 
 ## Compatibility
 
@@ -54,7 +65,7 @@ def main():
 if __name__ == "__main__":
     main()
 ```
-Otherwise, the parallel solver will default to SuperLU which is significantly slower on larger problems.
+Otherwise, the parallel solver will default to SuperLU which can be slower on larger problems with a very densely connected/compact matrix.
 
 ## Required libraries
 
@@ -62,13 +73,15 @@ To run this FEM library you need the following libraries
 
  - numpy
  - scipy
- - pypardiso
  - gmsh
  - loguru
  - numba
  - matplotlib (for the matplotlib base display)
  - pyvista (for the PyVista base display)
  - numba-progress
+
+Optional:
+ - pypardiso
  - scikit-umfpack
 
 ## NOTICE

{emerge-0.4.9.dist-info → emerge-0.4.11.dist-info}/RECORD

@@ -1,4 +1,4 @@
-emerge/__init__.py,sha256=cSI-U9W6sLpv5QctE_KmH0poAKWF4p8cMYZ4bBteoCM,1997
+emerge/__init__.py,sha256=WnFoys_CM_EBaFBf7OprK2QJcBbhparelu1uzP8uBJY,1987
 emerge/__main__.py,sha256=WVf16sfrOI910QWohrQDaChZdRifMNoS6VKzCT6f3ZA,92
 emerge/cli.py,sha256=xrNPoX5VtUA0KPRRwZPxC0rGtBDKc2FF8Ro-uPuO-Hg,665
 emerge/lib.py,sha256=usURQQhFdk5oSmcbr6AAUT50-Z-k6jnePdE3BdvUaYY,2548
@@ -14,14 +14,14 @@ emerge/_emerge/geometry.py,sha256=gWLdmkP4Sb-OHinCSuXiNw1BV7hQ8_zmo0PrcfEJXEA,16
 emerge/_emerge/howto.py,sha256=63AwiLbBN0aou12qDOhWuPk7GiBmDySixv5xmRzctV8,8208
 emerge/_emerge/logsettings.py,sha256=eq0hIikrtx4TLFx3W1qlV5CpcH2JRForQb9fi6eXXGI,144
 emerge/_emerge/material.py,sha256=8c3bEov76xqpH1w9s3ZGZ47EuofUNjVeI_IO4RG15Rk,3879
-emerge/_emerge/mesh3d.py,sha256=yOiVHkZRHY0gnXTv5g0V0MsSgyuWC31RxcN_VqfCfXg,29815
+emerge/_emerge/mesh3d.py,sha256=bHy3YxshTFDmzb816udcF0NfKClCHucSx7YAyfMu9cQ,29874
 emerge/_emerge/mesher.py,sha256=cYq6AS1xUWpCrx3JCml5OCoDwNR0Z6FnFFOcH7QoSa4,12654
 emerge/_emerge/periodic.py,sha256=s6B6-zQQ_7MZ4tNRd2a1jzTR3p-RGCW0Y97vLGwirco,9874
 emerge/_emerge/plot.py,sha256=cf1I9mj7EIUJcq8vmANlUkqoV6QqVaJaP-zlC-T9E18,8041
 emerge/_emerge/selection.py,sha256=HoRILOW52pJG1griLqdI5NsIEa3kwB0lsSojVcWtaBA,21087
-emerge/_emerge/simmodel.py,sha256=dfjMWb1AIYqLlLr5XcYAnIotyQijCajBMSXXNYvj5Fc,17241
+emerge/_emerge/simmodel.py,sha256=xlQoS1ecj7w1vXHI_X5NRpvkqDTqOSAbpt5vUIQK1-w,17300
 emerge/_emerge/simulation_data.py,sha256=E3567Ro1YxQlidwZrc5G8IxG46Gnfy-k0wYWxckt1Iw,14128
-emerge/_emerge/solver.py,sha256=zFNenzBGHch2MizT0JY08dqPpqBTsPT9nWREXIvMeww,36437
+emerge/_emerge/solver.py,sha256=LjFEYMQYl1vnbVg_gd8HW5o_YhWjXHccIaJHJpX1gXU,37943
 emerge/_emerge/system.py,sha256=p4HNz7d_LMRNE9Gk75vVdFecDH2iN_groAM9u-yQTpk,1618
 emerge/_emerge/elements/__init__.py,sha256=I3n9aic6lJW-oGeqTEZ-Fpxvyl2i-WqsHdnrM3v1oB8,799
 emerge/_emerge/elements/femdata.py,sha256=Gul5JJQq_gEDjFyf9RwLU-E7Aoh7hIpmrR7nL8SX4Hg,7893
@@ -44,12 +44,13 @@ emerge/_emerge/geo/pcb_tools/macro.py,sha256=ZlKDIZQTXjgklUJZVkaDa17eHIfo9ssq1jX
 emerge/_emerge/mth/common_functions.py,sha256=23_5QpwvoCSTHSkRVuDJlE1ANEPMSe6hSAH56aEmcxc,1233
 emerge/_emerge/mth/integrals.py,sha256=E-vfe21_VGlyJRhqNADdALUhXIKPrwuekTo4GwUyZGA,2702
 emerge/_emerge/mth/optimized.py,sha256=oI3D_hUZXSUMGODMdyY9NZggV2Y7YP5Ky09ZmO4VMZ8,13710
+emerge/_emerge/pardiso/pardiso_solver.py,sha256=u3qCr4wXmUA7MZjTCDMq_2Ho3YWjtlelUQtFuBEPe2s,19043
 emerge/_emerge/physics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 emerge/_emerge/physics/microwave/__init__.py,sha256=QHeILGYWmvbfLl1o9wrTiWLm0evfXDgS0JiikUoMTts,28
 emerge/_emerge/physics/microwave/adaptive_freq.py,sha256=5Ph2V4TTDjrFMeI7MI20JID9BNUNQ_ygtDSHj5Bkpmw,9736
 emerge/_emerge/physics/microwave/microwave_3d.py,sha256=X4hR1wKpnp0BEYj7zkgnDyFgqPX4BIugJokHAeoTwQU,46966
-emerge/_emerge/physics/microwave/microwave_bc.py,sha256=D61ijheyN2Wv1qxhcdsqqk2GNGIRkUy3PJ5LCxV28-g,35236
-emerge/_emerge/physics/microwave/microwave_data.py,sha256=NQiSeUZ27qq476W_LLvzgcjHUpWBjbs2sJFlC12d1mw,42870
+emerge/_emerge/physics/microwave/microwave_bc.py,sha256=ko1yCzbJgoXoQ2QYtzWblCDFkraZsbMDrW6VhtvHMxo,35585
+emerge/_emerge/physics/microwave/microwave_data.py,sha256=jm2PZu4zjcWn6caof4y0xa5wFlFkkYZ58PTxq-1m3tY,43691
 emerge/_emerge/physics/microwave/periodic.py,sha256=wYSUgLFVtCLqSG3EDKoCDRU93iPUzBdXzVRdHTRmbpI,3000
 emerge/_emerge/physics/microwave/port_functions.py,sha256=aVU__AkVk8b1kH2J_oDLF5iNReCxC9nzCtesFSSSSQo,2112
 emerge/_emerge/physics/microwave/sc.py,sha256=EjbbHEZ1zc42V0s8ItrN8jIXkrg3N5R495gfurZ2Wck,4992
@@ -63,7 +64,7 @@ emerge/_emerge/physics/microwave/assembly/robinbc.py,sha256=tJg5GzOGuNybu5qdtOuI
 emerge/_emerge/plot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 emerge/_emerge/plot/display.py,sha256=akwFUOgVEZEIyY6eo05jeFgNvKXy41blwpHohAtn8OM,18247
 emerge/_emerge/plot/grapher.py,sha256=A-FftkaKTHI405hcxP00_FQ9Z6GnvkiP6qRVosiWVcw,2596
-emerge/_emerge/plot/simple_plots.py,sha256=J1ZgzUT4PFMvnlddk7vZ4e07IldUhCIO7m27Sg9PDCQ,18472
+emerge/_emerge/plot/simple_plots.py,sha256=Sy-x1RYsNy2n9t8o34ux7Rp4--TYxvgL0uCNMRBbNEk,18544
 emerge/_emerge/plot/matplotlib/mpldisplay.py,sha256=szKafDrgdAW5Nyc5UOHuJC87n0WGkXYackOVv182TDQ,8671
 emerge/_emerge/plot/pyvista/__init__.py,sha256=CPclatEu6mFnJZzCQk09g6T6Fh20WTbiLAJGSwAnPXU,30
 emerge/_emerge/plot/pyvista/display.py,sha256=PJnM5yDSYrTPT0Ts7Sia2LOkaSs8h1Mj_Gt7q9lF-i4,32908
@@ -72,7 +73,8 @@ emerge/_emerge/projects/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG
 emerge/_emerge/projects/_gen_base.txt,sha256=oQ1y985IeqLo4T7jmKiXLUukn2rSMXfXQS09FoYOqkk,607
 emerge/_emerge/projects/_load_base.txt,sha256=JTAhWvHXJQYKe-aDD4HDdmE7f3VXxeurhDzwFCegrEg,511
 emerge/_emerge/projects/generate_project.py,sha256=TNw-0SpLc82MBq0bd9hB_yqvBZCgmuPonCBsHTp91uk,1450
-emerge-0.4.9.dist-info/METADATA,sha256=JeLh3AAyWVslXBikPV6hw8q_iHsGWmE91S7b9hPl9pY,2524
-emerge-0.4.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-emerge-0.4.9.dist-info/entry_points.txt,sha256=8rFvAXticpKg4OTC8JEvAksnduW72KIEskCGG9XnFf8,43
-emerge-0.4.9.dist-info/RECORD,,
+emerge-0.4.11.dist-info/METADATA,sha256=GSNdpruqnvbva-q-O6S8vae9jRXJ4JLa15TK24azZJI,2901
+emerge-0.4.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+emerge-0.4.11.dist-info/entry_points.txt,sha256=8rFvAXticpKg4OTC8JEvAksnduW72KIEskCGG9XnFf8,43
+emerge-0.4.11.dist-info/licenses/LICENSE,sha256=6tAv8fkWA_-Ell_nboaXajWH3H-vRftIr_4CU2t0S4Y,15180
+emerge-0.4.11.dist-info/RECORD,,

emerge-0.4.11.dist-info/licenses/LICENSE

@@ -0,0 +1,280 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the 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 Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS