FV3 Bundle
qg_goms_mod Module Reference

Fortran module handling interpolated (to obs locations) model variables. More...

Data Types

type  qg_goms
 Fortran derived type to hold interpolated fields required by the obs operators. More...
 

Functions/Subroutines

subroutine c_qg_gom_setup (c_key_self, c_key_locs, c_vars)
 Linked list implementation. More...
 
subroutine c_qg_gom_create (c_key_self)
 
subroutine, public gom_setup (self, vars, kobs)
 
subroutine c_qg_gom_delete (c_key_self)
 
subroutine c_qg_gom_assign (c_key_self, c_key_other)
 
subroutine c_qg_gom_zero (c_key_self)
 
subroutine c_qg_gom_abs (c_key_self)
 
subroutine c_qg_gom_random (c_key_self)
 
subroutine c_qg_gom_mult (c_key_self, zz)
 
subroutine c_qg_gom_add (c_key_self, c_key_other)
 
subroutine c_qg_gom_diff (c_key_self, c_key_other)
 
subroutine c_qg_gom_divide (c_key_self, c_key_other)
 QG GeoVaLs division Operator. More...
 
subroutine c_qg_gom_rms (c_key_self, rms)
 
subroutine c_qg_gom_dotprod (c_key_self, c_key_other, prod)
 
subroutine c_qg_gom_minmaxavg (c_key_self, kobs, pmin, pmax, prms)
 
subroutine c_qg_gom_maxloc (c_key_self, mxval, iloc, ivar)
 
subroutine qg_gom_read_file_c (c_key_self, c_conf)
 
subroutine qg_gom_write_file_c (c_key_self, c_conf)
 
subroutine qg_gom_analytic_init_c (c_key_self, c_key_locs, c_conf)
 Initialize a QG GeoVaLs object based on an analytic state. More...
 

Variables

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

Detailed Description

Fortran module handling interpolated (to obs locations) model variables.

Function/Subroutine Documentation

◆ c_qg_gom_abs()

subroutine qg_goms_mod::c_qg_gom_abs ( integer(c_int), intent(in)  c_key_self)
private

Definition at line 173 of file qg_goms_mod.F90.

◆ c_qg_gom_add()

subroutine qg_goms_mod::c_qg_gom_add ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_other 
)
private

Definition at line 212 of file qg_goms_mod.F90.

◆ c_qg_gom_assign()

subroutine qg_goms_mod::c_qg_gom_assign ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_other 
)
private

Definition at line 133 of file qg_goms_mod.F90.

◆ c_qg_gom_create()

subroutine qg_goms_mod::c_qg_gom_create ( integer(c_int), intent(inout)  c_key_self)
private

Definition at line 75 of file qg_goms_mod.F90.

◆ c_qg_gom_delete()

subroutine qg_goms_mod::c_qg_gom_delete ( integer(c_int), intent(inout)  c_key_self)
private

Definition at line 114 of file qg_goms_mod.F90.

◆ c_qg_gom_diff()

subroutine qg_goms_mod::c_qg_gom_diff ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_other 
)
private

Definition at line 232 of file qg_goms_mod.F90.

◆ c_qg_gom_divide()

subroutine qg_goms_mod::c_qg_gom_divide ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_other 
)
private

QG GeoVaLs division Operator.

Definition at line 253 of file qg_goms_mod.F90.

◆ c_qg_gom_dotprod()

subroutine qg_goms_mod::c_qg_gom_dotprod ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_other,
real(c_double), intent(inout)  prod 
)
private

Definition at line 309 of file qg_goms_mod.F90.

◆ c_qg_gom_maxloc()

subroutine qg_goms_mod::c_qg_gom_maxloc ( integer(c_int), intent(in)  c_key_self,
real(c_double), intent(inout)  mxval,
integer(c_int), intent(inout)  iloc,
integer(c_int), intent(inout)  ivar 
)
private
Parameters
[in]c_key_selfkey to GeoVals object
[in,out]mxvalmaximum value
[in,out]iloclocation of maximum value
[in,out]ivarvariable with maximum value

