FV3 Bundle
fv3jedi_covariance_mod Module Reference

Data Types

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

Functions/Subroutines

subroutine fv3jedi_covar_setup (self, geom, c_conf)
 Setup for the model's 3d error covariance matrices (B and Q_i) More...
 
subroutine fv3jedi_covar_delete (self)
 
subroutine fv3jedi_covar_sqrt_inv_mult (self, xctl, xincr)
 Multiply streamfunction by inverse(sqrt(C)), where C is 3d covariance matrix. More...
 
subroutine fv3jedi_covar_sqrt_inv_mult_ad (self, xctl, xincr)
 Multiply streamfunction by inverse(sqrt(C)) - Adjoint. More...
 
subroutine fv3jedi_covar_sqrt_mult (self, xincr, xctl)
 Multiply streamfunction by sqrt(C), where C is a 3d covariance matrix. More...
 
subroutine fv3jedi_covar_sqrt_mult_ad (self, xincr, xctl)
 Multiply streamfunction by sqrt(C) - Adjoint. More...
 

Function/Subroutine Documentation

◆ fv3jedi_covar_delete()

subroutine fv3jedi_covariance_mod::fv3jedi_covar_delete ( type(fv3jedi_covar), intent(inout)  self)
Parameters
[in,out]selfCovariance structure

Definition at line 43 of file fv3jedi_covariance_mod.f90.

Here is the caller graph for this function:

◆ fv3jedi_covar_setup()

subroutine fv3jedi_covariance_mod::fv3jedi_covar_setup ( type(fv3jedi_covar), intent(inout)  self,
type(fv3jedi_geom), intent(in)  geom,
type(c_ptr), intent(in)  c_conf 
)

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]c_confConfiguration
[in]geomGeometry

Definition at line 32 of file fv3jedi_covariance_mod.f90.

Here is the caller graph for this function:

◆ fv3jedi_covar_sqrt_inv_mult()

subroutine fv3jedi_covariance_mod::fv3jedi_covar_sqrt_inv_mult ( type(fv3jedi_covar), intent(in)  self,
real, intent(inout)  xctl,
type(fv3jedi_increment), intent(in)  xincr 
)

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

Definition at line 54 of file fv3jedi_covariance_mod.f90.

◆ fv3jedi_covar_sqrt_inv_mult_ad()

subroutine fv3jedi_covariance_mod::fv3jedi_covar_sqrt_inv_mult_ad ( type(fv3jedi_covar), intent(in)  self,
real, intent(in)  xctl,
type(fv3jedi_increment), intent(inout)  xincr 
)

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

Definition at line 67 of file fv3jedi_covariance_mod.f90.

◆ fv3jedi_covar_sqrt_mult()

subroutine fv3jedi_covariance_mod::fv3jedi_covar_sqrt_mult ( type(fv3jedi_covar), intent(in)  self,
type(fv3jedi_increment), intent(inout)  xincr,
real, intent(in)  xctl 
)

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

Definition at line 80 of file fv3jedi_covariance_mod.f90.

◆ fv3jedi_covar_sqrt_mult_ad()

subroutine fv3jedi_covariance_mod::fv3jedi_covar_sqrt_mult_ad ( type(fv3jedi_covar), intent(in)  self,
type(fv3jedi_increment), intent(in)  xincr,
real, intent(inout)  xctl 
)

Multiply streamfunction by sqrt(C) - Adjoint.

Definition at line 93 of file fv3jedi_covariance_mod.f90.