pyvpmr 231126__cp311-cp311-macosx_10_9_x86_64.whl → 240307__cp311-cp311-macosx_10_9_x86_64.whl

pyvpmr/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright (C) 2023Theodore Chang
+#  Copyright (C) 2024 Theodore Chang
 #
 #  This program is free software: you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -30,7 +30,7 @@ def split(result: str) -> tuple | None:
     Split the output of the vpmr program into two arrays of complex numbers.
 
     :param result: The raw output of the vpmr program.
-    :return: a tuple of two arrays of complex numbers.
+    :return: A tuple of two arrays of complex numbers.
     """
     split_r = result.strip().split('\n')
     regex = re.compile(r'([+\-]\d+\.\d+e[+\-]\d+){2}j')
@@ -46,8 +46,8 @@ def split(result: str) -> tuple | None:
 
 def plot(
         m: list | np.ndarray, s: list | np.ndarray, kernel: Callable, *,
-        size: tuple = (6, 4),
-        xlim: tuple = (0, 10),
+        size: tuple[float, float] = (6, 4),
+        xlim: tuple[float, float] = (0, 10),
         show: bool = True,
         save_to: str = None
 ):
@@ -93,3 +93,56 @@ def plot(
         plt.show()
     if save_to:
         fig.savefig(save_to)
+
+
+def _process_args(*args):
+    if len(args) == 1:
+        assert 2 == len(args[0])
+        m, s = args[0]
+    elif len(args) == 2:
+        m, s = args
+    else:
+        raise ValueError('Wrong number of arguments.')
+
+    if len(m) == len(s):
+        return np.array(m), np.array(s)
+
+    raise ValueError('The length of m and s must be the same.')
+
+
+def to_global_damping(*args):
+    """
+    Generate a command to use the kernel as a global nonviscous damping model in suanPan.
+    :param args: The m and s values.
+    :return: The command.
+    """
+    command = '# The following can be used as a global nonviscous damping with the Newmark time integration.\n'
+    command += '# You may need to modify the first line to change tag and integration parameters.\n'
+    command += 'integrator NonviscousNewmark 1 .25 .5'
+
+    for m, s in zip(*_process_args(*args)):
+        command += f' \\\n{m.real:+.15e} {m.imag:+.15e} {s.real:+.15e} {s.imag:+.15e}'
+
+    command += '\n'
+
+    return command
+
+
+def to_elemental_damping(*args):
+    """
+    Generate a command to use the kernel as a per-element nonviscous damping model in suanPan.
+    :param args: The m and s values.
+    :return: The command.
+    """
+    command = '# The following can be used as a per-element based nonviscous damping.\n'
+    command += '# You may need to modify the first line to change tags.\n'
+    command += '# Use the alternative form to apply to multiplier elements.\n'
+    command += '# modifier ElementalNonviscousGroup {unique_modifier_tag} {associated_element_group_tag}'
+    command += 'modifier ElementalNonviscous {unique_modifier_tag} {associated_element_tag}'
+
+    for m, s in zip(*_process_args(*args)):
+        command += f' \\\n{m.real:+.15e} {m.imag:+.15e} {s.real:+.15e} {s.imag:+.15e}'
+
+    command += '\n'
+
+    return command

{pyvpmr-231126.dist-info → pyvpmr-240307.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyvpmr
-Version: 231126
+Version: 240307
 Summary: The VPMR Algorithm
 Home-page: https://github.com/TLCFEM/vpmr
 Author: Theodore Chang
@@ -32,16 +32,30 @@ A Python package is also provided.
 Check the reference paper [10.1007/s10915-022-01999-1](https://doi.org/10.1007/s10915-022-01999-1) and
 the [original](https://github.com/ZXGao97/VPMR) MATLAB implementation for more details.
 
+In short, the algorithm tries to find a summation of exponentials to approximate a given kernel function.
+In mathematical terms, it looks for a set of $m_j$ and $s_j$ such that
+
+```math
+\max_{t\in{}I}\left\|g(t)-\sum_jm_j\exp(-s_jt)\right\|<\epsilon.
+```
+
+In the above, $g(t)$ is the given kernel function and $\epsilon$ is the prescribed tolerance.
+
 ## Dependency
 
+The following libraries are required:
+
 1. [gmp](https://gmplib.org/) for multiple precision arithmetic
 2. [mpfr](https://www.mpfr.org/) for multiple-precision floating-point computations
-3. [mpreal](http://www.holoborodko.com/pavel/mpfr/) `mpreal` type C++ wrapper, included
-4. [BigInt](https://github.com/faheel/BigInt) `BigInt` arbitrary large integer for combinatorial number, included
-5. [Eigen](https://eigen.tuxfamily.org/) for matrix decomposition, included
-6. [tbb](https://github.com/oneapi-src/oneTBB) for parallel computing
-7. [exprtk](https://github.com/ArashPartow/exprtk.git) for expression parsing, included
-8. [exprtk-custom-types](https://github.com/ArashPartow/exprtk-custom-types.git) for `mpreal` support, included
+3. [tbb](https://github.com/oneapi-src/oneTBB) for parallel computing
+
+The following libraries are included:
+
+1. [mpreal](http://www.holoborodko.com/pavel/mpfr/) `mpreal` type C++ wrapper, included
+2. [BigInt](https://github.com/faheel/BigInt) `BigInt` arbitrary large integer for combinatorial number, included
+3. [Eigen](https://eigen.tuxfamily.org/) for matrix decomposition, included
+4. [exprtk](https://github.com/ArashPartow/exprtk.git) for expression parsing, included
+5. [exprtk-custom-types](https://github.com/ArashPartow/exprtk-custom-types.git) for `mpreal` support, included
 
 ## How To
 
@@ -60,6 +74,8 @@ On RPM-based Linux distributions (using `dnf`), if you are:
    available), `sudo dnf install -y gcc-c++ tbb-devel mpfr-devel gmp-devel`
 2. using the packaged binary (wheels are available), `sudo dnf install -y gmp mpfr tbb`
 
+On DEB-based Linux distributions (using `apt`), you need to `sudo apt install -y libtbb-dev libmpfr-dev libgmp-dev`.
+
 On macOS, you need to `brew install tbb mpfr gmp`.
 
 Then install the package with `pip`.

pyvpmr-240307.dist-info/RECORD

@@ -0,0 +1,10 @@
+_pyvpmr.cpython-311-darwin.so,sha256=PvEWbe9bARGAZuwYFNVYwyMXV3JIsPoblKFjiOrLpdE,12328688
+pyvpmr/__init__.py,sha256=Bi-DREXwct7QQutAWxBFY8y-nW2qto9JHaG_6pGsA-w,4829
+pyvpmr/.dylibs/libtbb.12.11.dylib,sha256=L7EvWho8o4KbVikpAqItU5mZI6oZbjEJ5EZHx9Z4ZlU,395984
+pyvpmr/.dylibs/libgmp.10.dylib,sha256=wmdidr8avFWum3bQ4SdfAf6p0V7fuSl3LXaQQhdGeFw,486064
+pyvpmr/.dylibs/libmpfr.6.dylib,sha256=rkHO2k_E8OmFgbEEi19EsH5BsIdXkEqOdIfBtUGNUDQ,485904
+pyvpmr-240307.dist-info/RECORD,,
+pyvpmr-240307.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pyvpmr-240307.dist-info/WHEEL,sha256=2rnFQKN1y4ODxAzmbuA5Z6aEng-PoJTYpqGpnJDGdxw,111
+pyvpmr-240307.dist-info/top_level.txt,sha256=Eg1XIUGMpHxqPFJiuE5mRh-LSacMJfhz3QoVoApXeQY,15
+pyvpmr-240307.dist-info/METADATA,sha256=BGij-YZs9a4P3EtgDzSftWge_KvV-5sDc4yhJHeasWE,8554

{pyvpmr-231126.dist-info → pyvpmr-240307.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: false
 Tag: cp311-cp311-macosx_10_9_x86_64
 

pyvpmr-231126.dist-info/RECORD

@@ -1,10 +0,0 @@
-_pyvpmr.cpython-311-darwin.so,sha256=kJ5sQK264grf2YeQOapzFKS-CdClwbwm-Q-eRcHzO_c,12327792
-pyvpmr/__init__.py,sha256=r72K3AwbwV1LeFRKju6W96nZA38ZTE6mdf17Y25QOrM,2986
-pyvpmr/.dylibs/libtbb.12.10.dylib,sha256=TGQLgN2tiRa-KGvobwrLt657chXIpFztVljxj_VXLM8,369280
-pyvpmr/.dylibs/libgmp.10.dylib,sha256=wmdidr8avFWum3bQ4SdfAf6p0V7fuSl3LXaQQhdGeFw,486064
-pyvpmr/.dylibs/libmpfr.6.dylib,sha256=rkHO2k_E8OmFgbEEi19EsH5BsIdXkEqOdIfBtUGNUDQ,485904
-pyvpmr-231126.dist-info/RECORD,,
-pyvpmr-231126.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-pyvpmr-231126.dist-info/WHEEL,sha256=5U6zMLjLMU3ChsYHNhPGpmR9mcu95nmKsgiMOIhWXnU,111
-pyvpmr-231126.dist-info/top_level.txt,sha256=Eg1XIUGMpHxqPFJiuE5mRh-LSacMJfhz3QoVoApXeQY,15
-pyvpmr-231126.dist-info/METADATA,sha256=_EXdG3WATY-DONBgcBaPyiJMp3OMFUZT57ud0FexcLg,8006