draft of format

Author: danielepanozzo

input-rules.json

@@ -0,0 +1,51 @@
+[
+    {
+        "name": "defaults",
+        "type": "file",
+        "format": ["json"],
+        "doc" : "path to another JSON file containing the default parameters (this file will be patched on top of the defaults)"
+    },
+    {
+        "name": "root_path",
+        "type": "path",
+        "required": true,
+        "doc": "path to root director in the simulation (by default this is the directory containing this JSON file, so other paths can  be relative to the JSON's path)"
+    },
+    {
+        "name": "geometry/type",
+        "type": "multiplechoice",
+        "choices": ["mesh", "plane"],
+        "doc": "What type of geometry is this? (for now only mesh is implemented)"
+    },
+    {
+        "name": "geometry/mesh",
+        "type": "file",
+        "required": true,
+        "fileformat": ["obj","msh"],
+        "doc": "Path to mesh file"
+    },
+    {
+        "name": "geometry/surface_selection",
+        "type": "dict",
+        "fields": ["id","axis","position","tolerance"],
+        "doc": "Describes a surface selection"
+        
+    }
+    {
+        "name": "geometry/surface_selection",
+        "type": "integer",
+        "min": 0,
+        "doc": "Describes a surface selection"
+        
+    }
+    {
+        "name": "geometry/surface_selection",
+        "type": "file",
+        "format": ["txt"],
+        "doc": "Describes a surface selection"
+        
+    }
+]
+    
+* accepts both lists or single elements transparently
+* if multiple rules apply to the same name, just one needs to pass

input.json

@@ -0,0 +1,63 @@
+{
+    // 
+    "defaults": "path/to/defaults.json", 
+    // 
+    "root_path": "path/to/root/", 
+    
+    // List of meshes and analytical geometries to use in the simulation
+    "geometry": [{
+        
+        "type": "mesh|plane",
+        
+        // 
+        "mesh": "path/to/mesh.ext",
+        
+        // Obstacles are geometries that are fully scripted
+        "is_obstacle": false,
+        
+        // Easy way to disable the geometry
+        "enabled": true,
+
+        // Simple transformation applied to the mesh upon loading
+        "transformation": {
+            "translation": [0.0, 0.0, 0.0],
+            "rotation": [0.0, 0.0, 0.0],
+            "rotation_mode": "xyz",
+            "scale": [1.0, 1.0, 1.0], 
+            "dimensions": [1.0, 1.0, 1.0] // absolute size of the mesh's bounding box
+        },
+
+        // What geometry to use?
+        "extract": "volume|surface|edges|points",
+
+        // Select/tag certain points (We dont use it currently.)
+        "point_selection": [],
+
+        // The following are different ways to specify surface_selection
+        "surface_selection": [{
+            // DP: add a surface group to avoid surface_ and a volume group to avoid volume_?
+            "id": 1,                
+            "axis": 1,
+            "position": 0.1025,
+            "tolerance": 0,
+        }],
+        "surface_selection": "path/to/file.txt",
+        "surface_selection": 1,
+        // "surface_offset": 3, // TODO
+
+        // The following are different ways to specify volume_selection
+        "volume_selection": [], // selection operators
+        "volume_selection": "path/to/file.txt",
+        "volume_selection": 1,
+
+        // Number of edge refinements
+        "n_refs": 0, // TODO
+
+        "advanced": {
+            "force_linear_geometry": false, // TODO
+            "refinement_location": 0.5, // TODO
+            "normalize_mesh": false, // TODO
+            "min_component": -1 // TODO
+        }
+    }]
+}