Example DIP documentation

1        $unit length = 1 cm
2        $unit mass = 2 g
3        
4        cfl_factor float = 0.7  # Courant-Friedrichs-Lewy condition
5        max_vare float = 0.2    # maximum energy change of electrons
6        max_vari float = 0.2    # maximum energy change of ions

 1$source settings = settings.dip
 2
 3simulation
 4  name str = "simulation"
 5    !format "[a-zA-Z_-]+"
 6  precision str = "double"
 7    !options ["double","float"]
 8  directory = {pahts?simulation.directory}
 9
10runtime
11  t_max float s              # mandatory
12    !condition ("{?} > 0")
13    !description "Maximum simulation time"
14  timestep float s
15    !condition ("{?} < {?runtime.t_max} && {?} > 0")  # mandatory
16    !description "Simulation time step"
17  {settings?runtime.*}
18
19box
20  geometry uint16 = {settings?box.geometry}  # mandatory
21    = 1  # linear
22    = 2  # cylindrical
23    = 3  # spherical
24    !description "Type of grid geometry"
25    
26  size
27    x float128 cm            # mandatory
28      !condition ("{?} > 0")
29      !description "Box size in X direction"
30    #y float cm               # first declared here
31    @case ("{?box.geometry} == 2")
32      y float cm             # mandatory if geometry is non-linear
33        = 3 cm 
34        = 4 cm
35        !description "Box size in Y direction"
36    @case ("{?box.geometry} == 3")
37      y float = 34 au
38      vy float = 23 km/s
39    #@else
40    #  y float = 3 m
41    @end
42    @case ("{?box.geometry} == 3")
43      z float = 23 cm        # constant
44        = 10 m
45        !options [20,23,26] cm
46        !description "Box size in Z direction"
47        !constant
48    @end
49    {settings?box.size.*}
50  boundary
51    {options?box.boundary.*}
52  
53modules
54  hydrodynamics bool = true  # optional
55    !description "Switch on hydrodynamics module"
56    !tags ["preprocessor"]
57  heating bool               # mandatory
58    !description "Switch on heating module"
59    !tags ["preprocessor"]
60  radiation bool             # mandatory
61    !description "Switch on radiation module"
62    !tags ["preprocessor"]
63  
64  {settings?modules.*}
65
66cells
67  {cells?*}

1densities float[10]    = [0,1,2,3,4,5,6,7,8,9] km/s
2sizes int[10]          = [10,11,12,13,14,15,16,17,18,19] cm
3temperatures float[10] = [20,21,22,23,24,25,26,27,28,29] K

 1runtime
 2  t_max = 10 ns
 3  timestep = 0.01 ns
 4
 5box
 6  geometry = 3
 7  size
 8    x = 10 nm
 9    y = 3e7 nm
10
11modules
12  heating = false
13  radiation = true