- added doc files

Author: janbender

doc/bibliography.bib

@@ -364,4 +364,24 @@ @article{Weiler2018
   journal = {Computer Graphics Forum (Eurographics)},
   volume  = {37},
   number  = {2}
+}
+
+@InProceedings{Becker:2009,
+  author    = {Becker, Markus and Ihmsen, Markus and Teschner, Matthias},
+  title     = {{Corotated SPH for deformable solids}},
+  booktitle = {Proceedings of Eurographics Conference on Natural Phenomena},
+  year      = {2009},
+  pages     = {27--34},
+  doi       = {10.2312EG/DL/conf/EG2009/nph/027-034},
+  url       = {http://dx.doi.org/10.2312EG/DL/conf/EG2009/nph/027-034},
+}
+
+@Article{PGBT17,
+  author   = {Peer, Andreas and Gissler, Christoph and Band, Stefan and Teschner, Matthias},
+  title    = {An Implicit SPH Formulation for Incompressible Linearly Elastic Solids},
+  journal  = {Computer Graphics Forum},
+  year     = {2017},
+  issn     = {1467-8659},
+  doi      = {10.1111/cgf.13317},
+  url      = {http://dx.doi.org/10.1111/cgf.13317},
 }

doc/file_format.md

@@ -47,13 +47,6 @@ Example code:
 ##### Visualization:
 
 * numberOfStepsPerRenderUpdate (int): Number of simulation steps per rendered frame
-* colorField (int): Choose vector or scalar field for particle coloring.
-* colorMapType (int): Selection of a color map for coloring the scalar/vector field.
-  - 0: None
-  - 1: Jet
-  - 2: Plasma
-* renderMinValue (float): Minimal value used for color-coding the color field in the rendering process.
-* renderMaxValue (float): Maximal value used for color-coding the color field in the rendering process.
 * renderWalls (int): 
   - 0: None
   - 1: Particles (all)
@@ -65,6 +58,7 @@ Example code:
 
 * enablePartioExport (bool): Enable/disable partio export.
 * partioFPS (int): Frame rate of partio export.
+* partioAttributes (string): A list of attribute names separated by ";" that should be exported in the partio files (e.g. "velocity;density"). Default value: "velocity"
 
 ##### Simulation:
 
@@ -259,6 +253,10 @@ Example code:
 "Fluid":
 {
     "density0": 1000, 
+    "colorField": "velocity",
+	"colorMapType": 1,
+	"renderMinValue": 0.0,
+	"renderMaxValue": 5.0,
     "surfaceTension": 0.2,
     "surfaceTensionMethod": 0,		
     "viscosity": 0.01,
@@ -268,14 +266,24 @@ Example code:
     "viscosityOmega": 0.05,
     "inertiaInverse": 0.5,
     "maxEmitterParticles": 1000,
-	"emitterReuseParticles": false,
-	"emitterBoxMin": [-4.0,-1.0,-4.0],
-	"emitterBoxMax": [0.0,4,4.0]
+    "emitterReuseParticles": false,
+    "emitterBoxMin": [-4.0,-1.0,-4.0],
+    "emitterBoxMax": [0.0,4,4.0],
 }
 ```
 
 * density0 (float): Rest density of the corresponding fluid.
 
+##### Particle Coloring 
+
+* colorField (string): Choose vector or scalar field for particle coloring.
+* colorMapType (int): Selection of a color map for coloring the scalar/vector field.
+  - 0: None
+  - 1: Jet
+  - 2: Plasma
+* renderMinValue (float): Minimal value used for color-coding the color field in the rendering process.
+* renderMaxValue (float): Maximal value used for color-coding the color field in the rendering process.
+
 ##### Viscosity
 
 * viscosityMethod (int): Viscosity method
@@ -320,4 +328,11 @@ Example code:
   - 1: Becker & Teschner 2007
   - 2: Akinci et al. 2013
   - 3: He et al. 2014
-* surfaceTension (float): Coefficient for the surface tension computation
+* surfaceTension (float): Coefficient for the surface tension computation
+
+##### Emitters
+
+* maxEmitterParticles (int): Maximum number of particles the emitter generates. Note that reused particles (see below) are not counted here.
+* emitterReuseParticles (bool):  Reuse particles if they are outside of the bounding box defined by emitterBoxMin, emitterBoxMax
+* emitterBoxMin (vec3): Minimum coordinates of an axis-aligned box (used in combination with emitterReuseParticles)
+* emitterBoxMax (vec3): Maximum coordinates of an axis-aligned box (used in combination with emitterReuseParticles)

doc/getting_started.md

@@ -6,15 +6,15 @@ SPlisHSPlasH currently consists of different simulators and tools which are intr
 
 ## Simulators 
 
-### StaticBoundaryDemo
+### StaticBoundarySimulator
 
-This application reads a SPlisHSPlasH scene file and performs a simulation of the scene. It assumes that only static boundary objects are in the scenario which increases the performance. If you want to simulation dynamic boundaries, you can use "DynamicBoundaryDemo". 
+This application reads a SPlisHSPlasH scene file and performs a simulation of the scene. It assumes that only static boundary objects are in the scenario which increases the performance. If you want to simulation dynamic boundaries, you can use "DynamicBoundarySimulator". 
 
 The scene file format is explained [here.](file_format.md)
 
-### DynamicBoundaryDemo
+### DynamicBoundarySimulator
 
-This application can also simulate SPlisHSPlasH scenes but in contrast to the StaticBoundaryDemo it can handle dynamic boundaries. The dynamic rigid bodies are simulated using our [PositionBasedDynamics library](https://github.com/InteractiveComputerGraphics/PositionBasedDynamics) which is automatically included in the build process. If a scene only contains static bodies, you should use "StaticBoundaryDemo" since it is faster. 
+This application can also simulate SPlisHSPlasH scenes but in contrast to the StaticBoundarySimulator it can handle dynamic boundaries. The dynamic rigid bodies are simulated using our [PositionBasedDynamics library](https://github.com/InteractiveComputerGraphics/PositionBasedDynamics) which is automatically included in the build process. If a scene only contains static bodies, you should use "StaticBoundarySimulator" since it is faster. 
 
 The scene file format is explained [here.](file_format.md)