SOCA
soca_bkgerrgodas_mod::soca_bkgerrgodas Type Reference

Variable transform for background error (D), GODAS version. More...

Collaboration diagram for soca_bkgerrgodas_mod::soca_bkgerrgodas:

Public Member Functions

procedure setup => soca_bkgerrgodas_setup
 Setup the static background error. More...
 
procedure mult => soca_bkgerrgodas_mult
 Apply background error: dxm = D dxa. More...
 

Public Attributes

type(soca_state), pointer bkg
 
type(soca_fieldsstd_bkgerr
 
type(soca_bkgerr_bounds_typebounds
 Bounds for bkgerrgodas. More...
 

Private Attributes

type(soca_geom), pointer, private geom
 
real(kind=kind_real), private t_dz
 For rescaling of the vertical gradient. More...
 
real(kind=kind_real), private t_efold
 E-folding scale for surf based T min. More...
 
real(kind=kind_real), private ssh_phi_ex
 latitude scale of ssh error More...
 

Related Functions

(Note that these are not member functions.)

subroutine soca_bkgerrgodas_setup (self, f_conf, bkg, geom)
 Setup the static background error. More...
 
subroutine soca_bkgerrgodas_mult (self, dxa, dxm)
 Apply background error: dxm = D dxa. More...
 
subroutine soca_bkgerrgodas_tocn (self)
 Derive T background error from vertial gradient of temperature. More...
 
subroutine soca_bkgerrgodas_ssh (self)
 Derive unbalanced SSH background error, based on latitude. More...
 
subroutine soca_bkgerrgodas_socn (self)
 Derive unbalanced S background error, based on MLD. More...
 

Detailed Description

Variable transform for background error (D), GODAS version.

Definition at line 27 of file soca_bkgerrgodas_mod.F90.

Member Function/Subroutine Documentation

◆ mult()

procedure soca_bkgerrgodas_mod::soca_bkgerrgodas::mult

Apply background error: dxm = D dxa.

See also
soca_bkgerrgodas_mult

Definition at line 44 of file soca_bkgerrgodas_mod.F90.

◆ setup()

procedure soca_bkgerrgodas_mod::soca_bkgerrgodas::setup

Setup the static background error.

See also
soca_bkgerrgodas_setup

Definition at line 41 of file soca_bkgerrgodas_mod.F90.

Friends And Related Function Documentation

◆ soca_bkgerrgodas_mult()

subroutine soca_bkgerrgodas_mult ( class(soca_bkgerrgodas), intent(in)  self,
type(soca_increment), intent(in)  dxa,
type(soca_increment), intent(inout)  dxm 
)
related

Apply background error: dxm = D dxa.

Parameters
[in]dxainput increment
[in,out]dxmoutput increment

Definition at line 120 of file soca_bkgerrgodas_mod.F90.

◆ soca_bkgerrgodas_setup()

subroutine soca_bkgerrgodas_setup ( class(soca_bkgerrgodas), intent(inout)  self,
type(fckit_configuration), intent(in)  f_conf,
type(soca_state), intent(in), target  bkg,
type(soca_geom), intent(in), target  geom 
)
related

Setup the static background error.

Parameters
[in]f_confconfiguration
[in]bkgbackground state
[in]geommodel geometry

Definition at line 57 of file soca_bkgerrgodas_mod.F90.

◆ soca_bkgerrgodas_socn()

subroutine soca_bkgerrgodas_socn ( class(soca_bkgerrgodas), intent(inout)  self)
related

Derive unbalanced S background error, based on MLD.

Definition at line 267 of file soca_bkgerrgodas_mod.F90.

◆ soca_bkgerrgodas_ssh()

subroutine soca_bkgerrgodas_ssh ( class(soca_bkgerrgodas), intent(inout)  self)
related

Derive unbalanced SSH background error, based on latitude.

Definition at line 232 of file soca_bkgerrgodas_mod.F90.

◆ soca_bkgerrgodas_tocn()

subroutine soca_bkgerrgodas_tocn ( class(soca_bkgerrgodas), intent(inout)  self)
related

Derive T background error from vertial gradient of temperature.

Definition at line 155 of file soca_bkgerrgodas_mod.F90.

Here is the call graph for this function:

Member Data Documentation

◆ bkg

type(soca_state), pointer soca_bkgerrgodas_mod::soca_bkgerrgodas::bkg

Definition at line 28 of file soca_bkgerrgodas_mod.F90.

◆ bounds

type(soca_bkgerr_bounds_type) soca_bkgerrgodas_mod::soca_bkgerrgodas::bounds

Bounds for bkgerrgodas.

Definition at line 33 of file soca_bkgerrgodas_mod.F90.

◆ geom

type(soca_geom), pointer, private soca_bkgerrgodas_mod::soca_bkgerrgodas::geom
private

Definition at line 32 of file soca_bkgerrgodas_mod.F90.

◆ ssh_phi_ex

real(kind=kind_real), private soca_bkgerrgodas_mod::soca_bkgerrgodas::ssh_phi_ex
private

latitude scale of ssh error

Definition at line 36 of file soca_bkgerrgodas_mod.F90.

◆ std_bkgerr

type(soca_fields) soca_bkgerrgodas_mod::soca_bkgerrgodas::std_bkgerr

Definition at line 29 of file soca_bkgerrgodas_mod.F90.

◆ t_dz

real(kind=kind_real), private soca_bkgerrgodas_mod::soca_bkgerrgodas::t_dz
private

For rescaling of the vertical gradient.

Definition at line 34 of file soca_bkgerrgodas_mod.F90.

◆ t_efold

real(kind=kind_real), private soca_bkgerrgodas_mod::soca_bkgerrgodas::t_efold
private

E-folding scale for surf based T min.

Definition at line 35 of file soca_bkgerrgodas_mod.F90.


The documentation for this type was generated from the following file: