field-output.asciidoc



Back to Main Page


Table of Contents


1. Field Output

1.1. DUMPFIELDS Command

1.2. DUMPEMFIELDS Command

1.2.1. Cartesian Mode
1.2.2. Cylindrical Mode


1. Field Output


There are two routines that can be used to write out the external field used in OPAL-cycl.


DUMPFIELDS

write out static magnetic field map on a Cartesian grid

DUMPEMFIELDS

write out electromagnetic field map on a 4D grid in space-time. Cartesian and cylindrical grids are supported. DUMPEMFIELDS is an extension of DUMPFIELDS.


1.1. DUMPFIELDS Command

The DUMPFIELDS statement causes OPAL-cycl to write out static magnetic field data on a 3D cartesian grid. The format of field output is:


<number of rows>
1 x [m]
2 y [m]
3 z [m]
4 Bx [kGauss]
5 By [kGauss]
6 Bz [kGauss]
0
<x0> <y0> <z0> <Bx0> <By0> <Bz0>
<x1> <y1> <z1> <Bx1> <By1> <Bz1>
...


The following attributes are enabled on the DUMPFIELDS statement:


FILE_NAME

Name of the file to which field data is dumped. It is an error if the location reference by FILE_NAME cannot be opened. Any existing file is overwritten.

X_START

Start point in the grid in x

DX

Grid step size in x

X_STEPS

Number of steps in x. It is an error if X_STEPS is non-integer or less than 1.

Y_START

Start point in the grid in y

DY

Grid step size in y

Y_STEPS

Number of steps in y. It is an error if Y_STEPS is non-integer or less than 1.

Z_START

Start point in the grid in z

DZ

Grid step size in z.

Z_STEPS

Number of steps in z. It is an error if Z_STEPS is non-integer or less than 1.


This example makes a field map in the midplane (x-y plane) only, starting at (x,y) = (0,0) m, with 101 steps in each direction and a stride of 0.1 m. z is always 0.


DUMPFIELDS, X_START=0., X_STEPS=101, DX=0.100,
            Y_START=0., Y_STEPS=101, DY=0.100,
            Z_START=0., Z_STEPS=1, DZ=0.100,
            FILE_NAME="FieldMapXY.dat";


1.2. DUMPEMFIELDS Command

The DUMPEMFIELDS statement causes OPAL-cycl to write out electromagnetic field data on a 4D grid. Grids in a Cartesian coordinate system (x,y,z,t) and a cylindrical coordinate system about the z-axis in (r,\phi,z,t) are supported.


1.2.1. Cartesian Mode

In Cartesian mode the format of the field output is:


<number of rows>
1 x [m]
2 y [m]
3 z [m]
4 t [ns]
5 Bx [kGauss]
6 By [kGauss]
7 Bz [kGauss]
8 Ex [?]
9 Ey [?]
10 Ez [?]
0
<x0> <y0> <z0> <t0> <Bx0> <By0> <Bz0> <Ex0> <Ey0> <Ez0>
<x1> <y1> <z1> <t1> <Bx1> <By1> <Bz1> <Ex1> <Ey1> <Ez1>
...


The following attributes are enabled on the DUMPEMFIELDS statement when operating in Cartesian mode:


FILE_NAME

Name of the file to which field data is dumped. It is an error if the location referenced by FILE_NAME cannot be opened. Any existing file is overwritten.

COORDINATE_SYSTEM

Either 'Cartesian' or 'Cylindrical'. The string is not case sensitive. It is an error if the string is not one of 'cartesian' or 'cylindrical'.

X_START

Start point in the grid in x

DX

Grid step size in x

X_STEPS

Number of steps in x. It is an error if X_STEPS is non-integer or less than 1.

Y_START

Start point in the grid in y

DY

Grid step size in y

Y_STEPS

Number of steps in y. It is an error if Y_STEPS is non-integer or less than 1.

Z_START

Start point in the grid in z

DZ

Grid step size in z.

Z_STEPS

Number of steps in z. It is an error if Z_STEPS is non-integer or less than 1.

T_START

Start point in the grid in time

DT

Grid step size in time.

T_STEPS

Number of steps in time. It is an error if T_STEPS is non-integer or less than 1.


1.2.2. Cylindrical Mode

In Cylindrical mode the format of the field output is:


<number of rows>
1 r [m]
2 phi [degree]
3 z [m]
4 t [ns]
5 Br [kGauss]
6 Bphi [kGauss]
7 Bz [kGauss]
8 Er [?]
9 Ephi [?]
10 Ez [?]
0
<r0> <phi0> <z0> <t0> <Br0> <Bphi0> <Bz0> <Er0> <Ephi0> <Ez0>
<r1> <phi1> <z1> <t1> <Br1> <Bphi1> <Bz1> <Er1> <Ephi1> <Ez1>
...


The following attributes are enabled on the DUMPEMFIELDS statement when operating in Cylindrical mode:


FILE_NAME

Name of the file to which field data is dumped. It is an error if the location referenced by FILE_NAME cannot be opened. Any existing file is overwritten.

COORDINATE_SYSTEM

Either 'Cartesian' or 'Cylindrical'. The string is not case sensitive. It is an error if the string is not one of 'cartesian' or 'cylindrical'.

R_START

Start point in the grid in r

DR

Grid step size in r

R_STEPS

Number of steps in r. It is an error if R_STEPS is non-integer or less than 1.

PHI_START

Start point in the grid in phi

DPHI

Grid step size in phi

PHI_STEPS

Number of steps in phi. It is an error if PHI_STEPS is non-integer or less than 1.

Z_START

Start point in the grid in z

DZ

Grid step size in z.

Z_STEPS

Number of steps in z. It is an error if Z_STEPS is non-integer or less than 1.

T_START

Start point in the grid in time

DT

Grid step size in time.

T_STEPS

Number of steps in time. It is an error if T_STEPS is non-integer or less than 1.