Changes between Initial Version and Version 1 of U_obs_op

Timestamp:

Jan 22, 2016, 10:44:41 AM (8 years ago)

Author:

lnerger

Comment:

--

U_obs_op

@@ +1 @@
+= U_obs_op =
+
+The page document the user-supplied call-back routine `U_obs_op`.
+
+The routine `U_obs_op` is a call-back routine that has to be provided by the user. In the simplified interface the predefined name of the routine is `obs_op_pdaf`, but in the full interface, the user can choose the name of the routine.
+The routine is used with all global filters. The purpose of the routine is to apply the observation operator to the state vector provided by PDAF when the routine is called. The routine is called during the filter analysis step. 
+
+The interface is the following:
+{{{
+SUBROUTINE U_obs_op(step, dim_p, dim_obs_p, state_p, m_state_p)
+}}}
+with
+ * `step` : `integer, intent(in)`[[BR]] Current time step
+ * `dim_p` : `integer, intent(in)`[[BR]] Size of state vector (local part in case of parallel decomposed state)
+ * `dim_obs_p` : `integer, intent(in)`[[BR]] Size of observation vector
+ * `state_p` : `real, intent(in), dimension(dim_p)`[[BR]] Model state vector
+ * `m_state_p` : `real, intent(out), dimension(dim_obs_p)`[[BR]] Observed state vector (i.e. the result after applying the observation operator to `state_p`)
+
+Notes:
+ * For a model using domain decomposition, the operation is on the PE-local sub-domain of the model and has to provide the observed sub-state for the PE-local domain.
+
+Hint:
+ * If domain-decomposition is used and the observation operator involves a global operation, e.g. some global integration, one has to gather the information from the other model domains using MPI communication.