SOCA
Public Member Functions | Public Attributes | Related Functions | List of all members
soca_horizfilt_mod::soca_horizfilt Type Reference

Variable transform: horizontal filtering. More...

Collaboration diagram for soca_horizfilt_mod::soca_horizfilt:
Collaboration graph
[legend]

Public Member Functions

procedure setup => soca_horizfilt_setup
 Setup for the horizfilt operator. More...
 
procedure delete => soca_horizfilt_delete
 Delete horizfilt. More...
 
procedure mult => soca_horizfilt_mult
 Forward filtering. More...
 
procedure multad => soca_horizfilt_multad
 Backward filtering. More...
 

Public Attributes

type(oops_variables) vars
 Apply filtering to vars. More...
 
real(kind=kind_real), dimension(:,:,:,:), allocatable wgh
 Filtering weight. More...
 
real(kind=kind_real) scale_flow
 Used with "flow" filter, sea surface height decorrelation scale. More...
 
real(kind=kind_real) scale_dist
 
real(kind=kind_real) niter
 number of iterations of filter to perform More...
 
indices of compute domain
integer isc
 
integer iec
 
integer jsc
 
integer jec
 
indices of data domain
integer isd
 
integer ied
 
integer jsd
 
integer jed
 

Related Functions

(Note that these are not member functions.)

subroutine soca_horizfilt_setup (self, f_conf, geom, traj, vars)
 Setup for the horizfilt operator. More...
 
subroutine soca_horizfilt_delete (self)
 Delete horizfilt. More...
 
subroutine soca_horizfilt_mult (self, dxin, dxout, geom)
 Forward filtering. More...
 
subroutine soca_horizfilt_multad (self, dxin, dxout, geom)
 Backward filtering. More...
 
subroutine soca_filt2d (self, dxin, dxout, geom)
 Forward filtering for 2D array. More...
 
subroutine soca_filt2d_ad (self, dxin, dxout, geom)
 Backward filtering for 2D array. More...
 

Detailed Description

Variable transform: horizontal filtering.

Definition at line 26 of file soca_horizfilt_mod.F90.

Member Function/Subroutine Documentation

◆ delete()

procedure soca_horizfilt_mod::soca_horizfilt::delete

Delete horizfilt.

See also
soca_horizfilt_delete

Definition at line 48 of file soca_horizfilt_mod.F90.

◆ mult()

procedure soca_horizfilt_mod::soca_horizfilt::mult

Forward filtering.

See also
soca_horizfilt_mult

Definition at line 51 of file soca_horizfilt_mod.F90.

◆ multad()

procedure soca_horizfilt_mod::soca_horizfilt::multad

Backward filtering.

See also
soca_horizfilt_multad

Definition at line 54 of file soca_horizfilt_mod.F90.

◆ setup()

procedure soca_horizfilt_mod::soca_horizfilt::setup

Setup for the horizfilt operator.

See also
soca_horizfilt_setup

Definition at line 45 of file soca_horizfilt_mod.F90.

Friends And Related Function Documentation

◆ soca_filt2d()

subroutine soca_filt2d ( class(soca_horizfilt), intent(in)  self,
real(kind=kind_real), dimension(:,:), intent(in), allocatable  dxin,
real(kind=kind_real), dimension(:,:), intent(inout), allocatable  dxout,
type(soca_geom), intent(in)  geom 
)
related

Forward filtering for 2D array.

used by soca_horizfilt_mod::soca_horizfilt::mult()

Definition at line 222 of file soca_horizfilt_mod.F90.

◆ soca_filt2d_ad()

subroutine soca_filt2d_ad ( class(soca_horizfilt), intent(in)  self,
real(kind=kind_real), dimension(:,:), intent(in), allocatable  dxin,
real(kind=kind_real), dimension(:,:), intent(inout), allocatable  dxout,
type(soca_geom), intent(in)  geom 
)
related

Backward filtering for 2D array.

used by soca_horizfilt_mod::soca_horizfilt::multad()

Definition at line 271 of file soca_horizfilt_mod.F90.

◆ soca_horizfilt_delete()

