Merge pull request #49 from ModiaSim/gh_ForceElementDocu

Add force element documentation

Author: AndreaNeumayr

docs/make.jl

@@ -20,6 +20,7 @@ makedocs(
         "Components/Joints.md"
         "Components/Materials.md"
         "Components/GravityField.md"
+        "Components/ForceElements.md"
      ],
      "Internal" => [
         "internal/Profiling.md"

docs/src/Components/ForceElements.md

@@ -0,0 +1,18 @@
+# Force Elements
+
+```@meta
+CurrentModule = Modia3D.Composition
+```
+
+## Bushing
+
+```@docs
+Bushing
+```
+
+
+## SpringDamperPtP
+
+```@docs
+SpringDamperPtP
+```

src/Composition/ForceElements/Bushing.jl

@@ -5,7 +5,7 @@ force = Bushing(; obj1, obj2, stiffness, damping)
 Return a `force` acting as bushing between `obj1::`[`Object3D`](@ref) and
 `obj2::`[`Object3D`](@ref). Vectors `stiffness` and `damping` define the
 stiffness resp. damping values in x, y and z direction of `obj1`. The
-orientation of `obj2` does no influence the resulting forces.
+orientation of `obj2` does not influence the resulting forces.
 """
 mutable struct Bushing <: Modia3D.AbstractForceElement
 

src/Composition/frameMeasurements.jl

@@ -196,10 +196,10 @@ function measFrameDistAcceleration(frameMeas::Object3D; frameOrig::Union{Object3
     (d_OrigMeas, n_OrigMeas) = measFrameDistance(frameMeas; frameOrig=frameOrig)
     v_OrigMeas = measFrameTransVelocity(frameMeas; frameOrig=frameOrig)
     a_OrigMeas = measFrameTransAcceleration(frameMeas; frameOrig=frameOrig)
-    dd_OrigMeas = n_OrigMeas * v_OrigMeas
-    ddd_OrigMeas =  n_OrigMeas * a_OrigMeas
+    dd_OrigMeas = dot(n_OrigMeas, v_OrigMeas)
+    ddd_OrigMeas = dot(n_OrigMeas, a_OrigMeas)
     if d_OrigMeas > 1.0e-32
-        ddd_OrigMeas += (v_OrigMeas*v_OrigMeas - dd_OrigMeas*dd_OrigMeas) / d_OrigMeas
+        ddd_OrigMeas += (dot(v_OrigMeas, v_OrigMeas) - dd_OrigMeas*dd_OrigMeas) / d_OrigMeas
     end
     return ddd_OrigMeas
 end

src/Composition/scene.jl

@@ -377,7 +377,7 @@ Defines global properties of the system, such as the gravity field. Exactly one
 """
 mutable struct Scene <: Modia3D.AbstractScene
     name::String                              # model name
-    autoCoordsys::Shapes.CoordinateSystem   # Coordinate system that is automatically included (e.g. due to visualizeFrames=true)
+    autoCoordsys::Shapes.CoordinateSystem     # Coordinate system that is automatically included (e.g. due to visualizeFrames=true)
     stack::Vector{Object3D}                   # Stack to traverse objs
     buffer::Vector{Object3D}                  # stores all roots of a super obj
 
@@ -391,7 +391,7 @@ mutable struct Scene <: Modia3D.AbstractScene
     initSuperObj::Bool                        # = true, if super objects are initialized
     initMassComp::Bool                        # = true, if mass computation for optimized structure is initialized
     analysis::Modia3D.AnalysisType            # Type of analysis
-    superObjs::Vector{SuperObjsRow}          # super objects
+    superObjs::Vector{SuperObjsRow}           # super objects
 
     treeAccVelo::Vector{Object3D}
     tree::Vector{Object3D}                    # Spanning tree of the frames in depth-first order (without world)