SOCA
soca_bkgerrfilt_mod::soca_bkgerrfilt Type Reference

Variable transform for background error filtering. More...

Collaboration diagram for soca_bkgerrfilt_mod::soca_bkgerrfilt:

Public Member Functions

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

Public Attributes

type(soca_geom), pointer geom
 
type(soca_fieldsfilt
 

Private Attributes

real(kind=kind_real), private efold_z
 E-folding scale. More...
 
real(kind=kind_real), private scale
 Rescaling factor. More...
 
real(kind=kind_real), private ocn_depth_min
 Minimum depth. More...
 

Related Functions

(Note that these are not member functions.)

subroutine soca_bkgerrfilt_setup (self, f_conf, bkg, geom)
 Setup the static background error. More...
 
subroutine soca_bkgerrfilt_mult (self, dxa, dxm)
 Apply background error: dxm = D dxa. More...
 

Detailed Description

Variable transform for background error filtering.

Filter increments to only where the ocean is thick enough

Note
operates only on tocn, socn, and ssh

Definition at line 27 of file soca_bkgerrfilt_mod.F90.

Member Function/Subroutine Documentation

◆ mult()

procedure soca_bkgerrfilt_mod::soca_bkgerrfilt::mult

Apply background error: dxm = D dxa.

See also
soca_bkgerrfilt_mult

Definition at line 42 of file soca_bkgerrfilt_mod.F90.

◆ setup()

procedure soca_bkgerrfilt_mod::soca_bkgerrfilt::setup

Setup the static background error.

See also
soca_bkgerrfilt_setup

Definition at line 39 of file soca_bkgerrfilt_mod.F90.

Friends And Related Function Documentation

◆ soca_bkgerrfilt_mult()

subroutine soca_bkgerrfilt_mult ( class(soca_bkgerrfilt), 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 132 of file soca_bkgerrfilt_mod.F90.

◆ soca_bkgerrfilt_setup()

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

Setup the static background error.

Parameters
[in]f_confconfiguration
[in]bkgbackground state
[in]geomgeometry

Definition at line 56 of file soca_bkgerrfilt_mod.F90.

Member Data Documentation

◆ efold_z

real(kind=kind_real), private soca_bkgerrfilt_mod::soca_bkgerrfilt::efold_z
private

E-folding scale.

Definition at line 32 of file soca_bkgerrfilt_mod.F90.

◆ filt

type(soca_fields) soca_bkgerrfilt_mod::soca_bkgerrfilt::filt

Definition at line 29 of file soca_bkgerrfilt_mod.F90.

◆ geom

type(soca_geom), pointer soca_bkgerrfilt_mod::soca_bkgerrfilt::geom

Definition at line 28 of file soca_bkgerrfilt_mod.F90.

◆ ocn_depth_min

real(kind=kind_real), private soca_bkgerrfilt_mod::soca_bkgerrfilt::ocn_depth_min
private

Minimum depth.

Definition at line 34 of file soca_bkgerrfilt_mod.F90.

◆ scale

real(kind=kind_real), private soca_bkgerrfilt_mod::soca_bkgerrfilt::scale
private

Rescaling factor.

Definition at line 33 of file soca_bkgerrfilt_mod.F90.


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