&FIELD 

&FIELD


overview

The instructions of the field section fall in 4 categories:

The use of this section is fairly straight-forward since it has only one frequently used instruction: PLOT-FIELD.

Setting parameters:

Command Short description
AREA Sets the view and size of the plotting area
GRID Sets the density of the plotting grid
SELECT Establishes the list of sense wires
TRACK Sets the track used for graphs

Plotting and printing:

Command Short description
PLOT-FIELD General purpose field plotting instruction
PRINT General purpose field printing instruction

Understanding:

Command Short description
CHECK Verifies charges and boundary conditions
MULTIPOLE-MOMENTS Computes the multipole moments for a wire

Service instructions:

Command Short description
SAMPLE Field value (see ELECTRIC_FIELD)
TIME Times the field calculations

Notes:

  1. There are several instructions in the optimisation section that perform related tasks.
  2. There are also procedure calls that perform related tasks: ELECTRIC_FIELD, ELECTRIC_FIELD_3, MAGNETIC_FIELD, MAGNETIC_FIELD_3, INTEGRATE_CHARGE, INTEGRATE_FLUX, MAP_ELEMENT, MAP_INDEX and MAP_MATERIAL.

AREA

Sets the following things:

AREA commands are found in several sections:

The geometrical extent of the field and the drift area boxes are distinct, but the viewing plane is shared between the two.

Format:

AREA [xmin ymin xmax ymax | xmin ymin zmin xmax ymax zmax] ...
     [VIEW plane] ...
     [ROTATE angle] ...
     [X-Y | R-PHI | X-Z | Y-Z | 3D | CUT | NEBEM] ...
     [LIGHT-ORIGIN \φ_light \θ_light] ...
     [REFLECTED-FRACTION frac_refl] ...
     [ABSORBED-FRACTION frac_scat] ...
     [COLOURS ncol] ...
     [PARTIAL-BOX-TICKMARKS | FULL-BOX-TICKMARKS] ...
     [PARTIAL-TUBE | FULL-TUBE] ...
     [PARTIAL-PLANES | FULL-PLANES] ...
     [SPLIT-INTERSECTING-PLANES | NOSPLIT-INTERSECTING-PLANES] ...
     [NOSORT-PLANES | SORT-PLANES] ...
     [OUTLINE | NOOUTLINE] ...
     [PLOT-MAP | NOPLOT-MAP] ...
     [NOSTEP | STEP]

Example:

AREA -1 -1 1 1

Additional information on:

 

CHECK

Checks the following aspects of the field calculations:

CHECK is mainly a debugging instruction, but the WIRE option is a convenient means to to determine the field at the surface of the wires. This quantity is of interest since it gives a rough feeling for the avalanche amplification.

The CHECK command is not meant to be used with finite element field maps. Even the MAXWELL option is not particularly useful since finite element fields are, by construction, not gradient-free. The finite element programs that are most commonly used with Garfield represent their potential as a 2nd order polynomials. Such potentials are gradient-free only if one imposes constraints on the coefficients, something that is in general not done. The finite element programs themselves are much better equipped to evaluate the quality of their field maps.

The CHECK command works in the z=0 plane and ignores the VIEW part of the AREA command - this is justified since chambers that are made of wires, planes and periodicity do not have structure in the z-direction. This point will have to be revisited when 3D point charges are introduced.

Format:

CHECK [WIRES] ...
           [EPSILON-WIRE \ε_wire] ...
      [CHARGES] ...
      [PLANES] ...
      [TUBE] ...
      [MAXWELL] ...
           [BINS bins] ...
           [EPSILON-MAXWELL \ε_Maxwell] ...
           [PRINT | NOPRINT] ...
           [PLOT | NOPLOT] ...
      [FULL] ...
      [NOKEEP-RESULTS | KEEP-RESULTS]

Example:

CH WIRE BINS 50

