The `output' element

If the coupling/IO field is exported through a prism_put in the component code, it can be effectively be sent to none, one, or many targets, each target being described in one element `ouput'. A more detailed description of element `output', its attributes and sub-elements is given here.

1. attribute `transi_out_name' (mandatory) : a symbolic name defined by the user for that specific `output' element.

2. element `exchange_date' (mandatory) : The dates at which the coupling or I/O will effectively be performed. To express these dates, the user has to specify the following sub-element:
   • element `period' (mandatory): The coupling or I/O is performed with a fixed period. To define this period, the user must specify a number of seconds, minutes, hours, days, months, and/or years, with respectively the sub-elements `second', `minute', `hours', `day', `month', `year' (all optional but at least one must be specified).

3. element `corresp_transi_in_name' (mandatory) : The symbolic name of the corresponding input coupling/IO field origin (attribute `transi_in_name' of element `origin' of element `input') in the target component or target file . This defines an exchange between a source and a target component or file. Coherence has to be ensured, i.e. the value of the current output `transi_out_name' attribute (see above) has to be specified in the `corresp_transi_out_name' element of the corresponding input coupling field origin (see also section 6.5.5). Note that this coherence is automatically ensured when using the graphical user interface oasis-gui.tcl (available in oasis4/util/gui) to create the SMIOC files.

4. element `file' or element `component_name' (one or the other mandatory): The target file description (I/O) or the target component `local_name' attribute (coupling). The `file' element is described in more detail in section 6.5.7.

5. element `lag' (optional): The number of prism_put periods¹⁴ to add to the output coupling field prism_put date and date_bounds to match the corresponding input coupling field prism_get date in the target component (see also 5.6.4).

6. element `source_transformation' (optional) : The transformations performed on the output coupling/IO field in the source component PSMILe .
   • element `source_time_operation' (optional) : for each grid point, the output coupling/IO field can be averaged (taverage) or accumulated (accumul) over the last coupling period by the source PSMILe and the result is transfered. Note that the average or the accumulation is simply done over the arrays provided as argument to the prism_put calls, not weighted by the time interval between these calls.

   • element `statistics' (optional) : different statistics (minimum, maximum, integral) are calculated for the field on the masked points, and/or on the not masked points, and/or on all points of the output coupling/IO field, if respectively the sub-elements `masked_points', and/or `notmasked_points', and/or `all_points' are specified with value 'on' or 'off'. This is done below the prism_put by the source PSMILe (after the time operations described in element `source_time_operation' if any). These statistics are printed to the PSMILe log file for information only; they do not transform the output coupling/IO field.

   • element `source_local_transformation' (optional) : the following local transformations may be performed on the output coupling/IO field by the source PSMILe :
     • element `scattering': the `scattering' should be specified by the developer in the PMIOD and should not be changed by the user in the SMIOC. If `scattering' is true, scattering is performed on an output coupling/IO field below the prism_put by the source PSMILe . It is required when grid information transfered to the PSMILe includes the masked points and when the array transfered to the prism_put API is a vector gathering only the non-masked points.

     • element `mult_scalar' (optional) : Each grid point coupling/IO field value is multiplied by the scalar specified in this element.

     • element `add_scalar' (optional) : The scalar specified in this element is added to each grid point coupling/IO field value.

       When these two elements are specified, the multiplication is performed before the addition.

7. element `debug_mode' (optional) : either true or false; if it is true, the output coupling/IO field is automatically also written to a file below the prism_put . If there is a lag for this field (see above), the time in the debug file is the date argument of the prism_put call + lag. The field written to the restart file is also written to the prism_put debug file.

Footnotes

... periods¹⁴

A prism_put period is the time between the prism_put date_bounds; e.g. for a lag of 1, the time added to the prism_put date and date_bounds arguments would be once the time difference between the associated date_bounds.