4 Manual Pages

The main input file for a spiffe run consists of a series of namelists, which function as commands. Most of the namelists direct spiffe to set up to run in a certain way. A few are “action” commands that begin the actual simulation. FORTRAN programmers should note that, unlike FORTRAN namelists, these namelists need not come in a predefined order; spiffe is able to detect which namelist is next in the file and process appropriately.

Each namelist has a number of variables associated with it, which are used to control details of the run. These variables come in three data types: (1) long, for the C long integer type, (2) double, for the C double-precision floating point type, and (3) STRING, for a character string enclosed in double quotation marks. All variables have default values, which are listed on the following pages. STRING variables often have a default value listed as NULL, which means no data; this is quite different from the value “”, which is a zero-length character string. long variables are often used as logical flags, with a zero value indicating false and a non-zero value indicating true.

On the following pages the reader will find individual descriptions of each of the namelist commands and their variables. Each description contains a sequence of the form

&<namelist-name>  
    <variable-type> <variable-name> = <default-value>;  
    .  
    .  
    .  
&end

This summarizes the parameters of the namelist. Note, however, that the namelists are invoked in the form

&<namelist-name>  
    [<variable-name> = <value> ,]  
    [<array-name>[<index>] = <value> [,<value> ...] ,]  
        .  
        .  
        .  
&end

The square-brackets enclose an optional component. Not all namelists require variables to be given–the defaults may be sufficient. However, if a variable name is given, it must have a value. Values for STRING variables must be enclosed in double quotation marks. Values for double variables may be in floating-point, exponential, or integer format (exponential format uses the ‘e’ character to introduce the exponent).

 4.1 define_geometry
 4.2 Geometry File
 4.3 define_antenna
 4.4 load_fields
 4.5 set_constant_fields
 4.6 add_on_axis_fields
 4.7 define_solenoid
 4.8 define_cathode
 4.9 load_particles
 4.10 poission_correction
 4.11 translate
 4.12 define_resistor
 4.13 define_screen
 4.14 define_secondary_emission
 4.15 define_snapshots
 4.16 define_field_output
 4.17 define_field_saving
 4.18 define_field_sampling
 4.19 integrate