Routine description format and Data format

Section 7.4 is an alphabetical list of the FORTRAN ndf accessing routines and section 7.6 is an alphabetical list of its C-wrapper routines. The description of each FORTRAN routine contains four parts. The first part labeled Purpose is a brief statement about the routine. The second part labeled FORTRAN Calling presents the routine and its arguments, if any. If the routine has arguments then a table containing the following information about each argument immediately follows;

Argument type

Argument name

Input/Output

Unit

Description.

Argument type is the FORTRAN declaration of the argument in the ndf routine, or function return type if the routine is a FORTRAN function.

Argument name is its name and dimension, if any, as declared in the ndf routine. All multi-dimensional data are stored as 1-dimensional data. An argument name defined as 'V(c x r)' is a serial representation of a 2-dimensional matrix named 'V' and of size c x r. The fastest varying dimension is c. For example, the production transfer matrices are a function of outgoing and incident particles' energies. With nch outgoing energy groups and ncg incident energy groups the production transfer matrices are defined as J( nch x ncg). Accessing the i^th outgoing energy group and the j^th incident energy group is done serially as J(nch*j + i).

Input/Output is one of the following: (i) the argument is "read from" in the ndf routine, (o) the argument is "written to" in the ndf routine, (f) the routine is a function which returns this argument type or (u) the argument is maintained for historical reasons but is not used.

Unit is the unit for this argument (N/A is used for unit less arguments).

Description is a short summary of the type of data.

The third part is a description of the routine. The next part, if present, if Fatal Message and describes reason why the routine will abort execute of the program. The final part list other routines closely related to this routine and is labeled Related routines. The first routine listed is the routine that must be called before the described routine is called. If this must routine is not called, then the described routine will print a fatal message. If the first routine listed is "None" then no other ndf accessing routine must be called prior to calling the described routine. The must routine may require another routine to be called before it is called. For example, the routine ndfatw requires the routine ndfiso, the routine ndfiso requires the routine ndfbuff and the routine ndfbuff requires the routine ndfinit.