radia 1.0.10__tar.gz → 1.1.1__tar.gz

radia-1.1.1/LICENSE

@@ -0,0 +1,93 @@
+RADIA SOFTWARE LICENSE
+======================
+
+This software contains multiple components with different licenses:
+
+1. RADIA Core (BSD-style License)
+2. HACApK_LH-Cimplm Library (MIT License)
+
+All licenses are permissive open-source licenses allowing redistribution
+and modification.
+
+================================================================================
+PART 1: RADIA CORE
+================================================================================
+
+Copyright © 1997 - 2018, European Synchrotron Radiation Facility
+
+The RADIA software is distributed subject to the following license conditions:
+
+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.
+
+DISCLAIMER: THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
+
+The views and conclusions contained in the software and documentation are
+those of the authors and should not be interpreted as representing official
+policies, either expressed or implied, of the RADIA project.
+
+================================================================================
+PART 2: HACApK_LH-Cimplm (H-matrix Library)
+================================================================================
+
+Software Name : HACApK
+Version : 1.3.0
+Location: src/ext/HACApK_LH-Cimplm/
+
+Copyright (c) 2015 Akihiro Ida and Takeshi Iwashita
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+ppOpen-HPC project:
+  Open Source Infrastructure for Development and Execution of Large-Scale
+  Scientific Applications on Post-Peta-Scale Supercomputers with Automatic
+  Tuning (AT).
+
+Sponsorship:
+  Japan Science and Technology Agency (JST), Basic Research Programs: CREST,
+  Development of System Software Technologies for post-Peta Scale High
+  Performance Computing.
+
+================================================================================
+ADDITIONAL COMPONENTS
+================================================================================
+
+This software may include additional third-party libraries and components,
+each governed by their respective licenses. Please refer to the individual
+component directories for specific license information.
+
+================================================================================

{radia-1.0.10/src/radia.egg-info → radia-1.1.1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: radia
-Version: 1.0.10
+Version: 1.1.1
 Summary: Radia 3D Magnetostatics with NGSolve Integration and OpenMP Parallelization
 Home-page: https://github.com/ksugahar/Radia_NGSolve
 Author: Pascal Elleaume
 Author-email: Oleg Chubar <chubar@bnl.gov>
 Maintainer: Radia Development Team
-License: LGPL-2.1
+License: BSD-style AND MIT
 Project-URL: Homepage, https://github.com/ksugahar/Radia_NGSolve
 Project-URL: Documentation, https://github.com/ksugahar/Radia_NGSolve/blob/master/README.md
 Project-URL: Repository, https://github.com/ksugahar/Radia_NGSolve
@@ -16,6 +16,8 @@ Project-URL: ESRF Radia Page, https://www.esrf.fr/Accelerators/Groups/InsertionD
 Keywords: magnetostatics,magnetic field,radia,ngsolve,fem,synchrotron
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: C++
 Classifier: Topic :: Scientific/Engineering :: Physics
@@ -59,6 +61,7 @@ This repository adds NGSolve integration and performance improvements while main
 
 ## Key Features
 
+- ✓ **H-matrix acceleration** - Fast hierarchical matrix solver using [HACApK](https://github.com/Post-Peta-Crest/ppOpenHPC/tree/MATH/HACApK)
 - ✓ OpenMP parallel field computation
 - ✓ NGSolve C++ CoefficientFunction integration
 - ✓ VTK export functionality (`rad.ObjDrwVTK`)
@@ -150,7 +153,7 @@ import rad_ngsolve
 
 # Create Radia magnet
 magnet = rad.ObjRecMag([0,0,0], [20,20,20], [0,0,1.2])  # mm units
-rad.MatApl(magnet, rad.MatLin([0.06, 0.17], [0,0,1.2]))  # NdFeB
+rad.MatApl(magnet, rad.MatPM(1.2, 900000, [0,0,1]))  # NdFeB permanent magnet
 rad.Solve(magnet, 0.0001, 10000)
 
 # Create NGSolve CoefficientFunction for different field types
@@ -256,7 +259,10 @@ See [tests/README.md](tests/README.md) for detailed testing documentation.
 
 ```python
 import sys
-sys.path.insert(0, 'S:/radia/01_GitHub/src/python')
+import os
+
+# Add src/python to path (adjust path as needed for your installation)
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'src', 'python'))
 
 from radia_pyvista_viewer import view_radia_object
 
@@ -268,7 +274,10 @@ view_radia_object(mag)
 
 ```python
 import sys
-sys.path.insert(0, 'S:/radia/01_GitHub/src/python')
+import os
+
+# Add src/python to path (adjust path as needed for your installation)
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'src', 'python'))
 
 from radia_vtk_export import export_geometry_to_vtk
 