Definition at line 347 of file qg_goms_mod.F90.

◆ c_qg_gom_minmaxavg()

subroutine qg_goms_mod::c_qg_gom_minmaxavg ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(inout)  kobs,
real(c_double), intent(inout)  pmin,
real(c_double), intent(inout)  pmax,
real(c_double), intent(inout)  prms 
)
private

Definition at line 329 of file qg_goms_mod.F90.

◆ c_qg_gom_mult()

subroutine qg_goms_mod::c_qg_gom_mult ( integer(c_int), intent(in)  c_key_self,
real(c_double), intent(in)  zz 
)

Definition at line 194 of file qg_goms_mod.F90.

◆ c_qg_gom_random()

subroutine qg_goms_mod::c_qg_gom_random ( integer(c_int), intent(in)  c_key_self)
private

Definition at line 183 of file qg_goms_mod.F90.

◆ c_qg_gom_rms()

subroutine qg_goms_mod::c_qg_gom_rms ( integer(c_int), intent(in)  c_key_self,
real(c_double), intent(inout)  rms 
)
private

Definition at line 287 of file qg_goms_mod.F90.

◆ c_qg_gom_setup()

subroutine qg_goms_mod::c_qg_gom_setup ( integer(c_int), intent(inout)  c_key_self,
integer(c_int), intent(inout)  c_key_locs,
integer(c_int), dimension(*), intent(in)  c_vars 
)
private

Linked list implementation.

Parameters
[in]c_varsList of variables

Definition at line 53 of file qg_goms_mod.F90.

Here is the call graph for this function:

◆ c_qg_gom_zero()

subroutine qg_goms_mod::c_qg_gom_zero ( integer(c_int), intent(in)  c_key_self)
private

Definition at line 163 of file qg_goms_mod.F90.

◆ gom_setup()

subroutine, public qg_goms_mod::gom_setup ( type(qg_goms), intent(inout)  self,
type(qg_vars), intent(in)  vars,
integer, dimension(:), intent(in)  kobs 
)

Definition at line 90 of file qg_goms_mod.F90.

Here is the caller graph for this function:

◆ qg_gom_analytic_init_c()

subroutine qg_goms_mod::qg_gom_analytic_init_c ( integer(c_int), intent(in)  c_key_self,
integer(c_int), intent(in)  c_key_locs,
type(c_ptr), intent(in)  c_conf 
)

Initialize a QG GeoVaLs object based on an analytic state.

qg_gom_analytic_init_c() creates a QG GeoVaLs object and fills in values based on one of several analytic solutions. For a description of the solutions that are currently implemented, see the analytic_init() routine in qg_fields.F90. This initialization is intended to be used with the TestStateInterpolation() test.

Date
April, 2018: Created by M. Miesch (JCSDA)
See also
qg::GomQG analytic_init()
Parameters
[in]c_key_selfkey to GeoVaLs object we are creating
[in]c_key_locskey to the F90 Locations object
[in]c_conf"StateGenerate" configuration

Definition at line 473 of file qg_goms_mod.F90.

Here is the call graph for this function:

◆ qg_gom_read_file_c()

subroutine qg_goms_mod::qg_gom_read_file_c ( integer(c_int), intent(in)  c_key_self,
type(c_ptr), intent(in)  c_conf 
)
private

Definition at line 369 of file qg_goms_mod.F90.

◆ qg_gom_write_file_c()

subroutine qg_goms_mod::qg_gom_write_file_c ( integer(c_int), intent(in)  c_key_self,
type(c_ptr), intent(in)  c_conf 
)

Definition at line 418 of file qg_goms_mod.F90.

Variable Documentation

◆ qg_goms_registry

type(registry_t), public qg_goms_mod::qg_goms_registry

Linked list interface - defines registry_t type.

Global registry

Definition at line 42 of file qg_goms_mod.F90.