SABER
type_bump_interface Module Reference

BUMP derived type interface. More...

Functions/Subroutines

subroutine bump_create_c (key_bump, c_comm, c_afunctionspace, c_afieldset, c_conf, c_grid)
 Create. More...
 
subroutine bump_run_drivers_c (key_bump)
 Run drivers. More...
 
subroutine bump_add_member_c (key_bump, c_afieldset, ie, iens)
 Add member into bumpens[1,2]. More...
 
subroutine bump_apply_vbal_c (key_bump, c_afieldset)
 Vertical balance application. More...
 
subroutine bump_apply_vbal_inv_c (key_bump, c_afieldset)
 Vertical balance application, inverse. More...
 
subroutine bump_apply_vbal_ad_c (key_bump, c_afieldset)
 Vertical balance application, adjoint. More...
 
subroutine bump_apply_vbal_inv_ad_c (key_bump, c_afieldset)
 Vertical balance application, inverse adjoint. More...
 
subroutine bump_apply_stddev_c (key_bump, c_afieldset)
 Standard-deviation application. More...
 
subroutine bump_apply_stddev_inv_c (key_bump, c_afieldset)
 Standard-deviation application, inverse. More...
 
subroutine bump_apply_nicas_c (key_bump, c_afieldset)
 NICAS application. More...
 
subroutine bump_get_cv_size_c (key_bump, n)
 Get control variable size. More...
 
subroutine bump_apply_nicas_sqrt_c (key_bump, cv, c_afieldset)
 NICAS square-root application. More...
 
subroutine bump_apply_nicas_sqrt_ad_c (key_bump, c_afieldset, cv)
 NICAS square-root adjoint application. More...
 
subroutine bump_randomize_c (key_bump, c_afieldset)
 NICAS randomization. More...
 
subroutine bump_get_parameter_c (key_bump, nstr, cstr, c_afieldset)
 Get a parameter. More...
 
subroutine bump_set_parameter_c (key_bump, nstr, cstr, c_afieldset)
 Set a parameter. More...
 
subroutine bump_dealloc_c (key_bump)
 Deallocation. More...
 

Detailed Description

BUMP derived type interface.

Function/Subroutine Documentation

◆ bump_add_member_c()

subroutine type_bump_interface::bump_add_member_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset,
integer(c_int), intent(in)  ie,
integer(c_int), intent(in)  iens 
)
private

Add member into bumpens[1,2].

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer
[in]ieEnsemble member index
[in]iensEnsemble index

Definition at line 88 of file type_bump_interface.F90.

◆ bump_apply_nicas_c()

subroutine type_bump_interface::bump_apply_nicas_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

NICAS application.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 265 of file type_bump_interface.F90.

◆ bump_apply_nicas_sqrt_ad_c()

subroutine type_bump_interface::bump_apply_nicas_sqrt_ad_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset,
real(c_double), dimension(:), intent(inout)  cv 
)
private

NICAS square-root adjoint application.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer
[in,out]cvControl variable

Definition at line 339 of file type_bump_interface.F90.

◆ bump_apply_nicas_sqrt_c()

subroutine type_bump_interface::bump_apply_nicas_sqrt_c ( integer(c_int), intent(in)  key_bump,
real(c_double), dimension(:), intent(in)  cv,
type(c_ptr), intent(in), value  c_afieldset 
)
private

NICAS square-root application.

Parameters
[in]key_bumpBUMP
[in]cvControl variable
[in]c_afieldsetATLAS fieldset pointer

Definition at line 313 of file type_bump_interface.F90.

◆ bump_apply_stddev_c()

subroutine type_bump_interface::bump_apply_stddev_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Standard-deviation application.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 215 of file type_bump_interface.F90.

◆ bump_apply_stddev_inv_c()

subroutine type_bump_interface::bump_apply_stddev_inv_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Standard-deviation application, inverse.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 240 of file type_bump_interface.F90.

