refactor: cut down the description of variables

- or the formatter turns them into a function

Author: ven-k

src/Mechanical/MultiBody2D/components.jl

@@ -60,17 +60,17 @@
         D(y_cm) ~ dy_cm
         D(dy_cm) ~ ddy_cm
 
-    # x forces
+        # x forces
         m * ddx_cm ~ fx1 + fx2
 
-    # y forces
+        # y forces
         m * ddy_cm ~ m * g + fy1 + fy2
 
-    # torques
+        # torques
         I * ddA ~ -fy1 * (x2 - x1) / 2 + fy2 * (x2 - x1) / 2 + fx1 * (y2 - y1) / 2 -
                   fx2 * (y2 - y1) / 2
 
-    # geometry
+        # geometry
         x2 ~ l * cos(A) + x1
         y2 ~ l * sin(A) + y1
         x_cm ~ l * cos(A) / 2 + x1
@@ -84,5 +84,4 @@
         TY2.f ~ fy2
         TY2.v ~ dy2
     end
-
 end

src/Mechanical/Translational/components.jl

@@ -159,7 +159,7 @@ const ABS = Val(:absolute)
         f ~ k * (sa - sb - l) #delta_s
         flange_a.f ~ +f
         flange_b.f ~ -f]
-    return compose(ODESystem(eqs, t, vars, pars; name = name,),
+    return compose(ODESystem(eqs, t, vars, pars; name = name),
         flange_a,
         flange_b) #, flange_a.f => k * (flange_a__s - flange_b__s - l)
 end
@@ -199,9 +199,3 @@ Linear 1D translational damper
         flange_b.f ~ -f
     end
 end
-
-
-#=
-
-
-=#

src/Mechanical/Translational/sensors.jl

@@ -48,5 +48,4 @@ Linear 1D position input sensor.
         output.u ~ s
         flange.f ~ 0.0
     end
-
 end

src/Mechanical/Translational/sources.jl

@@ -42,7 +42,8 @@ Linear 1D position input source
 
     !solves_force && push!(eqs, 0 ~ flange.f)
 
-    ODESystem(eqs, t, vars, []; name, systems, defaults = [flange.v => 0, s.u => s__u_start])
+    ODESystem(eqs, t, vars, [];
+        name, systems, defaults = [flange.v => 0, s.u => s__u_start])
 end
 
 @component function Velocity(; solves_force = true, name)
@@ -74,4 +75,4 @@ end
     !solves_force && push!(eqs, 0 ~ flange.f)
 
     ODESystem(eqs, t, vars, []; name, systems, defaults = [flange.v => 0])
-end
+end

src/Mechanical/TranslationalModelica/components.jl

@@ -13,15 +13,15 @@ Flange fixed in housing at a given position.
 """
 @mtkmodel Fixed begin
     @parameters begin
-      s0
+        s0
     end
 
     @components begin
-      flange = Flange(; s = 0.0)
+        flange = Flange(; s = 0.0)
     end
 
     @equations begin
-      flange.s ~ s0
+        flange.s ~ s0
     end
 end
 
@@ -45,12 +45,12 @@ Sliding mass with inertia
 """
 @mtkmodel Mass begin
     @parameters begin
-      m = 0.0, [description = "Mass of sliding mass [kg]"]
+        m = 0.0, [description = "Mass of sliding mass [kg]"]
     end
     @variables begin
-      s
-      v(t) = 0.0, [description = "Absolute linear velocity of sliding mass [m/s]"]
-      a(t) = 0.0, [description = "Absolute linear acceleration of sliding mass [m/s^2]"]
+        s
+        v(t) = 0.0, [description = "Absolute linear velocity of sliding mass [m/s]"]
+        a(t) = 0.0, [description = "Absolute linear acceleration of sliding mass [m/s^2]"]
     end
     @extend flange_a, flange_b, s = pr = PartialRigid(; L = 0.0, s = s)
     @equations begin
@@ -78,12 +78,12 @@ Linear 1D translational spring
 @mtkmodel Spring begin
     @extend flange_a, flange_b, s_rel, f = pc = PartialCompliant()
     @parameters begin
-      c = 0.0, [description = "Spring constant [N/m]"]
-      s_rel0 = 0.0, [description = "Unstretched spring length [m]"]
+        c = 0.0, [description = "Spring constant [N/m]"]
+        s_rel0 = 0.0, [description = "Unstretched spring length [m]"]
     end
 
     @equations begin
-      f ~ c * (s_rel - s_rel0)
+        f ~ c * (s_rel - s_rel0)
     end
 end
 
@@ -104,13 +104,13 @@ Linear 1D translational damper
 @mtkmodel Damper begin
     @extend flange_a, flange_b, v_rel, f = pc = PartialCompliantWithRelativeStates()
     @parameters begin
-      d = 0.0, [description = "Damping constant [Ns/m]"]
+        d = 0.0, [description = "Damping constant [Ns/m]"]
     end
     @variables begin
-      lossPower(t) = 0.0, [description = "Power dissipated by the damper [W]"]
+        lossPower(t) = 0.0, [description = "Power dissipated by the damper [W]"]
     end
     @equations begin
-      f ~ d * v_rel
-      lossPower ~ f * v_rel
+        f ~ d * v_rel
+        lossPower ~ f * v_rel
     end
 end

src/Mechanical/TranslationalModelica/utils.jl

@@ -46,8 +46,8 @@ Partial model for the compliant connection of two translational 1-dim. flanges.
 @mtkmodel PartialCompliant begin
     @extend (flange_a, flange_b) = pt = PartialTwoFlanges()
     @variables begin
-        s_rel(t) = 0.0, [description = "Relative distance between flanges flange_b.s - flange_a.s"]
-        f(t) = 0.0, [description = "Force between flanges (positive in direction of flange axis R)"]
+        s_rel(t) = 0.0, [description = "Relative distance between flanges"]
+        f(t) = 0.0, [description = "Force between flanges"]
     end
 
     @equations begin
@@ -71,9 +71,9 @@ Partial model for the compliant connection of two translational 1-dim. flanges.
 @mtkmodel PartialCompliantWithRelativeStates begin
     @extend flange_a, flange_b = pt = PartialTwoFlanges()
     @variables begin
-        s_rel(t) = 0.0, [description = "Relative distance between flanges flange_b.s - flange_a.s"]
-        v_rel(t) = 0.0, [description = "Relative linear velocity (= D(s_rel))"]
-        f(t) = 0.0, [description = "Forces between flanges (= flange_b.f)"]
+        s_rel(t) = 0.0, [description = "Relative distance between flanges"]
+        v_rel(t) = 0.0, [description = "Relative linear velocity))"]
+        f(t) = 0.0, [description = "Forces between flanges"]
     end
 
     @equations begin
@@ -149,10 +149,10 @@ end
 @mtkmodel PartialRigid begin
     @extend flange_a, flange_b = ptf = PartialTwoFlanges()
     @variables begin
-        s(t) = 0.0, [description = "Absolute position of center of component (s = flange_a.s + L/2 = flange_b.s - L/2)"]
+        s(t) = 0.0, [description = "Absolute position of center of component"]
     end
     @parameters begin
-        L = 0.0, [description = "Length of component, from left flange to right flange (= flange_b.s - flange_a.s)"]
+        L = 0.0, [description = "Length of component, from left flange to right flange"]
     end
     @equations begin
         flange_a.s ~ s - L / 2

src/Mechanical/TranslationalPosition/components.jl

@@ -114,9 +114,13 @@ Linear 1D translational spring
   - `flange_a: 1-dim. translational flange on one side of spring`
   - `flange_b: 1-dim. translational flange on opposite side of spring` #default function
 """
-Spring(; name, k, flange_a__s = 0, flange_b__s = 0, l = 0) = Spring(ABS; name, k, flange_a__s, flange_b__s, l) #default function
+function Spring(; name, k, flange_a__s = 0, flange_b__s = 0, l = 0)
+    Spring(ABS; name, k, flange_a__s, flange_b__s, l)
+end #default function
 
-@component function Spring(::Val{:absolute}; name, k, flange_a__s = 0, flange_b__s = 0, l = 0)
+@component function Spring(::Val{:absolute};
+    name, k, flange_a__s = 0,
+    flange_b__s = 0, l = 0)
     pars = @parameters begin
         k = k
         l = l

src/Mechanical/TranslationalPosition/utils.jl

@@ -76,7 +76,7 @@ Partial model for the compliant connection of two translational 1-dim. flanges.
   - `f`: [N] Force between flanges (= flange_b.f)
 """
 @mtkmodel PartialCompliantWithRelativeStates begin
-   @components begin
+    @components begin
         flange_a = Flange()
         flange_b = Flange()
     end