doc improvements (#215)

* merged doc improvements

* moved fmi2-md related docs to different file

* moved fmi3-md related docs to different file

docs/make.jl

@@ -12,7 +12,8 @@ makedocs(sitename="FMI.jl",
             collapselevel = 1,
             sidebar_sitename = false,
             edit_link = nothing,
-            size_threshold_ignore = ["library.md","deprecated.md","fmi2_lowlevel_librarys.md","fmi3_lowlevel_librarys.md"]
+            size_threshold = 512000,
+            size_threshold_ignore = ["deprecated.md"]
          ),
          modules = [FMI, FMIImport, FMICore],
          checkdocs=:exports,
@@ -39,8 +40,27 @@ makedocs(sitename="FMI.jl",
                     "fmi_lowlevel_library_constants.md",
                     "fmi_lowlevel_library_functions.md"
                 ],
-                "FMI2 specific content" => "fmi2_lowlevel_librarys.md",
-                "FMI3 specific content" => "fmi3_lowlevel_librarys.md"
+                "FMI2 specific content" =>  Any[
+                    "fmi2_lowlevel_library_types.md",
+                    "fmi2_lowlevel_library_constants.md",
+                    "FMI2 Functions in FMI Import/Core .jl" =>  Any[
+                        "fmi2_lowlevel_modeldescription_functions.md",
+                        "fmi2_lowlevel_library_functions.md",
+                        "fmi2_lowlevel_ME_functions.md",
+                        "fmi2_lowlevel_CS_functions.md",
+                    ]
+                ],
+                "FMI3 specific content" =>  Any[
+                    "fmi3_lowlevel_library_types.md",
+                    "fmi3_lowlevel_library_constants.md",
+                    "FMI3 Functions in FMI Import/Core .jl" =>  Any[
+                        "fmi3_lowlevel_modeldescription_functions.md",
+                        "fmi3_lowlevel_library_functions.md",
+                        "fmi3_lowlevel_ME_functions.md",
+                        "fmi3_lowlevel_CS_functions.md",
+                        "fmi3_lowlevel_SE_functions.md",
+                    ]
+                ],
             ]
             "API Index" => "index_library.md"
             "FMI Tool Information" => "fmi-tool-info.md"            

docs/src/fmi2_lowlevel_CS_functions.md

@@ -0,0 +1,34 @@
+# FMI for Co-Simulation
+This chapter defines the Functional Mock-up Interface (FMI) for the coupling of two or more simulation
+models in a Co-Simulation environment (FMI for Co-Simulation). Co-Simulation is a rather general
+approach to the simulation of coupled technical systems and coupled physical phenomena in
+engineering with focus on instationary (time-dependent) problems.
+
+
+## Transfer of Input / Output Values and Parameters
+In order to enable the slave to interpolate the continuous real inputs between communication steps, the
+derivatives of the inputs with respect to time can be provided. Also, higher derivatives can be set to allow
+higher order interpolation.
+
+```@docs
+fmi2GetRealOutputDerivatives
+```
+
+## Computation
+The computation of time steps is controlled by the following function.
+
+```@docs
+fmi2DoStep
+fmi2CancelStep
+```
+
+## Retrieving Status Information from the Slave
+Status information is retrieved from the slave by the following functions:
+
+```@docs
+fmi2GetStatus!
+fmi2GetRealStatus!
+fmi2GetIntegerStatus!
+fmi2GetBooleanStatus!
+fmi2GetStringStatus!
+```

docs/src/fmi2_lowlevel_ME_functions.md

@@ -0,0 +1,30 @@
+# FMI for Model Exchange
+This chapter contains the interface description to access the equations of a dynamic system from a C
+program.
+
+##  Providing Independent Variables and Re-initialization of Caching
+Depending on the situation, different variables need to be computed. In order to be efficient, it is important that the interface requires only the computation of variables that are needed in the present context. The state derivatives shall be reused from the previous call. This feature is called “caching of variables” in the sequel. Caching requires that the model evaluation can detect when the input arguments, like time or states, have changed.
+
+```@docs
+fmi2SetTime
+fmi2SetContinuousStates
+```
+
+## Evaluation of Model Equations
+
+```@docs
+fmi2EnterEventMode
+fmi2NewDiscreteStates
+fmi2NewDiscreteStates!
+fmi2EnterContinuousTimeMode
+fmi2CompletedIntegratorStep
+fmi2CompletedIntegratorStep!
+fmi2GetDerivatives
+fmi2GetDerivatives!
+fmi2GetEventIndicators
+fmi2GetEventIndicators!
+fmi2GetContinuousStates
+fmi2GetContinuousStates!
+fmi2GetNominalsOfContinuousStates
+fmi2GetNominalsOfContinuousStates!
+```

docs/src/fmi2_lowlevel_library_constants.md

@@ -0,0 +1,12 @@
+# FMI2 Constants in FMI Import/Core .jl 
+
+```@docs
+fmi2True
+fmi2False
+fmi2StatusOK
+fmi2StatusWarning
+fmi2StatusPending
+fmi2StatusError
+fmi2StatusDiscard
+fmi2StatusFatal
+```