◆ bump_apply_vbal_ad_c()

subroutine type_bump_interface::bump_apply_vbal_ad_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Vertical balance application, adjoint.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 165 of file type_bump_interface.F90.

◆ bump_apply_vbal_c()

subroutine type_bump_interface::bump_apply_vbal_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Vertical balance application.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 115 of file type_bump_interface.F90.

◆ bump_apply_vbal_inv_ad_c()

subroutine type_bump_interface::bump_apply_vbal_inv_ad_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Vertical balance application, inverse adjoint.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 190 of file type_bump_interface.F90.

◆ bump_apply_vbal_inv_c()

subroutine type_bump_interface::bump_apply_vbal_inv_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Vertical balance application, inverse.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 140 of file type_bump_interface.F90.

◆ bump_create_c()

subroutine type_bump_interface::bump_create_c ( integer(c_int), intent(inout)  key_bump,
type(c_ptr), intent(in), value  c_comm,
type(c_ptr), intent(in), value  c_afunctionspace,
type(c_ptr), intent(in), value  c_afieldset,
type(c_ptr), intent(in), value  c_conf,
type(c_ptr), intent(in), value  c_grid 
)
private

Create.

Parameters
[in,out]key_bumpBUMP
[in]c_commFCKIT MPI communicator wrapper
[in]c_afunctionspaceATLAS function space
[in]c_afieldsetATLAS fieldset containing geometry elements
[in]c_confFCKIT configuration
[in]c_gridFCKIT grid configuration

Definition at line 27 of file type_bump_interface.F90.

◆ bump_dealloc_c()

subroutine type_bump_interface::bump_dealloc_c ( integer(c_int), intent(inout)  key_bump)
private

Deallocation.

Parameters
[in,out]key_bumpBUMP

Definition at line 456 of file type_bump_interface.F90.

◆ bump_get_cv_size_c()

subroutine type_bump_interface::bump_get_cv_size_c ( integer(c_int), intent(in)  key_bump,
integer(c_int), intent(out)  n 
)
private

Get control variable size.

Parameters
[in]key_bumpBUMP
[out]nControl variable size

Definition at line 290 of file type_bump_interface.F90.

◆ bump_get_parameter_c()

subroutine type_bump_interface::bump_get_parameter_c ( integer(c_int), intent(in)  key_bump,
integer(c_int), intent(in)  nstr,
character(kind=c_char), dimension(nstr), intent(in)  cstr,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Get a parameter.

Parameters
[in]key_bumpBUMP
[in]nstrParameter name size
[in]cstrParameter name
[in]c_afieldsetATLAS fieldset pointer

Definition at line 390 of file type_bump_interface.F90.

◆ bump_randomize_c()

subroutine type_bump_interface::bump_randomize_c ( integer(c_int), intent(in)  key_bump,
type(c_ptr), intent(in), value  c_afieldset 
)
private

NICAS randomization.

Parameters
[in]key_bumpBUMP
[in]c_afieldsetATLAS fieldset pointer

Definition at line 365 of file type_bump_interface.F90.

◆ bump_run_drivers_c()

subroutine type_bump_interface::bump_run_drivers_c ( integer(c_int), intent(in)  key_bump)
private

Run drivers.

Parameters
[in]key_bumpBUMP

Definition at line 66 of file type_bump_interface.F90.

◆ bump_set_parameter_c()

subroutine type_bump_interface::bump_set_parameter_c ( integer(c_int), intent(in)  key_bump,
integer(c_int), intent(in)  nstr,
character(kind=c_char), dimension(nstr), intent(in)  cstr,
type(c_ptr), intent(in), value  c_afieldset 
)
private

Set a parameter.

Parameters
[in]key_bumpBUMP
[in]nstrParameter name size
[in]cstrParameter name
[in]c_afieldsetATLAS fieldset pointer

Definition at line 423 of file type_bump_interface.F90.