SOCA
soca_covariance_mod_c Module Reference

C++ interfaces for soca_covariance_mod::soca_cov. More...

Functions/Subroutines

subroutine soca_b_setup_c (c_key_self, c_conf, c_key_geom, c_key_bkg, c_vars)
 Linked list implementation. More...
 
subroutine soca_b_delete_c (c_key_self)
 C++ interface for soca_covariance_mod::soca_cov::delete() More...
 
subroutine soca_b_mult_c (c_key_self, c_key_in, c_key_out)
 C++ interface for soca_covariance_mod::soca_cov::mult() More...
 
subroutine soca_b_randomize_c (c_key_self, c_key_out)
 C++ interface for soca_covariance_mod::soca_cov::sqrt_c_mult() More...
 

Variables

type(registry_t), public soca_cov_registry
 Linked list interface - defines registry_t type. More...
 

Detailed Description

C++ interfaces for soca_covariance_mod::soca_cov.

Function/Subroutine Documentation

◆ soca_b_delete_c()

subroutine soca_covariance_mod_c::soca_b_delete_c ( integer(c_int), intent(inout)  c_key_self)
private

C++ interface for soca_covariance_mod::soca_cov::delete()

Delete for the SOCA model's background error covariance matrix

Parameters
[in,out]c_key_selfThe background covariance structure

Definition at line 73 of file soca_covariance.interface.F90.

◆ soca_b_mult_c()

subroutine soca_covariance_mod_c::soca_b_mult_c ( integer(c_int), intent(inout)  c_key_self,
integer(c_int), intent(in)  c_key_in,
integer(c_int), intent(in)  c_key_out 
)
private

C++ interface for soca_covariance_mod::soca_cov::mult()

Parameters
[in,out]c_key_selfThe background covariance structure
[in]c_key_in" to Increment in @param [in] c_key_out " to Increment out

Definition at line 87 of file soca_covariance.interface.F90.

◆ soca_b_randomize_c()

subroutine soca_covariance_mod_c::soca_b_randomize_c ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_out 
)
private

C++ interface for soca_covariance_mod::soca_cov::sqrt_c_mult()

Generate randomized C^1/2 x increment

Parameters
[in]c_key_selfcovar config structure
[in]c_key_outRandomized increment

Definition at line 110 of file soca_covariance.interface.F90.

◆ soca_b_setup_c()

subroutine soca_covariance_mod_c::soca_b_setup_c ( integer(c_int), intent(inout)  c_key_self,
type(c_ptr), intent(in)  c_conf,
integer(c_int), intent(in)  c_key_geom,
integer(c_int), intent(in)  c_key_bkg,
type(c_ptr), intent(in), value  c_vars 
)
private

Linked list implementation.

C++ interface for soca_covariance_mod::soca_cov::setup()

Setup for the SOCA model's background error covariance matrix

Parameters
[in,out]c_key_selfThe background covariance structure
[in]c_confThe configuration
[in]c_key_geomGeometry
[in]c_key_bkgBackground
[in]c_varsList of variables

Definition at line 45 of file soca_covariance.interface.F90.

Variable Documentation

◆ soca_cov_registry

type(registry_t), public soca_covariance_mod_c::soca_cov_registry

Linked list interface - defines registry_t type.

Global registry for soca_cov

Definition at line 31 of file soca_covariance.interface.F90.