docs/src/fmi2_lowlevel_library_functions.md

@@ -0,0 +1,126 @@
+# FMI Common Concepts for Model Exchange and Co-Simulation
+In both cases, FMI defines an input/output block of a dynamic model where the distribution of the block, the
+platform dependent header file, several access functions, as well as the schema files are identical.
+
+## Opening and closing FMUs
+
+```@docs
+fmi2Unzip
+fmi2Load
+fmi2Reload
+fmi2Unload
+```
+
+##  Creation, Destruction and Logging of FMU Instances
+
+```@docs
+fmi2Instantiate!
+fmi2Instantiate
+fmi2FreeInstance!
+fmi2SetDebugLogging
+```
+
+## Initialization, Termination, and Resetting an FMU
+
+```@docs
+fmi2SetupExperiment
+fmi2EnterInitializationMode
+fmi2ExitInitializationMode
+fmi2Terminate
+fmi2Reset
+```
+
+## Getting and Setting Variable Values
+All variable values of an FMU are identified with a variable handle called “value reference”. The handle is
+defined in the modelDescription.xml file (as attribute “valueReference” in element
+“ScalarVariable”). Element “valueReference” might not be unique for all variables. If two or more
+variables of the same base data type (such as fmi2Real) have the same valueReference, then they
+have identical values but other parts of the variable definition might be different (for example, min/max
+attributes).
+
+```@docs
+fmi2Get
+fmi2Get!
+fmi2Set
+fmi2GetReal
+fmi2GetReal!
+fmi2GetInteger
+fmi2GetInteger!
+fmi2GetBoolean
+fmi2GetBoolean!
+fmi2GetString
+fmi2GetString!
+fmi2SetReal
+fmi2SetInteger
+fmi2SetBoolean
+fmi2SetString
+```
+
+## Getting and Setting the Complete FMU State
+The FMU has an internal state consisting of all values that are needed to continue a simulation. This internal state consists especially of the values of the continuous-time states, iteration variables, parameter values, input values, delay buffers, file identifiers, and FMU internal status information. With the functions of this section, the internal FMU state can be copied and the pointer to this copy is returned to the environment. The FMU state copy can be set as actual FMU state, in order to continue the simulation from it.
+
+```@docs
+fmi2GetFMUstate
+fmi2GetFMUstate!
+fmi2SetFMUstate
+fmi2FreeFMUstate!
+fmi2SerializedFMUstateSize
+fmi2SerializedFMUstateSize!
+fmi2SerializeFMUstate
+fmi2SerializeFMUstate!
+fmi2DeSerializeFMUstate
+fmi2DeSerializeFMUstate!
+```
+
+## Getting Partial Dervatives
+It is optionally possible to provide evaluation of partial derivatives for an FMU. For Model Exchange, this
+means computing the partial derivatives at a particular time instant. For Co-Simulation, this means to
+compute the partial derivatives at a particular communication point. One function is provided to compute
+directional derivatives. This function can be used to construct the desired partial derivative matrices.
+
+```@docs
+fmi2GetDirectionalDerivative
+fmi2GetDirectionalDerivative!
+fmi2SetRealInputDerivatives
+fmi2GetRealOutputDerivatives!
+fmi2SampleJacobian
+fmi2SampleJacobian!
+```
+
+## Conversion functions
+
+```@docs
+fmi2StringToValueReference
+fmi2ValueReferenceToString
+fmi2StringToCausality
+fmi2CausalityToString
+fmi2StringToVariability
+fmi2VariabilityToString
+
+fmi2StatusToString
+fmi2StringToDependencyKind
+fmi2DependencyKindToString
+fmi2StringToInitial
+fmi2InitialToString
+```
+
+## External/Additional functions
+
+```@docs
+fmi2GetSolutionDerivative
+fmi2GetSolutionState
+fmi2GetSolutionValue
+fmi2GetSolutionTime
+fmi2ModelVariablesForValueReference
+getCurrentComponent
+hasCurrentComponent
+fmi2GetJacobian
+fmi2GetJacobian!
+fmi2GetFullJacobian
+fmi2GetFullJacobian!
+fmi2GetStartValue
+fmi2GetUnit
+fmi2GetDeclaredType
+fmi2GetInitial
+fmi2GetSimpleTypeAttributeStruct
+```

docs/src/fmi2_lowlevel_library_types.md

@@ -0,0 +1,30 @@
+# FMI2 Types in FMI Import/Core .jl 
+
+```@docs
+FMU2
+FMU2Component
+FMU2ComponentEnvironment
+FMU2InputFunction
+fmi2Struct
+fmi2StructMD
+fmi2Initial
+FMU2Solution
+fmi2ScalarVariable
+fmi2SimpleType
+fmi2Type
+fmi2Unit
+fmi2Char
+FMIImport.fmi2ValueReferenceFormat
+fmi2Variability
+fmi2VariableDependency
+fmi2DependencyKind
+fmi2EventInfo
+FMU2Event
+FMU2ExecutionConfiguration
+fmi2Status
+fmi2Annotation
+fmi2ModelDescription
+fmi2FMUstate
+fmi2StatusKind
+fmi2Causality
+```