soca_bkgerrfilt.interface.F90

Go to the documentation of this file.

! (C) Copyright 2017-2021 UCAR
!
! This software is licensed under the terms of the Apache Licence Version 2.0
! which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 
!< C++ interface for soca_bkgerrfilt_mod::soca_bkgerrfilt
module soca_bkgerrfilt_mod_c
 
use fckit_configuration_module, only: fckit_configuration
use iso_c_binding
 
! soca modules
use soca_bkgerrfilt_mod, only: soca_bkgerrfilt
use soca_geom_mod_c, only: soca_geom_registry
use soca_geom_mod, only: soca_geom
use soca_increment_mod, only: soca_increment
use soca_increment_reg, only: soca_increment_registry
use soca_state_mod, only: soca_state
use soca_state_reg, only: soca_state_registry
 
implicit none
private
 
 
#define LISTED_TYPE soca_bkgerrfilt
 
!> Linked list interface - defines registry_t type
#include "oops/util/linkedList_i.f"
 
!> Global registry for soca_bkgerrfilt
type(registry_t), public :: soca_bkgerrfilt_registry
 
 
! ------------------------------------------------------------------------------
contains
! ------------------------------------------------------------------------------
 
 
!> Linked list implementation
#include "oops/util/linkedList_c.f"
 
! ------------------------------------------------------------------------------
!> C++ interface for soca_bkgerrfilt_mod::soca_bkgerrfilt::setup()
!!
!! Constructor for D (standard deviation of background error)
subroutine soca_bkgerrfilt_setup_c(c_key_self, c_conf, c_key_bkg, c_key_geom) &
  bind(c,name='soca_bkgerrfilt_setup_f90')
 
  integer(c_int), intent(inout) :: c_key_self   !< The D structure
  type(c_ptr),       intent(in) :: c_conf       !< The configuration
  integer(c_int), intent(in)    :: c_key_bkg    !< Background field
  integer(c_int), intent(in)    :: c_key_geom   !< Geometry
 
  type(soca_state), pointer :: bkg
  type(soca_geom),  pointer :: geom
  type(soca_bkgerrfilt), pointer :: self
 
  call soca_bkgerrfilt_registry%init()
  call soca_bkgerrfilt_registry%add(c_key_self)
  call soca_bkgerrfilt_registry%get(c_key_self, self)
  call soca_state_registry%get(c_key_bkg, bkg)
  call soca_geom_registry%get(c_key_geom, geom)
 
  call self%setup(fckit_configuration(c_conf), bkg, geom)
end subroutine soca_bkgerrfilt_setup_c
 
 
! ------------------------------------------------------------------------------
!> C++ interface for soca_bkgerrfilt_mod::soca_bkgerrfilt destuctor
subroutine soca_bkgerrfilt_delete_c(c_key_self) &
  bind(c,name='soca_bkgerrfilt_delete_f90')
 
  integer(c_int), intent(inout) :: c_key_self
  type(soca_bkgerrfilt), pointer :: self
 
  call soca_bkgerrfilt_registry%get(c_key_self, self)
  if (associated(self%geom)) nullify(self%geom)
  call self%filt%delete()
 
  call soca_bkgerrfilt_registry%remove(c_key_self)
end subroutine soca_bkgerrfilt_delete_c
 
 
! ------------------------------------------------------------------------------
!> C++ interface for soca_bkgerrfilt_mod::soca_bkgerrfilt::mult()
!!
!! Multiplication forward and adjoint
subroutine soca_bkgerrfilt_mult_c(c_key_self, c_key_a, c_key_m)&
  bind(c,name='soca_bkgerrfilt_mult_f90')
 
  integer(c_int), intent(in) :: c_key_a     !<    "   to Increment in
  integer(c_int), intent(in) :: c_key_m     !<    "   to Increment out
  integer(c_int), intent(in) :: c_key_self
 
  type(soca_increment), pointer :: dxa
  type(soca_increment), pointer :: dxm
  type(soca_bkgerrfilt), pointer :: self
 
  call soca_increment_registry%get(c_key_a,dxa)
  call soca_increment_registry%get(c_key_m,dxm)
  call soca_bkgerrfilt_registry%get(c_key_self,self)
 
  !< Computes dxm = D dxa
  call dxm%copy(dxa)
  call self%mult(dxa, dxm)
end subroutine soca_bkgerrfilt_mult_c
 
 
end module soca_bkgerrfilt_mod_c