(This would be used to find the field on the surface of the wires and you'll get a few checks on the wire-charges for free.)

Additional information on:


GRID

Sets the number of grid points in x (or r) and y (or \φ) used to produce the plots and tables.

In the field section, the grid determines the following:

The grid is common to all sections.

Format:

GRID  number_of_steps_in_x  [number_of_steps_in_y]

Example:

GRID 50

Additional information on:

 

MULTIPOLE-MOMENTS

Helps in finding wires that have a clear dipole, quadrupole etc moment because of the presence of other wires nearby. Such wires should receive special attention because Garfield assumes that a simple charge is enough to describe the wire.

Dipole terms are available in Garfield for a few potential types via the DIPOLE-TERMS option. The absence of dipole terms for the remaining potential types, just like the absence of quadrupole etc. potentials in Garfield, is not a fundamental limitation. Such potentials can be added on request.

Format:

MULTIPOLE-MOMENTS ...
     WIRE wire ...
     [ORDER order] ...
     [RADIUS r] ...
     [NOPLOT | PLOT] ...
     [NOPRINT | PRINT] ...
     [EPSILON \ε] ...
     [ITERATE-MAXIMUM iter]

Example:

MULTIPOLE WIRE 1 PLOT

Will plot the multipole moments up to order 4 for wire 1.

Additional information on:

 

OPTIONS

Sets field related as well as top level OPTIONS.

Format:

OPTIONS [NOCHECK-MAP-INDICES | CHECK-MAP-INDICES] ...
        [CONTOUR-ALL-MEDIA | CONTOUR-DRIFT-MEDIUM] ...
        [NOWIRE-MARKERS | WIRE-MARKERS]

Example:

opt check-map contour-drift

Additional information on:


PLOT-FIELD

This instruction plots the electrostatic and magnetic field in a variety of ways, such as contours, a surface plot, a graph, an histogram and a vector plot.

Similar instructions exist in the drift and signal sections.

CPU time can be saved if several plots are combined in a single command.

Format:

PLOT-FIELD [CONTOUR [f1]   [RANGE {cmin cmax | AUTOMATIC}] ...
                           [N n] ...
                           [LABELS | NOLABELS] ] ...
           [GRAPH [f2]]    [ON f_curve] ...
                           [N n]] ...
                           [SCALE min max] ...
                           [NOPRINT | PRINT] ...
           [HISTOGRAM [f3] [RANGE {hmin hmax | AUTOMATIC}] ...
                           [BINS nbin]] ...
           [SURFACE [f4]   [ANGLES \φ \θ]] ...
           [VECTOR [f5 f6 [f7]]]

If you don't manage to fit all this on a single line, remember that lines that end on an ellipsis are continued on the next.

Examples:

PLOT HIST VECTOR SURF CONT
PLOT CONTOUR RANGE 500 550
PLOT GRAPH 'SIN X'

(The first example makes most of the plots using default functions and ranges - useful as a first call. The second example makes a more detailed contour plot and the third one shows that you can use this program also to produce graphs of arbitrary functions.)

Additional information on:


PRINT

Prints a table of a series of field functions (using X, Y or R, PHI and EX, EY or ER, EPHI plus BX, BY, B if applicable as symbolic names).

This procedure, contrary to e.g. PLOT-FIELD still operates only in the z=0 plane.

A large number of functions may be given as argument but the tables are always for at most 4\ functions at the time. This instruction tends to produce a lot of output: one page per 10\×10 block of points on the current GRID.

Format:

PRINT f1 f2 ...

Example:

PR EX, EY, E, V

Additional information on:

 

SAMPLE

Evaluates and prints the field at a single point.

This instruction was used for debugging, but is now superseded by the procedure calls ELECTRIC_FIELD and ELECTRIC_FIELD_3.

Format:

SAMPLE x y

Example:

SAMPLE 0.5 0.5

SELECT

Selects and groups the electrodes which are to be handled specially. The selection is common to all sections, but the interpretation of the selection is left to the individual instructions.

In this section, the selection determines which wires are checked by CHECK. The grouping is of no importance. Selection of other electrodes than wires has no effect.

Format:

SELECT selection

Example:

SEL (1 S) 2 F

(Put wire 1 together with all S wires in one group, make wire 2 a group of its own and do the same for each of the F wires.)

Additional information on:

 

TIME

Performs field evaluation at random locations distributed over the current AREA and times them.

Format:

TIME [n]

Example:

TIME 10000

Additional information on:

 

TRACK

Defines the line over which the GRAPH is made by the PLOT-FIELD instruction.

The TRACK command is shared between all sections and has therefore a rich format. In this section, only the geometrical aspects are used. Particle types and clustering models need not be specified.

Format:

See the TRACK command in the drift section.

Example:

TR -1 -1 -1 1

Go to the top level, to &FIELD, to the topic index, to the table of contents, or to the full text.

Formatted on 21/01/18 at 16:55.