GET_CLUSTER 

Call: GET_CLUSTER


xcls

See coordinates.

ycls

See coordinates.

zcls

See coordinates.

coordinates

Contains on return the coordinates at which the cluster is produced. The cluster location is returned in Cartesian coordinates, also if the cell has been entered in Polar coordinates. The INTERNAL_TO_POLAR procedure can be used for the conversion.

These arguments should not be used if done has been set to True or OK to False.

This 3 arguments should be a simple global variables, not formulae or constants. The global variables may already exist before the procedure is called, in which case their contents will be lost, but they may also be an variables that have sofar not been used.

The coordinates are returned as Numbers with unit cm, no matter the coordinate system that is used.


ecls

Contains on return the energy in MeV deposited in the cluster.

This argument should not be used if done has been set to True or OK to False.

The precise interpretation of the energy that is returned depends on the clustering model that is in effect:

This argument should be a simple global variable, not a formula or a constant. The global variable may already exist before the procedure is called, in which case its contents will be lost, but it may also be an variable that has sofar not been used. The argument is of type Number after the call.


npair

Contains on return the Number of electrons (and ions) present in the cluster.

This argument should not be used if done has been set to True or OK to False.

This argument should be a simple global variable, not a formula or a constant. The global variable may already exist before the procedure is called, in which case its contents will be lost, but it may also be an variable that has sofar not been used.


extra

Contains on return additional information. The actual contents varies with the clustering model.

This argument is optional. If it is present, then it must be the one-but-last argument of the procedure. That is, if 6 arguments are passed, then the 6th will be considered to be done and extra will not be returned.

This argument should be a simple global variable, not a formula or a constant. The global variable may already exist before the procedure is called, in which case its contents will be lost, but it may also be an variable that has sofar not been used.


done

This argument is set to False if a cluster has been generated successfully.

It is set to True if the present call didn't result in a cluster because:

Further calls will not result in clusters either.

Note the difference between this parameter and OK. The latter is set to False if an error has been detected generating the clusters, for instance because of buffer overflow in Heed.

This argument should be a simple global variable, not a formula or a constant. The global variable may already exist before the procedure is called, in which case its contents will be lost, but it may also be an variable that has sofar not been used.


Go to the top level, to Call, to GET_CLUSTER, to the topic index, to the table of contents, or to the full text.

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