subroutine soca_horizfilt_delete ( class(soca_horizfilt), intent(inout)  self)
related

Delete horizfilt.

Parameters
[in,out]selfThe horizfilt structure

Definition at line 146 of file soca_horizfilt_mod.F90.

◆ soca_horizfilt_mult()

subroutine soca_horizfilt_mult ( class(soca_horizfilt), intent(inout)  self,
type(soca_increment), intent(in)  dxin,
type(soca_increment), intent(inout)  dxout,
type(soca_geom), intent(in)  geom 
)
related

Forward filtering.

Parameters
[in,out]selfThe horizfilt structure
[in]dxinInput: Increment
[in,out]dxoutOutput: filtered Increment

Definition at line 158 of file soca_horizfilt_mod.F90.

◆ soca_horizfilt_multad()

subroutine soca_horizfilt_multad ( class(soca_horizfilt), intent(inout)  self,
type(soca_increment), intent(in)  dxin,
type(soca_increment), intent(inout)  dxout,
type(soca_geom), intent(in)  geom 
)
related

Backward filtering.

Parameters
[in,out]selfThe horizfilt structure
[in]dxinInput:
[in,out]dxoutOutput:

Definition at line 190 of file soca_horizfilt_mod.F90.

◆ soca_horizfilt_setup()

subroutine soca_horizfilt_setup ( class(soca_horizfilt), intent(inout)  self,
type(fckit_configuration), intent(in)  f_conf,
type(soca_geom), intent(in)  geom,
type(soca_state), intent(in)  traj,
type(oops_variables), intent(in)  vars 
)
related

Setup for the horizfilt operator.

Parameters
[in,out]selfThe horizfilt structure
[in]f_confThe configuration
[in]geomGeometry
[in]trajTrajectory
[in]varsList of variables

Definition at line 67 of file soca_horizfilt_mod.F90.

Member Data Documentation

◆ iec

integer soca_horizfilt_mod::soca_horizfilt::iec

Definition at line 34 of file soca_horizfilt_mod.F90.

◆ ied

integer soca_horizfilt_mod::soca_horizfilt::ied

Definition at line 39 of file soca_horizfilt_mod.F90.

◆ isc

integer soca_horizfilt_mod::soca_horizfilt::isc

Definition at line 34 of file soca_horizfilt_mod.F90.

◆ isd

integer soca_horizfilt_mod::soca_horizfilt::isd

Definition at line 39 of file soca_horizfilt_mod.F90.

◆ jec

integer soca_horizfilt_mod::soca_horizfilt::jec

Definition at line 34 of file soca_horizfilt_mod.F90.

◆ jed

integer soca_horizfilt_mod::soca_horizfilt::jed

Definition at line 39 of file soca_horizfilt_mod.F90.

◆ jsc

integer soca_horizfilt_mod::soca_horizfilt::jsc

Definition at line 34 of file soca_horizfilt_mod.F90.

◆ jsd

integer soca_horizfilt_mod::soca_horizfilt::jsd

Definition at line 39 of file soca_horizfilt_mod.F90.

◆ niter

real(kind=kind_real) soca_horizfilt_mod::soca_horizfilt::niter

number of iterations of filter to perform

Definition at line 31 of file soca_horizfilt_mod.F90.

◆ scale_dist

real(kind=kind_real) soca_horizfilt_mod::soca_horizfilt::scale_dist

Definition at line 30 of file soca_horizfilt_mod.F90.

◆ scale_flow

real(kind=kind_real) soca_horizfilt_mod::soca_horizfilt::scale_flow

Used with "flow" filter, sea surface height decorrelation scale.

Definition at line 29 of file soca_horizfilt_mod.F90.

◆ vars

type(oops_variables) soca_horizfilt_mod::soca_horizfilt::vars

Apply filtering to vars.

Definition at line 27 of file soca_horizfilt_mod.F90.

◆ wgh

real(kind=kind_real), dimension(:,:,:,:), allocatable soca_horizfilt_mod::soca_horizfilt::wgh

Filtering weight.

Definition at line 28 of file soca_horizfilt_mod.F90.

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