refactor: set use_support to false

Author: ven-k

docs/src/tutorials/dc_motor_pi.md

@@ -27,7 +27,7 @@ L = 4.5e-3 # [H] armature inductance
 k = 0.5 # [N.m/A] motor constant
 J = 0.02 # [kg.m²] inertia
 f = 0.01 # [N.m.s/rad] friction factor
-tau_L_step = -0.3 # [N.m] amplitude of the load torque step 
+tau_L_step = -0.3 # [N.m] amplitude of the load torque step
 nothing # hide
 ```
 
@@ -43,7 +43,7 @@ The actual model can now be composed.
 @named L1 = Inductor(L = L)
 @named emf = EMF(k = k)
 @named fixed = Fixed()
-@named load = Torque(use_support = false)
+@named load = Torque()
 @named load_step = Blocks.Step(height = tau_L_step, start_time = 3)
 @named inertia = Inertia(J = J)
 @named friction = Damper(d = f)

src/Mechanical/Rotational/components.jl

@@ -197,11 +197,11 @@ This element characterizes any type of gear box which is fixed in the ground and
 # Parameters:
 
   - `ratio`: Transmission ratio (flange_a.phi/flange_b.phi)
-  - `use_support`: If support flange enabled, otherwise implicitly grounded
+  - `use_support`: If support flange enabled, otherwise implicitly grounded. By default it is `false`
 """
 @mtkmodel IdealGear begin
     @extend phi_support, flange_a, flange_b = partial_element = PartialElementaryTwoFlangesAndSupport2(;
-        use_support)
+        use_support = false)
     @parameters begin
         ratio, [description = "Transmission ratio"]
     end

src/Mechanical/Rotational/sources.jl

@@ -1,6 +1,6 @@
 @mtkmodel PartialTorque begin
     @extend flange, phi_support = partial_element = PartialElementaryOneFlangeAndSupport2(;
-        use_support)
+        use_support = false)
     @variables begin
         phi(t),
         [
@@ -13,7 +13,7 @@
 end
 
 """
-    Torque(; name, use_support)
+    Torque(; name, use_support = false)
 
 Input signal acting as external torque on a flange
 
@@ -32,7 +32,7 @@ Input signal acting as external torque on a flange
 """
 @mtkmodel Torque begin
     @extend (flange,) = partial_element = PartialElementaryOneFlangeAndSupport2(;
-        use_support)
+        use_support = false)
     @components begin
         tau = RealInput()
     end
@@ -42,7 +42,7 @@ Input signal acting as external torque on a flange
 end
 
 """
-    ConstantTorque(; name, tau_constant, use_support)
+    ConstantTorque(; name, tau_constant, use_support = false)
 
 Constant torque source
 
@@ -57,7 +57,7 @@ Constant torque source
 
 # Arguments:
 - `tau_constant`: The constant torque applied by the source
-- `use_support`: Whether or not an internal support flange is added.
+- `use_support`: Whether or not an internal support flange is added. By default, it is `false`
 """
 @mtkmodel ConstantTorque begin
     @parameters begin
@@ -66,7 +66,7 @@ Constant torque source
             description = "Constant torque (if negative, torque is acting as load in positive direction of rotation)",
         ]
     end
-    @extend flange, phi = partial_element = PartialTorque(; use_support)
+    @extend flange, phi = partial_element = PartialTorque(; use_support = false)
     @variables begin
         tau(t), [description = "Accelerating torque acting at flange (= -flange.tau)"]
         w(t),
@@ -80,7 +80,7 @@ Constant torque source
 end
 
 """
-    Speed(; name, use_support, exact = false, f_crit = 50)
+    Speed(; name, use_support = false, exact = false, f_crit = 50)
 
 Forced movement of a flange according to a reference angular velocity signal
 

src/Mechanical/TranslationalModelica/sources.jl

@@ -1,11 +1,11 @@
 """
-    Force(;name)
+    Force(; name, use_support = false)
 
 Input signal acting as external force on a flange
 """
 @mtkmodel Force begin
     @extend (flange,) = partial_element = PartialElementaryOneFlangeAndSupport2(;
-        use_support)
+        use_support = false)
     @components begin
         f = RealInput() # Accelerating force acting at flange (= -flange.tau)
     end

src/Mechanical/TranslationalPosition/sources.jl

@@ -1,11 +1,11 @@
 """
-    Force(; name)
+    Force(; name, use_support = false)
 
 Input signal acting as external force on a flange
 """
 @mtkmodel Force begin
     @extend (flange,) = partial_element = PartialElementaryOneFlangeAndSupport2(;
-        use_support)
+        use_support = false)
     @components begin
         f = RealInput() # Accelerating force acting at flange (= -flange.tau)
     end

src/Mechanical/TranslationalPosition/utils.jl

@@ -120,13 +120,13 @@ Partial model for a component with one translational 1-dim. shaft flange and a s
 end
 
 """
-    PartialElementaryTwoFlangesAndSupport2(;name, use_support=false)
+    PartialElementaryTwoFlangesAndSupport2(; name, use_support = false)
 
 Partial model for a component with two translational 1-dim. flanges and a support used for textual modeling, i.e., for elementary models
 
 # Parameters:
 
-  - `use_support`: If support flange enabled, otherwise implicitly grounded
+  - `use_support`: If support flange enabled, otherwise implicitly grounded. By default it is `false`
 
 # States:
 

test/Blocks/test_analysis_points.jl

@@ -159,7 +159,7 @@ c = 10   # Damping coefficient
 @named inertia2 = Inertia(; J = m2)
 @named spring = Spring(; c = k)
 @named damper = Damper(; d = c)
-@named torque = Torque(; use_support = false)
+@named torque = Torque()
 
 function SystemModel(u = nothing; name = :model)
     eqs = [connect(torque.flange, inertia1.flange_a)

test/Mechanical/rotational.jl

@@ -62,7 +62,7 @@ end
     J_motor = 0.1 # Motor inertia
 
     @named fixed = Fixed()
-    @named torque = Torque(use_support = true)
+    @named torque = Torque()
     @named inertia1 = Inertia(J = 2, phi = pi / 2)
     @named spring = Rotational.Spring(c = 1e4)
     @named damper = Damper(d = 10)
@@ -192,7 +192,7 @@ end
     @named friction = RotationalFriction(f = 0.001, tau_c = 20, w_brk = 0.06035,
         tau_brk = 25)
     @named vel_profile = VelocityProfile()
-    @named source = Speed(use_support = false)
+    @named source = Speed()
     @named angle_sensor = AngleSensor()
 
     connections = [connect(vel_profile.output, source.w_ref)

test/Mechanical/translational.jl

@@ -83,7 +83,7 @@ end
     @named gp = TP.Fixed(s_0 = 1)
 
     @named fv = TV.Force()
-    @named fp = TP.Force(use_support = false)
+    @named fp = TP.Force()
 
     @named source = Sine(frequency = 3, amplitude = 2)
 

test/Mechanical/translational_modelica.jl

@@ -33,7 +33,7 @@ end
     @named spring = TP.Spring(; c = 1, s_rel0 = 1)
     @named mass = TP.Mass(; m = 1, v = 1)
     @named fixed = TP.Fixed(; s0 = 1)
-    @named force = TP.Force(use_support = false)
+    @named force = TP.Force()
     @named source = Sine(frequency = 3, amplitude = 2)
 
     eqs = [connect(force.f, source.output)