Input-file-for-boneload-simulations.md

@@ -47,6 +47,7 @@ In practice, the last two blocks can be blindly copied as shown hereabove at the
 | `muscles` | list of dict | A list of muscles. Each muscle is defined by a dictionary (see [below](#muscles)). |
 | `fixations` | list of dict | A list of fixations (displacements prescribed to 0 along a direction). Each fixation is defined by a dictionary (see [below](#fixations)) |
 | `loads` | list of dict | A list of additional nodal loads. Each fixation is defined by a dictionary (see [below](#loads)) |
+| `extractors` | list of dict | A list of additional extractors. Extractors extract results such as stresses, strains or displacements computed at given nodes (see [below](#extractors)) |
 | `density` | scalar | Bone density (only used by the Chung-Hulbert time integration scheme of Metafor - not used with the linear-statics solver of fossils). |
 | `Young` | scalar | Linear elasticity: Young's modulus. |
 | `Poisson` | scalar | Linear elasticity: Poisson's coefficient. |
@@ -143,7 +144,7 @@ user name of the fixation. This string is only used to display the associated fo
 
 list of \[x,y,z\] or filename
 </td>
-<td>node(s) on which the displacement will be prescribed to 0. It could be a point specified using its coordinates, or a list of coordinates, or the filename of a mesh (PLY or OFF) the vertices of which will be used.</td>
+<td>node(s) on which the displacement will be prescribed to 0. It could be a point specified using its coordinates, or a list of coordinates, or the filename of a mesh (PLY, STL or OFF) the vertices of which will be used.</td>
 </tr>
 <tr>
 <td>
@@ -172,7 +173,7 @@ list of axis labels among `'x'`, `'y'`, `'z'` used to define the directions alon
 `name`
 </td>
 <td>string</td>
-<td>user name of the force. This is only used internally to define the name of the group of nodes. </td>
+<td>user name of the force. This is only used internally to define the name of the group of nodes.</td>
 </tr>
 <tr>
 <td>
@@ -200,6 +201,52 @@ list of \[x,y,z\] or filename
 </tr>
 </table>
 
+#### extractors
+
+<table>
+<tr>
+<th>name</th>
+<th>type</th>
+<th>description</th>
+</tr>
+<tr>
+<td>
+
+`name`
+</td>
+<td>string</td>
+<td>user name of the extractor.</td>
+</tr>
+<tr>
+<td>
+
+`nodes`
+</td>
+<td>
+
+\[x,y,z\] or
+
+list of \[x,y,z\] or filename
+</td>
+<td>node(s) on which the extractor will be applied. It could be a point specified using its coordinates, or a list of coordinates, or the filename of a mesh (PLY, STL or OFF) the vertices of which will be used.</td>
+</tr>
+<tr>
+<td>
+
+`variables`
+</td>
+<td>string or list of strings</td>
+<td>
+
+a string among `x0`, `y0`, `z0` (initial position), `dx`, `dy`, `dz` (displacement), `fx`, `fy`, `fz` (external force), `sigxx`, `sigyy`, `sigzz`, `sigxy`, `sigyz`, `sigxz` (Cauchy-stress components), `sigvm` (Von-Mises stress), `epsxx`, `epsyy`, `epszz`, `epsxy`, `epsyz`, `epsxz` (strain tensor components)
+</td>
+</tr>
+</table>
+
+The name and the value extracted is displayed after calculation if it concerns 1 single node. If several nodes are given, the values can be found in a text file in the workspace folder of the simulation.
+
+In Metafor, the file is named `(user name of the extractor)_(variable).ascii`. Each line refers to a time increment (the last line is the final state). Each column refers to a node. Extracting `x0` , `y0` , `z0` in addition to the wanted value can be useful to identify which value correspond to which node.
+
 ### Additional notes
 
 #### Relative paths