EMPIRE DA  v1.9.1
Data assimilation codes using EMPIRE communication
 All Classes Files Functions Variables Pages
output_empire Module Reference

Module that stores the information about the outputting from empire. More...

Public Member Functions

subroutine open_emp_o (id_num)
 subroutine to open the file for outputting More...
 
subroutine close_emp_o ()
 subroutine to close the output file More...
 

Public Attributes

integer, parameter emp_e =stderr
 the error stream number More...
 
integer, parameter emp_o =stdout
 the output stream number More...
 
integer, parameter unit_nml =10
 the unit number for reading empire.nml More...
 
integer, parameter unit_obs =11
 the unit number for reading and writing observations More...
 
integer, parameter unit_truth =12
 the unit number for reading and writing the truth More...
 
integer, parameter unit_weight =13
 the unit number for writing the ensemble weights More...
 
integer, parameter unit_mean =14
 the unit number for writing the ensemble mean More...
 
integer, parameter unit_state =15
 the unit number for reading and writing the state More...
 
integer, parameter unit_ens_rmse =16
 the unit number for reading and writing the ensemble rmse More...
 
integer, parameter unit_mat_tri =17
 the unit number for outputing triangular matrices More...
 
integer, parameter unit_spatial_rmse =18
 the unit number for writing the spatial rmse More...
 
integer, parameter unit_variance =19
 the unit number for outputing the ensemble variance More...
 
integer, parameter unit_hist_read =20
 the unit number for reading histogram data More...
 
integer, parameter unit_hist_write =21
 the unit number for writing histogram data More...
 
integer, parameter unit_hist_readt =22
 the unit number for reading histogram truth data More...
 
integer, parameter unit_hist_readp =23
 the unit number for reading histogram particle data More...
 
integer, parameter unit_traj_read =24
 the unit number for reading trajectory data More...
 
integer, parameter unit_traj_write =24
 the unit number for writing trajectory data More...
 
integer, parameter unit_vardata =25
 the unit number for reading vardata More...
 

Detailed Description

Module that stores the information about the outputting from empire.

Todo:
make stop codes appear on the empire error unit

Definition at line 31 of file output_empire.f90.

Member Function/Subroutine Documentation

subroutine output_empire::close_emp_o ( )

subroutine to close the output file

Definition at line 148 of file output_empire.f90.

Here is the caller graph for this function:

subroutine output_empire::open_emp_o ( integer, intent(in)  id_num)

subroutine to open the file for outputting

in order to redirect the STDOUT used by EMPIRE, this subroutine will read from the file 'empire.nml'. If it exists, it looks for the namelist &empire_output, which consists of a single string up to 10 characters called 'basename' which will be read, and the STDOUT redirected to that string appended with the MPI rank of the EMPIRE process.

In order to suppress most of the STDOUT from EMPIRE, this path can be set to a platform specific Null device:

  • Unix: /dev/null
  • MS: nul

If you are running on any other system, please let me know what Null Device you would like to use, and we can add a check for it

Definition at line 87 of file output_empire.f90.

Here is the caller graph for this function:

Member Data Documentation

integer, parameter output_empire::emp_e =stderr

the error stream number

Definition at line 34 of file output_empire.f90.

integer, parameter output_empire::emp_o =stdout

the output stream number

Definition at line 35 of file output_empire.f90.

integer, parameter output_empire::unit_ens_rmse =16

the unit number for reading and writing the ensemble rmse

Definition at line 47 of file output_empire.f90.

integer, parameter output_empire::unit_hist_read =20

the unit number for reading histogram data

Definition at line 55 of file output_empire.f90.

integer, parameter output_empire::unit_hist_readp =23

the unit number for reading histogram particle data

Definition at line 61 of file output_empire.f90.

integer, parameter output_empire::unit_hist_readt =22

the unit number for reading histogram truth data

Definition at line 59 of file output_empire.f90.

integer, parameter output_empire::unit_hist_write =21

the unit number for writing histogram data

Definition at line 57 of file output_empire.f90.

integer, parameter output_empire::unit_mat_tri =17

the unit number for outputing triangular matrices

Definition at line 49 of file output_empire.f90.

integer, parameter output_empire::unit_mean =14

the unit number for writing the ensemble mean

Definition at line 43 of file output_empire.f90.

integer, parameter output_empire::unit_nml =10

the unit number for reading empire.nml

Definition at line 36 of file output_empire.f90.

integer, parameter output_empire::unit_obs =11

the unit number for reading and writing observations

Definition at line 37 of file output_empire.f90.

integer, parameter output_empire::unit_spatial_rmse =18

the unit number for writing the spatial rmse

Definition at line 51 of file output_empire.f90.

integer, parameter output_empire::unit_state =15

the unit number for reading and writing the state

Definition at line 45 of file output_empire.f90.

integer, parameter output_empire::unit_traj_read =24

the unit number for reading trajectory data

Definition at line 63 of file output_empire.f90.

integer, parameter output_empire::unit_traj_write =24

the unit number for writing trajectory data

Definition at line 65 of file output_empire.f90.

integer, parameter output_empire::unit_truth =12

the unit number for reading and writing the truth

Definition at line 39 of file output_empire.f90.

integer, parameter output_empire::unit_vardata =25

the unit number for reading vardata

Definition at line 67 of file output_empire.f90.

integer, parameter output_empire::unit_variance =19

the unit number for outputing the ensemble variance

Definition at line 53 of file output_empire.f90.

integer, parameter output_empire::unit_weight =13

the unit number for writing the ensemble weights

Definition at line 41 of file output_empire.f90.


The documentation for this module was generated from the following file: