prism_put_restart

prism_put_restart (var_id, date, date_bounds, data_array, info, ierror)

Table 5.24: prism_put_restart arguments

This function forces the writing of a field into a coupling restart file and can be used in the same fashion as prism_put , except that the prism_put_restart does not consider any coupling period from the SMIOC file and writes the data array into the restart file each time it is called. Note that a prism_put_restart can follow a prism_put .

This function should be used when a coupling restart file of a coupling field is needed (see section 5.7 for details on the restart mechanism) but not available. In that case, the user should run the source component beforehand to create the first coupling restart file of an experiment explicitly with a call to prism_put_restart . The returned info should be PRISM_Rst = 10 (the array is only written to a coupling restart file); in case the returned info is PRISM_Noaction = 0, an internal error occured. The meaning of the different ierror returned can be accessed using the routine prism_error (see section 5.9.3).

To use prism_put_restart , one should pay attention to the following details:

• There must be a lag equal to 0 defined for the corresponding field in the component SMIOC XML file (see 6.5.4) .

• Since the prism_enddef performs some IO related initialisation, a prism_put_restart cannot be invoked before the prism_enddef is completed.

• The name of the restart file will be $<$field_local_name$>$_$<$component_local_name$>$
  _$<$application_local_name$>$_rst.$<$date$>$.nc, where $<$date$>$ is the current run end_date indicated in the SCC XML file.

• The time information written into the restart file (variable time(time)) corresponds to the calling argument date_bounds(2). At restart, the time information in the restart file must be the run start_date indicated in the SCC XML file $\pm$ 2 seconds.

• Currently, fields written to a restart file via prism_put_restart are currently taken as is and are not processed with respect to local operations like gathering/scattering averaging, summation or any reduction operations.

A concrete example on how to use the PSMILe prism_put_restart routine to create an OASIS4 coupling restart file can be found in directory oasis4/examples/toyoa4_restart (see the README therein). In practice, it is recommended, as done in toyoa4_restart to follow these rules:

• In the SCC XML file, put the experiment start_date = experiment end_date = run start_date = run end_date = the start date of the run for which the restart file will be created.
• As date_bounds arguments for the prism_put_restart put date_bounds(2) = the start date of the run for which the restart file will be created and date_bounds(1) = some time (e.g. one hour) before that same start date.