MPAS-JEDI
mpas_covariance_mod Module Reference

Data Types

type  mpas_covar
 Fortran derived type to hold configuration data for the background/model covariance. More...
 

Functions/Subroutines

subroutine mpas_covar_setup (self, geom, f_conf)
 Linked list implementation. More...
 
subroutine mpas_covar_delete (self)
 
subroutine mpas_covar_sqrt_inv_mult (self, xctl, xincr)
 Multiply streamfunction by inverse(sqrt(C)), where C is 3d covariance matrix. More...
 
subroutine mpas_covar_sqrt_inv_mult_ad (self, xctl, xincr)
 Multiply streamfunction by inverse(sqrt(C)) - Adjoint. More...
 
subroutine mpas_covar_sqrt_mult (self, xincr, xctl)
 Multiply streamfunction by sqrt(C), where C is a 3d covariance matrix. More...
 
subroutine mpas_covar_sqrt_mult_ad (self, xincr, xctl)
 Multiply streamfunction by sqrt(C) - Adjoint. More...
 

Variables

type(registry_t) mpas_covar_registry
 Linked list interface - defines registry_t type. More...
 

Function/Subroutine Documentation

◆ mpas_covar_delete()

subroutine mpas_covariance_mod::mpas_covar_delete ( type(mpas_covar), intent(inout)  self)
Parameters
[in,out]selfCovariance structure

Definition at line 82 of file mpas_covariance_mod.F90.

Here is the caller graph for this function:

◆ mpas_covar_setup()

subroutine mpas_covariance_mod::mpas_covar_setup ( type(mpas_covar), intent(inout)  self,
type(mpas_geom), intent(in)  geom,
type(fckit_configuration), intent(in)  f_conf 
)

Linked list implementation.

Setup for the model's 3d error covariance matrices (B and Q_i) This routine queries the configuration for the parameters that define the covariance matrix, and stores the relevant values in the error covariance structure.

Parameters
[in,out]selfCovariance structure
[in]f_confConfiguration
[in]geomGeometry

Definition at line 46 of file mpas_covariance_mod.F90.

Here is the caller graph for this function:

◆ mpas_covar_sqrt_inv_mult()

subroutine mpas_covariance_mod::mpas_covar_sqrt_inv_mult ( type(mpas_covar), intent(in)  self,
real, intent(inout)  xctl,
type(mpas_fields), intent(in)  xincr 
)

Multiply streamfunction by inverse(sqrt(C)), where C is 3d covariance matrix.

Definition at line 95 of file mpas_covariance_mod.F90.

◆ mpas_covar_sqrt_inv_mult_ad()

subroutine mpas_covariance_mod::mpas_covar_sqrt_inv_mult_ad ( type(mpas_covar), intent(in)  self,
real, intent(in)  xctl,
type(mpas_fields), intent(inout)  xincr 
)

Multiply streamfunction by inverse(sqrt(C)) - Adjoint.

Definition at line 109 of file mpas_covariance_mod.F90.

◆ mpas_covar_sqrt_mult()

subroutine mpas_covariance_mod::mpas_covar_sqrt_mult ( type(mpas_covar), intent(in)  self,
type(mpas_fields), intent(inout)  xincr,
real, intent(in)  xctl 
)

Multiply streamfunction by sqrt(C), where C is a 3d covariance matrix.

Definition at line 123 of file mpas_covariance_mod.F90.

◆ mpas_covar_sqrt_mult_ad()

subroutine mpas_covariance_mod::mpas_covar_sqrt_mult_ad ( type(mpas_covar), intent(in)  self,
type(mpas_fields), intent(in)  xincr,
real, intent(inout)  xctl 
)

Multiply streamfunction by sqrt(C) - Adjoint.

Definition at line 137 of file mpas_covariance_mod.F90.

Variable Documentation

◆ mpas_covar_registry

type(registry_t) mpas_covariance_mod::mpas_covar_registry

Linked list interface - defines registry_t type.

Global registry

Definition at line 29 of file mpas_covariance_mod.F90.