ElecSolver 0.1.4__py3-none-any.whl → 1.0.0__py3-none-any.whl

ElecSolver/FrequencySystemBuilder.py

@@ -1,6 +1,7 @@
 import numpy as np
 import networkx as nx
 from scipy.sparse import coo_matrix
+from .utils import SolutionFrequency
 
 
 class FrequencySystemBuilder():
@@ -52,7 +53,7 @@ class FrequencySystemBuilder():
         self.offset_i = offset_i
         self.offset_j = offset_j
 
-    def set_mass(self,*args):
+    def set_ground(self,*args):
         for index in args:
             for pivot,subsystem in enumerate(self.list_of_subgraphs):
                 if index in subsystem:
@@ -252,13 +253,13 @@ class FrequencySystemBuilder():
     def build_intensity_and_voltage_from_vector(self,sol):
         sign = np.sign(self.impedence_coords[1]-self.impedence_coords[0])
         if self.source_count!=0:
-            return (sol[:self.number_intensities]*sign,
+            return SolutionFrequency(sol[:self.number_intensities]*sign,
                     sol[self.number_intensities:-self.source_count],
                     sol[...,-self.source_count:]*self.source_signs
                     )
 
         else:
-            return (sol[:self.number_intensities]*sign,
+            return SolutionFrequency(sol[:self.number_intensities]*sign,
                     sol[self.number_intensities:],
                     np.array([],dtype=float)
                     )

ElecSolver/TemporalSystemBuilder.py

@@ -1,7 +1,7 @@
 import numpy as np
 import networkx as nx
 from scipy.sparse import coo_matrix, block_diag
-
+from .utils import SolutionTemporal
 
 class TemporalSystemBuilder():
     def __init__(self,coil_coords,coil_data,res_coords,res_data,capa_coords,capa_data,inductive_mutuals_coords,inductive_mutuals_data,res_mutual_coords,res_mutual_data):
@@ -88,7 +88,7 @@ class TemporalSystemBuilder():
         self.offset_i = offset_i
         self.offset_j = offset_j
 
-    def set_mass(self,*args):
+    def set_ground(self,*args):
         """Function to affect a mass to subsystems
         If the system already has a mass provided then a warning is displayed and mass reaffected
         """
@@ -446,14 +446,14 @@ class TemporalSystemBuilder():
         offset_res = self.res_data.shape[0]
         offset_capa = self.capa_data.shape[0]
         if self.source_count!=0:
-            return (sol[...,:offset_coil]*sign[:offset_coil],
+            return SolutionTemporal(sol[...,:offset_coil]*sign[:offset_coil],
                 sol[...,offset_coil:offset_coil+offset_res]*sign[offset_coil:offset_coil+offset_res],
                 sol[...,offset_coil+offset_res:offset_coil+offset_res+offset_capa]*sign[offset_coil+offset_res:offset_coil+offset_res+offset_capa],
                 sol[...,self.number_intensities:-self.source_count],
                 sol[...,-self.source_count:]*self.source_signs
             )
         else:
-            return (sol[...,:offset_coil]*sign[:offset_coil],
+            return SolutionTemporal(sol[...,:offset_coil]*sign[:offset_coil],
                 sol[...,offset_coil:offset_coil+offset_res]*sign[offset_coil:offset_coil+offset_res],
                 sol[...,offset_coil+offset_res:offset_coil+offset_res+offset_capa]*sign[offset_coil+offset_res:offset_coil+offset_res+offset_capa],
                 sol[...,self.number_intensities:],

ElecSolver/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.4'
-__version_tuple__ = version_tuple = (0, 1, 4)
+__version__ = version = '1.0.0'
+__version_tuple__ = version_tuple = (1, 0, 0)

ElecSolver/utils.py

@@ -1,5 +1,9 @@
 import numpy as np
 from scipy.sparse import coo_matrix
+from collections import namedtuple
+
+SolutionFrequency = namedtuple("ComplexSolution",["intensities","potentials","intensities_sources"])
+SolutionTemporal = namedtuple("RealSolution",["intensities_coil","intensities_res","intensities_capa","potentials","intensities_sources"])
 
 def parallel_sum(*impedences):
     """Function to compute the graph of impedences resulting from // graphs

{elecsolver-0.1.4.dist-info → elecsolver-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ElecSolver
-Version: 0.1.4
+Version: 1.0.0
 Summary: Formalizes electric systems as linear problems for temporal and frequency-domain studies.
 Author-email: William Piat <william.piat3@gmail.com>
 License: MIT
@@ -57,6 +57,7 @@ Its main goal is to provide a friendly Python interface for simulating analog el
       - [Features](#features-1)
       - [Example](#example-1)
   - [Solver suggestions](#solver-suggestions)
+  - [Extra uses: Hydraulic or Thermal system modeling](#extra-uses-hydraulic-or-thermal-system-modeling)
 
 ## How to install
 For now this package is distributed on pypi and can be installed using pip
@@ -117,9 +118,9 @@ electric_sys = FrequencySystemBuilder(
     mutuals_data
 )
 
-# Set node masses
-# 2 values because 2 subsystems
-electric_sys.set_mass(0, 3)
+# Set ground
+# 2 values because one for each subsystem
+electric_sys.set_ground(0, 3)
 # Building system
 electric_sys.build_system()
 electric_sys.build_second_member_intensity(intensity=10, input_node=2, output_node=0)
@@ -127,10 +128,10 @@ electric_sys.build_second_member_intensity(intensity=10, input_node=2, output_no
 # Get and solve the system
 sys, b = electric_sys.get_system()
 sol = spsolve(sys.tocsr(), b)
-intensities, potentials = electric_sys.build_intensity_and_voltage_from_vector(sol)
+frequencial_response = electric_sys.build_intensity_and_voltage_from_vector(sol)
 
 ## We see a tension appearing on the lonely coil (between node 3 and 4)
-print(potentials[3]-potentials[4])
+print(frequencial_response.potentials[3]-frequencial_response.potentials[4])
 ```
 #### Adding a Parallel Resistance
 We want to add components in parallel with existing components for instance inserting a resistor in parallel with the first inductance (between nodes 0 and 2)
@@ -200,8 +201,8 @@ res_mutuals_data = np.array([],dtype=float)
 
 ## initializing system
 elec_sys = TemporalSystemBuilder(coil_coords,coil_data,res_coords,res_data,capa_coords,capa_data,mutuals_coords,mutuals_data,res_mutuals_coords,res_mutuals_data)
-## Seting mass at point 0
-elec_sys.set_mass(0)
+## Seting ground at point 0
+elec_sys.set_ground(0)
 ## Build second member
 elec_sys.build_system()
 elec_sys.build_second_member_intensity(10,1,0)
@@ -217,9 +218,9 @@ dt=0.08
 vals_res1 = []
 vals_res2 = []
 for i in range(50):
-    currents_coil,currents_res,currents_capa,voltages,_ = elec_sys.build_intensity_and_voltage_from_vector(sol)
-    vals_res1.append(currents_res[1])
-    vals_res2.append(currents_res[0])
+    temporal_response = elec_sys.build_intensity_and_voltage_from_vector(sol)
+    vals_res1.append(temporal_response.intensities_res[1])
+    vals_res2.append(temporal_response.intensities_res[0])
     ## implicit euler time iterations
     sol = spsolve(S2+dt*S1,b*dt+S2@sol)
 import matplotlib.pyplot as plt
@@ -244,3 +245,64 @@ This outputs the following graph that displays the intensity passing through the
 > [!TIP]
 > See example `tests.test_temporal_system` in the tests on how to use pyMUMPS for solving the resulting system efficiently.
 
+
+## Extra uses: Hydraulic or Thermal system modeling
+
+This repository can be used as is in order to model the mass flow or thermal flux in respectively Hydraulic networks or Thermal networks where a difference of pressure or a difference of temperature can be assimilated to a tension source. Since electric potentials are always computed relatively to the ground node you might need to rescale the resulting potentials:
+
+We are considering the following hydraulic problem:
+
+![Hydraulic system](img/hydraulic.png)
+
+Taking R=1 this gives
+
+```python
+import numpy as np
+from scipy.sparse.linalg import spsolve
+from ElecSolver import TemporalSystemBuilder
+
+## Defining resistances
+R = 1
+res_coords  = np.array([[0,2,1,0,1,3],[1,3,3,2,2,0]],dtype=int)
+res_data = R*np.array([2,3,1,1,1,1],dtype=float)
+
+## Here we are not using coils, capacities or mutuals we defined them as empty
+## Defining 0 coil
+coil_coords  = np.array([[],[]],dtype=int)
+coil_data = np.array([],dtype=float)
+## Defining 0 capacity
+capa_coords = np.array([[],[]],dtype=int)
+capa_data = np.array([],dtype=float)
+
+## Defining no mutual
+mutuals_coords=np.array([[],[]],dtype=int)
+mutuals_data = np.array([],dtype=float)
+
+
+res_mutuals_coords=np.array([[],[]],dtype=int)
+res_mutuals_data = np.array([],dtype=float)
+
+## initializing system
+hydraulic_sys = TemporalSystemBuilder(coil_coords,coil_data,res_coords,res_data,capa_coords,capa_data,mutuals_coords,mutuals_data,res_mutuals_coords,res_mutuals_data)
+## Seting ground at point 0
+hydraulic_sys.set_ground(0)
+## Build second member
+hydraulic_sys.build_system()
+## enforcing a pressure delta of 10 Pa
+hydraulic_sys.build_second_member_tension(10,1,0)
+# get system (S1 is real part, S2 derivative part)
+# the problem is only resitive thus S2 =0
+S1,S2,rhs = hydraulic_sys.get_system()
+
+sol = spsolve(S1.tocsr(),rhs)
+solution = hydraulic_sys.build_intensity_and_voltage_from_vector(sol)
+# After you computed the solution of the system
+
+pressure_input=10000
+pressure_node=0
+# Rescaling the potential to the new reference
+potentials = solution.potentials - solution.potentials[pressure_node] + pressure_input
+print("Pressures in the system:", potentials)
+## get the flux passing through the system
+print("Debit through the system",solution.intensities_sources[0])
+```

elecsolver-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+ElecSolver/FrequencySystemBuilder.py,sha256=1OKNv2NhKvzvCzK8f1XEzmUoP2gbD1tUXNY43cL7j9E,12035
+ElecSolver/TemporalSystemBuilder.py,sha256=AIJSd2qU83XRhiGO7QZFpVMGFz5Ii2f0RZzlBhIe76M,23564
+ElecSolver/__init__.py,sha256=jYln4Hwpz5Y7aXUxCnHU6kPs--2MXc58rbaTTQvcE8I,224
+ElecSolver/_version.py,sha256=fo5PXsZuloQZu3LdpIFTUAXvJmY2L9N5sNGe2tvdU98,511
+ElecSolver/utils.py,sha256=mrGSWW5osBrAKYathyjM9KgZDzVaweqjx2paNvumVQA,5491
+elecsolver-1.0.0.dist-info/licenses/LICENCE.txt,sha256=v-lfIiLUg0gkkSbraLUejUcFsyG7SbKQaK7GqgIEWFQ,1068
+elecsolver-1.0.0.dist-info/METADATA,sha256=LMcmfVzSPRuT5OdoI8dUghL6pjonTjQXYTYkzPJky54,10549
+elecsolver-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+elecsolver-1.0.0.dist-info/top_level.txt,sha256=2toqgPNV9y44OzukZZEL4qeFZFkNR1GXZjIlZVmC-Ic,11
+elecsolver-1.0.0.dist-info/RECORD,,

elecsolver-0.1.4.dist-info/RECORD

@@ -1,10 +0,0 @@
-ElecSolver/FrequencySystemBuilder.py,sha256=8GoF8R1d1Qfs3f2y4tXJfu5Yq7iPrZXM-cwogdzu5v0,11962
-ElecSolver/TemporalSystemBuilder.py,sha256=L8VpWzU-7BE4NCHuuvlTdZnjJHdcsuP4HRXpVA0dMAM,23495
-ElecSolver/__init__.py,sha256=jYln4Hwpz5Y7aXUxCnHU6kPs--2MXc58rbaTTQvcE8I,224
-ElecSolver/_version.py,sha256=hcPkC9vIGgfrKK6ft7ysLT7iOCjpFmCBmyKLmXiaZ1g,511
-ElecSolver/utils.py,sha256=GyNjn9a96DVxvKJzCCsj-g_TZJY6GjdqC-O2sHw5k5s,5215
-elecsolver-0.1.4.dist-info/licenses/LICENCE.txt,sha256=v-lfIiLUg0gkkSbraLUejUcFsyG7SbKQaK7GqgIEWFQ,1068
-elecsolver-0.1.4.dist-info/METADATA,sha256=88i33iEzSAO0aPOb-kXVrXM3717ol73jzJbYtHQAh1k,8110
-elecsolver-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-elecsolver-0.1.4.dist-info/top_level.txt,sha256=2toqgPNV9y44OzukZZEL4qeFZFkNR1GXZjIlZVmC-Ic,11
-elecsolver-0.1.4.dist-info/RECORD,,