2. Defining a Griddr Run

Griddr can take its inputs from both a parameter file and though the terminal.

When defining the parameters for a run (see ) Griddr can either read from a parameter file:

./Griddr-P --p parameters.param

take them from the terminal:

./Griddr-P --i inputFile.G2 --gdx 10 --gdy 10 --gdz 10 --o outFile.csv

or use a combination of both:

./Griddr-P --p parameters.param --i inputFile2.G2 --theta 45

in this instance, the terminal values override.

2.1 The Parameter File

For a complete example parameter file (‘parameters.param’) see below:

                   //      Griddr        //
                  //   Parameter File   //
                 //    ^^^^^^^^^^^^^^  //

 //!  input_file_location    ./input.G2
 //!  output_file_location   ./out

 //!  input_format  0                 // 0: G2 binary  1: G2 w/ne & X   9: hdf5
 //!  output_format 1                 // 0: ASCII  1: lean ASCII

 //!  UseVels     0


 //   --- define data transformation(s) ---   //
 //!  x_0         0                         // re-centre system (if periodic then coordinates are wrapped)
 //!  y_0         0
 //!  z_0         0

 //                                           // rotate system about (new) origin
 //!  rot_x        0                          // around cartesian axes
 //!  rot_y        0
 //!  rot_z        0

 //!  theta        0                          // ...or using pherical coordinates
 //!  phi          0

 //        --- define grid ---       //
 //!  NxDim        256
 //!  NyDim        256
 //!  NzDim        256


 //!  LimMode      0                 // 0: auto,     1: define each axis limit manually,     2: define box


 //   --- define limits MODE 0 ---   //
 //!  inc_type      0                // define particle type to enclose within auto-limits (-1 for all)

 //   --- define limits MODE 1 ---   //
 //!  xMin         -1
 //!  xMax         -1
 //!  yMin         -1
 //!  yMax         -1
 //!  zMin         -1
 //!  zMax         -1


 //   --- define limits MODE 2 ---   //
 //!  xLen         100
 //!  yLen         100
 //!  zLen         100
 //!  xCentre      0
 //!  yCentre      0
 //!  zCentre      0


 //!  sph_kernel     0                 // 0: CS    1: WC2    2: WC4    3: WC6    4: HOCT

2.2 Via the Command Line

A complete list of the current parameters can be obtained by calling Griddr with no arguments or with e.g.

./Griddr-P --help