FV3 Bundle
qg_bstddev_mod Module Reference

Structure holding configuration variables for the 3d error std dev matrices of the QG analysis. More...

Data Types

type  qg_3d_bstddev_config
 Fortran derived type to hold configuration data for the QG background/model std dev. More...
 

Functions/Subroutines

subroutine qg_3d_bstddev_setup (c_model, config)
 Linked list implementation. More...
 
subroutine qg_3d_bstddev_delete (self)
 Delete for the QG model's 3d error std dev matrices. More...
 
subroutine qg_3d_bstddev_inv_mult (xin, xout, config)
 Multiply by inverse of std dev matrix. More...
 
subroutine qg_3d_bstddev_mult (xin, xout, config)
 Multiply by std dev matrix. More...
 

Variables

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

Detailed Description

Structure holding configuration variables for the 3d error std dev matrices of the QG analysis.

Function/Subroutine Documentation

◆ qg_3d_bstddev_delete()

subroutine qg_bstddev_mod::qg_3d_bstddev_delete ( type(qg_3d_bstddev_config self)

Delete for the QG model's 3d error std dev matrices.

Definition at line 68 of file qg_bstddev_mod.F90.

Here is the caller graph for this function:

◆ qg_3d_bstddev_inv_mult()

subroutine qg_bstddev_mod::qg_3d_bstddev_inv_mult ( type(qg_field), intent(in)  xin,
type(qg_field), intent(inout)  xout,
type(qg_3d_bstddev_config), intent(in)  config 
)

Multiply by inverse of std dev matrix.

Parameters
[in]configbstddev config structure

Definition at line 78 of file qg_bstddev_mod.F90.

Here is the caller graph for this function:

◆ qg_3d_bstddev_mult()

subroutine qg_bstddev_mod::qg_3d_bstddev_mult ( type(qg_field), intent(in)  xin,
type(qg_field), intent(inout)  xout,
type(qg_3d_bstddev_config), intent(in)  config 
)

Multiply by std dev matrix.

Parameters
[in]configbstddev config structure

Definition at line 108 of file qg_bstddev_mod.F90.

Here is the caller graph for this function:

◆ qg_3d_bstddev_setup()

subroutine qg_bstddev_mod::qg_3d_bstddev_setup ( type(c_ptr), intent(in)  c_model,
type(qg_3d_bstddev_config), intent(inout)  config 
)

Linked list implementation.

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

Parameters
[in]c_modelThe configuration
[in,out]configThe std dev structure

Definition at line 46 of file qg_bstddev_mod.F90.

Here is the caller graph for this function:

Variable Documentation

◆ qg_3d_bstddev_registry

type(registry_t) qg_bstddev_mod::qg_3d_bstddev_registry

Linked list interface - defines registry_t type.

Global registry

Definition at line 28 of file qg_bstddev_mod.F90.