Declarative interface

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2.1
 jobs:
   build:
     docker:
-     - image: cimg/base:current-22.04
+     - image: cimg/base:2022.08-22.04
     parallelism: 8
     steps:
       - checkout

benchmark/tst.py

@@ -50,7 +50,7 @@ def __init__(self, tag="tm", C=1000, T0=0):
     def eval(self, scope):
 #        print(scope.C, scope.P, scope.T)
 
-        scope.T_dot = scope.P / scope.C
+        scope.T_dot = scope.P / scope.var3
 
 
 class Thermal_Conductor(Subsystem):

docs/source/conf.py

@@ -53,19 +53,19 @@
 # needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# extensions coming with Sphinx (named 'sphinx.declarative.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.napoleon',
+    'sphinx.declarative.autodoc',
+    'sphinx.declarative.doctest',
+    'sphinx.declarative.intersphinx',
+    'sphinx.declarative.todo',
+    'sphinx.declarative.coverage',
+    'sphinx.declarative.mathjax',
+    'sphinx.declarative.ifconfig',
+    'sphinx.declarative.viewcode',
+    'sphinx.declarative.githubpages',
+    'sphinx.declarative.napoleon',
     "sphinx_rtd_theme",
 ]
 

examples/dampened_oscillator/dampened_oscillator_declarative.py

@@ -0,0 +1,130 @@
+from numerous.declarative.specification import ScopeSpec, ItemsSpec, Module, EquationSpec
+from numerous.declarative.variables import Parameter, Constant, State
+from numerous.declarative.bus import Connector, create_connections, get_value_for, set_value_from
+
+import numpy as np
+
+
+class DampenedOscillator(Module):
+    """
+        Equation and item modelling a spring and dampener
+    """
+    tag = "dampened_oscillator"
+
+    class Mechanics(ScopeSpec):
+        # Define variables
+        k = Constant(1) # spring constant
+        c = Constant(1) # coefficient of friction
+        a = Parameter(0) # acceleration
+        x, x_dot = State(0) # distance
+        v, v_dot = State(0) # velocity
+
+    mechanics = Mechanics()
+
+    coupling = Connector(
+        x = set_value_from(mechanics.x),
+        F = get_value_for(mechanics.v_dot)
+    )
+
+    @EquationSpec(mechanics)
+    def eval(self, scope: Mechanics):
+        scope.a = -scope.k * scope.x - scope.c * scope.v
+        scope.v_dot = scope.a
+        scope.x_dot = scope.v
+
+
+class SpringCoupling(Module):
+
+    tag = "springcoup"
+
+    class Mechanics(ScopeSpec):
+        k = Parameter(1)
+        c = Parameter(1)
+        F1 = Parameter(0)
+        F2 = Parameter(0)
+        x1 = Parameter(0)
+        x2 = Parameter(0)
+
+    mechanics = Mechanics()
+
+    class Items(ItemsSpec):
+        side1: DampenedOscillator
+        side2: DampenedOscillator
+
+    side1 = Connector(
+        F = set_value_from(mechanics.F1),
+        x = get_value_for(mechanics.x1)
+    )
+
+    side2 = Connector(
+        F=set_value_from(mechanics.F2),
+        x=get_value_for(mechanics.x2)
+    )
+
+    items = Items()
+
+    def __init__(self, tag="springcoup", k=1.0):
+        super().__init__(tag)
+
+        self.mechanics.set_values(k=k)
+
+    @EquationSpec(mechanics)
+    def eval(self, scope: Mechanics):
+        scope.c = scope.k
+
+        dx = scope.x1 - scope.x2
+        F = np.abs(dx) * scope.c
+
+        scope.F1 = -F if scope.x1 > scope.x2 else F  # [kg/s]
+
+        scope.F2 = -scope.F1
+
+
+class OscillatorSystem(Module):
+
+    class Items(ItemsSpec):
+        # The oscillator system will have two oscillators interacting via the coupling
+        oscillator1: DampenedOscillator
+        oscillator2: DampenedOscillator
+        coupling: SpringCoupling
+
+    items = Items()
+
+    with create_connections() as connections:
+        # connect oscillators via the coupling
+        items.oscillator1.coupling >> items.coupling.side1
+        items.oscillator2.coupling >> items.coupling.side2
+
+
+    def __init__(self, k=0.01, c=0.001, x0=(1, 2),  tag=None):
+        super(OscillatorSystem, self).__init__(tag=tag)
+
+        # Initialized the modules in the oscillator system
+
+        self.items.oscillator1 = DampenedOscillator(tag='osc1')
+        self.items.oscillator1.mechanics.set_values(k=k, c=c, x=x0[0])
+
+        self.items.oscillator2 = DampenedOscillator(tag='osc2')
+        self.items.oscillator2.mechanics.set_values(k=k, c=c, x=x0[1])
+
+        self.items.coupling = SpringCoupling(k=k)
+
+
+if __name__ == "__main__":
+
+    from numerous.engine import simulation
+    from numerous.engine import model
+    from matplotlib import pyplot as plt
+
+    subsystem = OscillatorSystem(tag='system', k=0.01, c=0.001, x0=[1.0, 2.0])
+    # Define simulation
+    s = simulation.Simulation(model.Model(subsystem, use_llvm=False), t_start=0, t_stop=500.0, num=1000, num_inner=100,
+                              max_step=1)
+    # Solve and plot
+
+    s.solve()
+
+    s.model.historian_df[['system.osc1.mechanics.x', 'system.osc2.mechanics.x']].plot()
+    # print()
+    plt.show()
+    plt.interactive(False)