= Checking Error Status of PDAF-OMI =

{{{
#!html
<div class="wiki-toc">
<h4>PDAF-OMI Guide</h4>
<ol><li><a href="PDAF_OMI_Overview">Overview</a></li>
<li><a href="OMI_Callback_obs_pdafomi">callback_obs_pdafomi.F90</a></li>
<li><a href="OMI_observation_modules">Observation Modules</a></li>
<li><a href="OMI_observation_operators">Observation Operators</a></li>
<li>Checking error status</li>
<li><a href="OMI_debugging">Debugging functionality</a></li>
<li><a href="OMI_ImplementationofAnalysisStep">Implementing the analysis step with OMI</a></li>
<ol>
<li> <a href="ImplementFilterAnalysisOverview"> General overview for ensemble filters</a></li>
<ol>
<li><a href="ImplementAnalysisGlobal">Implementation for Global Filters</a></li>
<li><a href="ImplementAnalysisLocal">Implementation for Local Filters</a></li>
<li><a href="ImplementAnalysislenkfOmi">Implementation for LEnKF</a></li>
</ol>
<li> <a href="Implement3DVarAnalysisOverview"> General overview for 3D-Var methods</a></li>
<ol>
<li><a href="ImplementAnalysis_3DVar">Implementation for 3D-Var</a></li>
<li><a href="ImplementAnalysis_3DEnVar">Implementation for 3D Ensemble Var</a></li>
<li><a href="ImplementAnalysis_Hyb3DVar">Implementation for Hybrid 3D-Var</a></li>
</ol>
</ol>
<li><a href="OMI_nondiagonal_observation_error_covariance_matrices">Using nondiagonal R-matrices</a></li>
<li><a href="Porting_to_OMI">Porting an existing implemention to OMI</a></li>
<li><a href="PDAFomi_additional_functionality">Additional OMI Functionality</a></li>
</ol>
</div>
}}}
PDAF-OMI performs several consistency checks. If they fail, PDAF-OMI will print an error message, but the program is not stopped. Starting from PDAF V2.2 there OMI has an error status flag that can be checked from the user code. If an error occured, one can stop the program on the user side.

The error flag can be checked by calling the routine `PDAFomi_check_error`, which was introduced with PDAF version 2.2. The routine is documented below. It returns the value of the PDAF-OMI error flag. Since PDAF-OMI executes internal routines in which errors could occur due to an inconsistent configuration of the observations, a direct returning an error flag as a subroutine argument is not always possible. For this reasion there is this separate routine to check for the error flag. 

A useful place to insert this routine for error-checking are the routines in callback_obs_pdafomi.F90. 

The interface is:
{{{
  SUBROUTINE PDAFomi_check_error(ierror)

    INTEGER, INTENT(in) :: ierror          ! Value of PDAF-OMI error flag
                                             ! (0): no error
                                             ! (>0): an error occured - check screen outputs
}}}

'''Notes: '''
 * The routine is provied through the module 'PDAFomi'. Thus one has to use-include the routine by 
{{{
  USE PDAFomi, only: PDAFomi_set_debug_flag
}}}
 * The errors that are checked by PDAF-OMI relate to the configuration of the obserations, e.g. it is checked whether some dimensions are consistent. 
 * If an error occurred PDAF-OMI also prints an error message, but it does not stop the program.