@@ -301,6 +310,7 @@ export_geometry_to_vtk(mag, 'geometry.vtk')
 - Python 2.7, 3.6, 3.7, 3.8 support
 
 ### Added Features
+- **H-matrix acceleration** - Hierarchical matrix solver using [HACApK library](https://github.com/Post-Peta-Crest/ppOpenHPC/tree/MATH/HACApK) (9-50x speedup for large problems)
 - OpenMP parallelization (2.7x speedup)
 - NGSolve C++ CoefficientFunction integration
 - PyVista viewer support
@@ -311,15 +321,26 @@ export_geometry_to_vtk(mag, 'geometry.vtk')
 
 ## License
 
-This project is licensed under **LGPL-2.1** (to match NGSolve licensing).
+This project contains multiple components with different open-source licenses:
+
+### RADIA Core
+Licensed under a **BSD-style license** by the European Synchrotron Radiation Facility (ESRF).
+- Copyright © 1997-2018, European Synchrotron Radiation Facility
+- Permits redistribution and modification with attribution
 
-The original RADIA code is licensed under a **BSD-style license** by the European Synchrotron Radiation Facility (ESRF), Copyright © 1997-2018.
+### HACApK_LH-Cimplm (H-matrix Library)
+Licensed under the **MIT License**.
+- Copyright © 2015, Akihiro Ida and Takeshi Iwashita
+- Location: `src/ext/HACApK_LH-Cimplm/`
+- ppOpen-HPC project
 
-Both licenses are included in the `LICENSE` file. The BSD-style license is compatible with and subsumed by the LGPL-2.1 license used for this derivative work.
+Both licenses are permissive open-source licenses that allow free use, modification,
+and redistribution.
 
 See:
-- `LICENSE` - Complete license text (LGPL-2.1 + Original RADIA BSD-style)
-- `COPYRIGHT.txt` - Original RADIA copyright notice
+- `LICENSE` - Complete license text for both components
+- `COPYRIGHT.txt` - Original RADIA BSD-style license
+- `src/ext/HACApK_LH-Cimplm/LICENSE` - HACApK MIT license
 
 ## Credits
 

{radia-1.0.10 → radia-1.1.1}/README.md

@@ -19,6 +19,7 @@ This repository adds NGSolve integration and performance improvements while main
 
 ## Key Features
 
+- ✓ **H-matrix acceleration** - Fast hierarchical matrix solver using [HACApK](https://github.com/Post-Peta-Crest/ppOpenHPC/tree/MATH/HACApK)
 - ✓ OpenMP parallel field computation
 - ✓ NGSolve C++ CoefficientFunction integration
 - ✓ VTK export functionality (`rad.ObjDrwVTK`)
@@ -110,7 +111,7 @@ import rad_ngsolve
 
 # Create Radia magnet
 magnet = rad.ObjRecMag([0,0,0], [20,20,20], [0,0,1.2])  # mm units
-rad.MatApl(magnet, rad.MatLin([0.06, 0.17], [0,0,1.2]))  # NdFeB
+rad.MatApl(magnet, rad.MatPM(1.2, 900000, [0,0,1]))  # NdFeB permanent magnet
 rad.Solve(magnet, 0.0001, 10000)
 
 # Create NGSolve CoefficientFunction for different field types
@@ -216,7 +217,10 @@ See [tests/README.md](tests/README.md) for detailed testing documentation.
 
 ```python
 import sys
-sys.path.insert(0, 'S:/radia/01_GitHub/src/python')
+import os
+
+# Add src/python to path (adjust path as needed for your installation)
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'src', 'python'))
 
 from radia_pyvista_viewer import view_radia_object
 
@@ -228,7 +232,10 @@ view_radia_object(mag)
 
 ```python
 import sys
-sys.path.insert(0, 'S:/radia/01_GitHub/src/python')
+import os
+
+# Add src/python to path (adjust path as needed for your installation)
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'src', 'python'))
 
 from radia_vtk_export import export_geometry_to_vtk
 
@@ -261,6 +268,7 @@ export_geometry_to_vtk(mag, 'geometry.vtk')
 - Python 2.7, 3.6, 3.7, 3.8 support
 
 ### Added Features
+- **H-matrix acceleration** - Hierarchical matrix solver using [HACApK library](https://github.com/Post-Peta-Crest/ppOpenHPC/tree/MATH/HACApK) (9-50x speedup for large problems)
 - OpenMP parallelization (2.7x speedup)
 - NGSolve C++ CoefficientFunction integration
 - PyVista viewer support
@@ -271,15 +279,26 @@ export_geometry_to_vtk(mag, 'geometry.vtk')
 
 ## License
 
-This project is licensed under **LGPL-2.1** (to match NGSolve licensing).
+This project contains multiple components with different open-source licenses:
+
+### RADIA Core
+Licensed under a **BSD-style license** by the European Synchrotron Radiation Facility (ESRF).
+- Copyright © 1997-2018, European Synchrotron Radiation Facility
+- Permits redistribution and modification with attribution
 
-The original RADIA code is licensed under a **BSD-style license** by the European Synchrotron Radiation Facility (ESRF), Copyright © 1997-2018.
+### HACApK_LH-Cimplm (H-matrix Library)
+Licensed under the **MIT License**.
+- Copyright © 2015, Akihiro Ida and Takeshi Iwashita
+- Location: `src/ext/HACApK_LH-Cimplm/`
+- ppOpen-HPC project
 
-Both licenses are included in the `LICENSE` file. The BSD-style license is compatible with and subsumed by the LGPL-2.1 license used for this derivative work.
+Both licenses are permissive open-source licenses that allow free use, modification,
+and redistribution.
 
 See:
-- `LICENSE` - Complete license text (LGPL-2.1 + Original RADIA BSD-style)
-- `COPYRIGHT.txt` - Original RADIA copyright notice
+- `LICENSE` - Complete license text for both components
+- `COPYRIGHT.txt` - Original RADIA BSD-style license
+- `src/ext/HACApK_LH-Cimplm/LICENSE` - HACApK MIT license
 
 ## Credits
 

{radia-1.0.10 → radia-1.1.1}/docs/API_REFERENCE.md

@@ -251,29 +251,137 @@ pieces = rad.ObjDivMag(magnet, [[3,1.5], [3,1.5], [3,1.5]])
 
 ## Materials
 
-### MatLin
+### MatLin - Isotropic Linear Material ⭐ NEW API
+
 ```python
-material = rad.MatLin([ksi_parallel, ksi_perpendicular], remanence)
+material = rad.MatLin(ksi)
 ```
-Creates a linear anisotropic magnetic material.
+
+Creates an **isotropic** linear magnetic material.
 
 **Parameters**:
-- `[ksi_parallel, ksi_perpendicular]`: Susceptibilities parallel/perpendicular to easy axis
-- `remanence`: Scalar magnitude or `[Mx, My, Mz]` vector (T)
-  - Scalar: Easy axis set by object's magnetization direction
-  - Vector: Easy axis set explicitly
+- `ksi` (float): Magnetic susceptibility (dimensionless)
+- Relative permeability: μᵣ = 1 + ksi
 
 **Example**:
 ```python
-# Isotropic linear, no remanence (soft iron)
-mat = rad.MatLin([999, 999], [0, 0, 0])
+# Soft iron (μᵣ ≈ 1000)
+mat = rad.MatLin(999)
+block = rad.ObjRecMag([0,0,0], [10,10,10], [0,0,0])
+rad.MatApl(block, mat)
+rad.Solve(block, 0.0001, 1000)
+```
+
+**⚠️ Note**: MatLin is for magnetic materials that respond to external fields (soft iron, transformer cores, etc.). For permanent magnets, use `MatPM` instead.
+
+---
+
+### MatLin - Anisotropic Linear Material ⭐ NEW API
 
-# Anisotropic with remanence in z
-mat = rad.MatLin([1000, 100], [0, 0, 1.2])
+```python
+material = rad.MatLin([ksi_par, ksi_perp], [ex, ey, ez])
+```
+
+Creates an **anisotropic** linear magnetic material.
+
+**Parameters**:
+- `[ksi_par, ksi_perp]`: Susceptibilities parallel/perpendicular to easy axis
+- `[ex, ey, ez]`: Easy magnetization axis direction
+
+**Example**:
+```python
+mat = rad.MatLin([1000, 10], [0, 0, 1])  # Easy axis: Z
+rad.MatApl(block, mat)
 ```
 
 ---
 
+**⚠️ Note**: MatLin is for magnetic materials that respond to external fields. For permanent magnets, use `MatPM` instead.
+
+### MatPM - Permanent Magnet with Demagnetization ⭐ NEW
+
+```python
+material = rad.MatPM(Br, Hc, [mx, my, mz])
+```
+
+Creates a permanent magnet material with linear demagnetization curve.
+
+**Parameters**:
+- `Br` (float): Residual flux density [Tesla]
+- `Hc` (float): Coercivity [A/m]
+- `[mx, my, mz]`: Easy magnetization axis direction
+
+**B-H Relationship**:
+```
+B = Br + μ₀ · μᵣₑc · H
+μᵣₑc = Br / (μ₀ · Hc)
+```
+
+**Typical Values**:
+| Material | Br [T] | Hc [kA/m] |
+|----------|--------|-----------|
+| NdFeB N52 | 1.43 | 876 |
+| NdFeB N42 | 1.32 | 876 |
+| SmCo | 1.10 | 800 |
+| Ferrite | 0.40 | 240 |
+
+**Example**:
+```python
+# NdFeB N52 magnet
+mat = rad.MatPM(1.43, 876000, [0, 0, 1])  # Br=1.43T, Hc=876kA/m
+magnet = rad.ObjRecMag([0,0,0], [20,20,10], [0,0,0])
+rad.MatApl(magnet, mat)
+rad.Solve(magnet, 0.0001, 1000)
+```
+
+---
+
+### MatLin - Legacy API ⚠️ DEPRECATED
+
+```python
+material = rad.MatLin([ksi_parallel, ksi_perpendicular], mr)
+```
+Creates a linear anisotropic magnetic material.
+
+**Usage**: For magnetic materials that respond to external fields. **NOT for permanent magnets** (which have fixed magnetization and don't need material properties).
+
+**Parameters**:
+- `[ksi_parallel, ksi_perpendicular]`: Susceptibilities parallel/perpendicular to easy magnetization axis
+- `mr`: Remanent magnetization - defines the easy magnetization axis (must be non-zero)
+  - **Scalar form**: `mr` = magnitude only (A/m)
+    - Easy axis direction taken from object's initial magnetization vector
+  - **Vector form**: `[mrx, mry, mrz]` = remanent magnetization vector (A/m)
+    - Easy axis direction explicitly defined by this vector
+
+**Physical Meaning**:
+- `mr` (remanent magnetization) defines the **easy magnetization axis** (direction of parallel susceptibility)
+- Susceptibility parallel (ksi_parallel): Material response along easy axis
+- Susceptibility perpendicular (ksi_perpendicular): Material response perpendicular to easy axis
+
+**Examples**:
+```python
+# Form 1: Scalar mr - easy axis from object's magnetization
+obj = rad.ObjRecMag([0,0,0], [10,10,10], [0,0,1])  # Initial M in z-direction
+mat = rad.MatLin([0.06, 0.17], 100)  # Easy axis = z (from object), |Mr| = 100 A/m
+rad.MatApl(obj, mat)
+
+# Form 2: Vector mr - easy axis explicitly defined
+mat = rad.MatLin([0.06, 0.17], [0, 0, 100])  # Easy axis in z, |Mr| = 100 A/m
+rad.MatApl(obj, mat)  # Applied to any object
+
+# Isotropic linear material (equal susceptibilities in all directions)
+mat = rad.MatLin([1000, 1000], [0, 0, 100])  # Mr still needed as reference
+```
+
+**Important Notes**:
+- Permanent magnets: Use `rad.ObjRecMag([x,y,z], [dx,dy,dz], [mx,my,mz])` only - no material needed
+- Magnetic materials: Use MatLin or MatSatIsoFrm for materials responding to fields
+- `mr` must be non-zero (either as scalar magnitude or vector)
+
+**⚠️ DEPRECATED**: Use the new `MatLin(ksi)`, `MatLin([ksi_par, ksi_perp], [ex,ey,ez])`, `MatPM()`, or `MatPMLinear()` APIs instead.
+
+---
+
 ### MatSatIsoFrm
 ```python
 material = rad.MatSatIsoFrm([ksi1,ms1], [ksi2,ms2], [ksi3,ms3])
@@ -324,30 +432,40 @@ Creates nonlinear anisotropic material with separate parallel/perpendicular char
 
 ### Common Material Configuration Examples
 
-Below are typical material parameters for common magnetic materials. These can be created using `MatLin` for permanent magnets or `MatSatIsoFrm` for soft magnetic materials.
+Below are typical material parameters for common magnetic materials. Use **`MatPM`** for permanent magnets or **`MatSatIsoFrm`** for soft magnetic materials. For linear magnetic materials (non-permanent), use **`MatLin`**.
+
+#### Permanent Magnet Materials
 
-#### Permanent Magnet Materials (Linear Anisotropic)
+**Important**: For permanent magnets, use **`MatPM`** (NEW API) or create objects with fixed magnetization using `ObjRecMag` directly.
 
-**NdFeB** (Neodymium-Iron-Boron):
+**NdFeB N52** (Neodymium-Iron-Boron):
 ```python
-mat = rad.MatLin([0.06, 0.17], [0, 0, 1.2])  # ksi_par=0.06, ksi_perp=0.17, Mr=1.2 T
+# Method 1: Using MatPM (recommended for materials with demagnetization)
+mat = rad.MatPM(1.43, 876000, [0, 0, 1])  # Br=1.43T, Hc=876kA/m, easy axis=Z
+magnet = rad.ObjRecMag([0,0,0], [20,20,10], [0,0,0])
+rad.MatApl(magnet, mat)
+
+# Method 2: Fixed magnetization (for simple permanent magnets)
+magnet = rad.ObjRecMag([0,0,0], [20,20,10], [0,0,1.2])  # M=1.2T, no material needed
 ```
 
-**SmCo5** (Samarium-Cobalt):
+**NdFeB N42**:
 ```python
-mat = rad.MatLin([0.005, 0.04], [0, 0, 0.85])  # Mr=0.85 T
+mat = rad.MatPM(1.32, 876000, [0, 0, 1])  # Br=1.32T, Hc=876kA/m
 ```
 
-**Sm2Co17** (Samarium-Cobalt 2:17):
+**SmCo** (Samarium-Cobalt):
 ```python
-mat = rad.MatLin([0.005, 0.04], [0, 0, 1.05])  # Mr=1.05 T
+mat = rad.MatPM(1.10, 800000, [0, 0, 1])  # Br=1.10T, Hc=800kA/m
 ```
 
 **Ferrite**:
 ```python
-mat = rad.MatLin([0.07, 0.2], [0, 0, 0.35])  # Mr=0.35 T
+mat = rad.MatPM(0.40, 240000, [0, 0, 1])  # Br=0.40T, Hc=240kA/m
 ```
 
+**⚠️ IMPORTANT**: Do NOT use `MatLin` for permanent magnets. `MatLin` is only for linear magnetic materials that respond to external fields (soft iron, transformer cores, etc.).
+
 #### Soft Magnetic Materials (Nonlinear Isotropic)
 
 **Xc06** (Low Carbon Steel, C<0.06%):