changes in readme and solidMaterial.jl

Author: AndreaNeumayr

README.md

@@ -10,7 +10,7 @@
 
 ## Modia Platform
 
-The *Modia platform* is a prototype system for next generation modeling and simulation of physical systems described by differential and algebraic equations. It consists currently of the following Julia packages that are all under development (not all are yet publicly available):
+The *Modia platform* is a prototype system for the next modeling and simulation generation of physical systems described by differential and algebraic equations. It consists currently of the following Julia packages that are all under development (not all are yet publicly available):
 
 - Modia - Equation based modeling
 - Modiator - 2D/3D web-app model editor
@@ -27,7 +27,7 @@ directly accessed and utilized in a model. Functions are provided, for example,
 mass, and inertia of a geometrical object or the distance between two objects.
 Furthermore, Modia3D models 3D mechanical systems and shall be expanded into other domains in the future
 (for example to utilize the 3D geometry to model heat flow in buildings or satellites).
-In the future it will be possible, for example, to model the 3D mechanical part of a robot with Modia3D and the electrical motors and gearboxes driving the joints with Modia.
+In the future it will be possible, for example, to model the 3D mechanical part of a robot with Modia3D and the electrical motors and gearboxes are driving the joints with Modia.
 
 Modia3D uses ideas from modern computer game engines to achieve a highly flexible setup of mechanical systems including collision handling. Other features are utilized from multi-body programs, such as support for closed kinematic loops, and elastic response calculation. The underlying mathematical formulation are hybrid Differential Algebraic Equations (DAEs) that are solved with the variable-step solver IDA via the [Sundials.jl](https://github.com/JuliaDiffEq/Sundials.jl) Julia package.
 

src/Solids/_module.jl

@@ -55,8 +55,6 @@ export solidMaterial, solidMaterialPalette, defaultContactMaterial
 export regularize, resultantCoefficientOfRestitution, resultantDampingCoefficient
 export solidMaterialPairsPalette, CommonCollisionProperties, getCommonCollisionProperties
 
-export SolidMaterial2, solidMaterialPalette2
-export SolidMaterial3, solidMaterialPalette3
 
 export contactPairMaterialPalette, ContactPairMaterial, TwoNamesKey
 

src/Solids/solidMaterial.jl

@@ -8,123 +8,11 @@
 #
 #    Material properties of solids
 
-"""
-    material1 = SolidMaterial(;kwargs...)
-    material2 = SolidMaterial(name)
-
-`SolidMaterial(;kwargs...)` generates a SolidMaterial object by providing the material properties of a solid with
-keyword arguments. Arguments that are not provided have value = NaN.
-
-`SolidMaterial(name)` returns a SolidMaterial object from dictionary Modia3D.solidMaterialPalette using
-the name as dictionary key.
-
-# Arguments
-- `name::AbstractString`: Name of the material (used as key in dictionary Modia3D.solidMaterialPalette)
-
-# Keyword Arguments
-- `density::Float64` in [kg/m^3]: Density, see [Wikipedia](https://en.wikipedia.org/wiki/Density).
-- 'YoungsModulus::Float64` in [Pa]: Youngs's modulus, see [Wikipedia](https://en.wikipedia.org/wiki/Young%27s_modulus).
-- `PoissonsRatio::Float64`: Poisson's ratio, see [Wikipedia](https://en.wikipedia.org/wiki/Poisson%27s_ratio).
-- `meltingPoint::Float64` in [K]: Melting point, see [Wikipedia](https://en.wikipedia.org/wiki/Melting_point).
-                                  If the material is destroyed before its melting point (e.g. wood that is burning)
-                                  then `meltingPoint` is the temperature when destruction of the solid starts.
-- `specificHeatCapacity::Float64` in [J/(kg.K)]: Specific heat capacity, see [Wikipedia](https://en.wikipedia.org/wiki/Heat_capacity).
-- `thermalConductivity::Float64` in [W/(m.K)]: Thermal conductivity, see [Wikipedia](https://en.wikipedia.org/wiki/Thermal_conductivity) and
-                                [List of thermal conductivities](https://en.wikipedia.org/wiki/List_of_thermal_conductivities)
-- `linearThermalExpansionCoefficient::Float64` in [1/K]: Linear thermal expansion coefficient, see [Wikipedia](https://en.wikipedia.org/wiki/Thermal_expansion).
-- `coefficientOfRestitution::Float64`: Coefficient of restitution, see [Wikipedia](https://en.wikipedia.org/wiki/Coefficient_of_restitution).
-- `slidingFrictionCoefficient::Float64`: Kinetic/sliding friction coefficient, see [Wikipedia](https://en.wikipedia.org/wiki/Friction)
-
-# Example
-```julia
-import Modia3D
-mat1 = Modia3D.SolidMaterial(density=3000.0, YoungsModulus=2e11)
-mat2 = Modia3D.SolidMaterial("Steel")    # mat2.density = 8000.0
-```
-"""
-struct SolidMaterial
-   density::Float64              # [kg/m^3]  , https://en.wikipedia.org/wiki/Density
-   YoungsModulus::Float64        # [Pa]      , https://en.wikipedia.org/wiki/Young%27s_modulus
-   PoissonsRatio::Float64        # []        , https://en.wikipedia.org/wiki/Poisson%27s_ratio
-   meltingPoint::Float64         # [K]       , https://en.wikipedia.org/wiki/Melting_point
-                                 # If the material is destroyed before its melting point (e.g. wood that is burning)
-                                 # then meltingPoint is the temperature when destruction starts.
-   heatCapacity::Float64         # [J/(kg.K)], https://en.wikipedia.org/wiki/Heat_capacity
-   thermalConductivity::Float64  # [W/(m.K)] , https://en.wikipedia.org/wiki/Thermal_conductivity
-                                 #             https://en.wikipedia.org/wiki/List_of_thermal_conductivities
-   linearThermalExpansionCoefficient::Float64  # [1/K], https://en.wikipedia.org/wiki/Thermal_expansion
-   coefficientOfRestitution::Float64     # [] https://en.wikipedia.org/wiki/Coefficient_of_restitution
-   slidingFrictionCoefficient::Float64   # [] https://en.wikipedia.org/wiki/Friction
-   rotationalFrictionCoefficient::Float64
-   SolidMaterial(density, YoungsModulus, PoissonsRatio, meltingPoint, heatCapacity,
-                 thermalConductivity, linearThermalExpansionCoefficient, coefficientOfRestitution, slidingFrictionCoefficient,
-                 rotationalFrictionCoefficient) = new(density, YoungsModulus, PoissonsRatio, meltingPoint, heatCapacity,thermalConductivity, linearThermalExpansionCoefficient, coefficientOfRestitution, slidingFrictionCoefficient,
-                 rotationalFrictionCoefficient)
-end
-SolidMaterial(;density=NaN, YoungsModulus=NaN, PoissonsRatio=NaN, meltingPoint=NaN,
-               heatCapacity=NaN, thermalConductivity=NaN, linearThermalExpansionCoefficient=NaN,
-               coefficientOfRestitution=NaN, slidingFrictionCoefficient=NaN,
-               rotationalFrictionCoefficient=NaN) =
-              SolidMaterial(density,YoungsModulus, PoissonsRatio, meltingPoint, heatCapacity,
-                            thermalConductivity, linearThermalExpansionCoefficient,
-                            coefficientOfRestitution, slidingFrictionCoefficient,
-                            rotationalFrictionCoefficient)
-
-
-#=
-const defaultFile     = joinpath(Modia3D.path, "src", "Solid", "solidMaterials.json")
-#const solidMaterialPalette = JSON.parsefile(defaultFile; dicttype=Dict{String, SolidMaterial})
-const solidMaterialPalette = JSON.parsefile(defaultFile)
-println("typeof(solidMaterialPalette) = ", typeof(solidMaterialPalette))
-
-
-solidMaterial(name::AbstractString) = solidMaterialPalette[name]
-println("solidMaterial(Aluminium) = ", solidMaterial("Aluminium"))
-
-const mat = Dict{String,SolidMaterial}()https://github.com/JuliaIO/JSON.jl/blob/master/data/jsonchecker/fail01.json
-mat["Aluminium1"] = SolidMaterial(1.0,2.0,3.0,4.0,5.0,6.0,7.0)
-mat["Aluminium2"] = SolidMaterial(2.0,2.0,3.0,4.0,5.0,6.0,7.0)
-import Base
-Base.open(joinpath(Modia3D.path, "src", "Solid", "solidMaterials2.json"), "w") do file
-  JSON.print(file, mat)
-end
-=#
-
-"""
-    const solidMaterialPalette
-
-Dictionary of solid material data, see [`Modia3D.SolidMaterial`](@ref)
-"""
-const solidMaterialPalette = Dict{String, SolidMaterial}()
-
-# Temporary solution
-solidMaterialPalette["Steel"]     = SolidMaterial(8000.0, 2.0e11, 0.30, 1640.0, 500.0, 50.0 , 1.2e-5 , 0.7, 0.5, 0.001)
-solidMaterialPalette["Aluminium"] = SolidMaterial(2700.0, 6.9e10, 0.32, 933.0,  897.0, 237.0, 2.31e-5, 0.1, 1.4, 0.001)
-solidMaterialPalette["DryWood"]   = SolidMaterial( 700.0, 1.1e10, 0.4 , 570.0, 1700.0,   0.1,  5.0e-6, 0.1, 0.3, 0.002)
-
-# http://dbkcues.ru/articles-2/collision-of-billiard-balls/?lang=en
-
-# E = 5,4 GPA
-# cor=0.8, mu_k = 0.1, mu_r = 0.025 # book [Physics for game developers, Bourg, Bywalce,  2013, p. 382]
-# attention: meltingPoint, heatCapacity,thermalConductivity, linearThermalExpansionCoefficient are not true!!!
-solidMaterialPalette["BilliardBall"]    = SolidMaterial(1768.0, 5.4e9, 0.34, NaN, NaN, NaN, NaN, NaN, NaN, NaN)
-solidMaterialPalette["BilliardCushion"] = SolidMaterial( 700.0, 1.1e10, 0.4, NaN, NaN, NaN, NaN, NaN, NaN, NaN)
-solidMaterialPalette["BilliardTable"]   = SolidMaterial( 700.0, 1.1e10, 0.4, NaN, NaN, NaN, NaN, NaN, NaN, NaN)
-
-solidMaterial(name::AbstractString) = solidMaterialPalette[name]   # Should be removed
-SolidMaterial(name::AbstractString) = solidMaterialPalette[name]
-
-
-
-
-
-
-
 
 """
-    material = SolidMaterial3(;kwargs...)
+    material = SolidMaterial(;kwargs...)
 
-Generates a SolidMaterial3 object by providing the material properties of a solid with
+Generates a SolidMaterial object by providing the material properties of a solid with
 keyword arguments. Arguments that are not provided have value = NaN.
 
 # Keyword Arguments
@@ -142,10 +30,10 @@ keyword arguments. Arguments that are not provided have value = NaN.
 # Example
 ```julia
 import Modia3D
-mat1 = Modia3D.SolidMaterial3(density=3000.0, YoungsModulus=2e11)
+mat1 = Modia3D.SolidMaterial(density=3000.0, YoungsModulus=2e11)
 ```
 """
-mutable struct SolidMaterial3
+mutable struct SolidMaterial
    density::Float64                            # [kg/m^3]  , https://en.wikipedia.org/wiki/Density
    YoungsModulus::Float64                      # [Pa]      , https://en.wikipedia.org/wiki/Young%27s_modulus
    PoissonsRatio::Float64                      # []        , https://en.wikipedia.org/wiki/Poisson%27s_ratio
@@ -157,32 +45,32 @@ mutable struct SolidMaterial3
                                                #             https://en.wikipedia.org/wiki/List_of_thermal_conductivities
    linearThermalExpansionCoefficient::Float64  # [1/K], https://en.wikipedia.org/wiki/Thermal_expansion
 end
-SolidMaterial3(; density=NaN,
+SolidMaterial(; density=NaN,
                  YoungsModulus=NaN,
                  PoissonsRatio=NaN,
                  meltingPoint=NaN,
                  specificHeatCapacity=NaN,
                  thermalConductivity=NaN,
                  linearThermalExpansionCoefficient=NaN) =
-              SolidMaterial3(density, YoungsModulus, PoissonsRatio, meltingPoint, specificHeatCapacity,
+              SolidMaterial(density, YoungsModulus, PoissonsRatio, meltingPoint, specificHeatCapacity,
                              thermalConductivity, linearThermalExpansionCoefficient)
 
 
 #readSolidMaterialsDict() = Modia3D.readDictOfStructsFromJSON( joinpath(Modia3D.path, "src", "Solids", "solidMaterials.json"),
-#                                                              SolidMaterial3 )
+#                                                              SolidMaterial )
 
 """
-    readSolidMaterial3FromJSON(fileName)
+    readSolidMaterialFromJSON(fileName)
 
-Read a JSON file consisting of a dictionary of SolidMaterial3 instances from `fileName` and
-return a `Dict{String, SolidMaterial3}` dictionary.
+Read a JSON file consisting of a dictionary of SolidMaterial instances from `fileName` and
+return a `Dict{String, SolidMaterial}` dictionary.
 """
-readSolidMaterial3FromJSON(fileName::AbstractString) = Basics.readDictOfStructsFromJSON(fileName, SolidMaterial3)
+readSolidMaterialFromJSON(fileName::AbstractString) = Basics.readDictOfStructsFromJSON(fileName, SolidMaterial)
 
 
 """
-    const solidMaterialPalette3
+    const solidMaterialPalette
 
-Dictionary of solid material data, see [`Modia3D.SolidMaterial3`](@ref)
+Dictionary of solid material data, see [`Modia3D.SolidMaterial`](@ref)
 """
-const solidMaterialPalette3 = readSolidMaterial3FromJSON( joinpath(Modia3D.path, "palettes", "solidMaterials.json") )
+const solidMaterialPalette = readSolidMaterialFromJSON( joinpath(Modia3D.path, "palettes", "solidMaterials.json") )