generalBunchPattern

• type: Setup command.
• function: The command defines a general distribution of bunches using STRING variables containing a list of bunch positions and current values.

&generalBunchPattern
    STRING bucketSelection = NULL
    STRING currentPerBucketMA = NULL
    double totalCurrentMA = 0.0
    long clearPreviousPatterns = 0
&end.

• bucketSelection -- String containing a list of bucket numbers (long integers) for bunches to fill. A string variable is necessary for this input because a string has no pre-set length, while an array variable must be defined with a pre-set length.
• currentPerBucketMA -- String containing a list of bunch currents (double floating point numbers) corresponding to each bucket number specified in bucketSelection. If the variables bucketSelection and currentPerBucketMA have unequal number of entries, then the longer one is truncated. Here is an example of the use of the string variables for generating some arbitrary general pattern:

  &generalBunchPattern
      bucketSelection = "1 4 9 16"
      currentPerBucketMA = "1.0 2.0 3.0 4.0"
  &end.
  

• totalCurrentMA -- Total current to be distributed evenly among bunches defined in bucketSelection. This variable is used when variable currentPerBucketMA is not specified.