FV3-JEDI
fv3jedi_gfs_interface_mod.F90
Go to the documentation of this file.
1 ! (C) Copyright 2017-2018 UCAR
2 !
3 ! This software is licensed under the terms of the Apache Licence Version 2.0
4 ! which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
5 
7 
9 use datetime_mod
10 use duration_mod
11 use iso_c_binding
12 
18 
19 implicit none
20 private
21 
22 public :: fv3jedi_gfs_registry
23 
24 !> Linked list interface
25 #define LISTED_TYPE gfs_model
26 #include "oops/util/linkedList_i.f"
27 type(registry_t) :: fv3jedi_gfs_registry
28 
29 ! ------------------------------------------------------------------------------
30 
31 contains
32 
33 ! ------------------------------------------------------------------------------
34 
35 !> Linked list implementation
36 #include "oops/util/linkedList_c.f"
37 
38 ! ------------------------------------------------------------------------------
39 
40 subroutine c_fv3jedi_gfs_create(c_conf, c_key_geom, c_key_self) bind (c,name='fv3jedi_gfs_create_f90')
41 
42 implicit none
43 integer(c_int), intent(inout) :: c_key_self !< Key to model data
44 integer(c_int), intent(in) :: c_key_geom !< Geometry
45 type(c_ptr), intent(in) :: c_conf !< pointer to object of class Config
46 
47 type(gfs_model), pointer :: self
48 type(fv3jedi_geom), pointer :: geom
49 
50 call fv3jedi_geom_registry%get(c_key_geom, geom)
51 call fv3jedi_gfs_registry%init()
52 call fv3jedi_gfs_registry%add(c_key_self)
53 call fv3jedi_gfs_registry%get(c_key_self, self)
54 
55 call gfs_create(self, geom, c_conf)
56 
57 end subroutine c_fv3jedi_gfs_create
58 
59 ! ------------------------------------------------------------------------------
60 
61 subroutine c_fv3jedi_gfs_delete(c_key_self) bind (c,name='fv3jedi_gfs_delete_f90')
62 
63 implicit none
64 integer(c_int), intent(inout) :: c_key_self
65 type(gfs_model), pointer :: self
66 
67 call fv3jedi_gfs_registry%get(c_key_self, self)
68 
69 call gfs_delete(self)
70 
71 call fv3jedi_gfs_registry%remove(c_key_self)
72 
73 end subroutine c_fv3jedi_gfs_delete
74 
75 ! ------------------------------------------------------------------------------
76 
77 subroutine c_fv3jedi_gfs_initialize(c_key_self, c_key_state) bind(c,name='fv3jedi_gfs_initialize_f90')
78 
79 implicit none
80 integer(c_int), intent(in) :: c_key_self !< Model
81 integer(c_int), intent(in) :: c_key_state !< Model state
82 
83 type(gfs_model), pointer :: self
84 type(fv3jedi_state), pointer :: state
85 
86 call fv3jedi_state_registry%get(c_key_state,state)
87 call fv3jedi_gfs_registry%get(c_key_self, self)
88 
89 call gfs_initialize(self, state)
90 
91 end subroutine c_fv3jedi_gfs_initialize
92 
93 ! ------------------------------------------------------------------------------
94 
95 subroutine c_fv3jedi_gfs_step(c_key_self, c_key_state, c_dt) bind(c,name='fv3jedi_gfs_step_f90')
96 
97 implicit none
98 integer(c_int), intent(in) :: c_key_self !< Model
99 integer(c_int), intent(in) :: c_key_state !< Model state
100 type(c_ptr), intent(inout) :: c_dt !< DateTime
101 
102 type(gfs_model), pointer :: self
103 type(fv3jedi_state), pointer :: state
104 
105 type(datetime) :: fdate
106 
107 call fv3jedi_gfs_registry%get(c_key_self, self)
108 call fv3jedi_state_registry%get(c_key_state,state)
109 
110 call c_f_datetime(c_dt, fdate)
111 
112 call gfs_step(self, state, fdate)
113 
114 end subroutine c_fv3jedi_gfs_step
115 
116 ! ------------------------------------------------------------------------------
117 
118 subroutine c_fv3jedi_gfs_finalize(c_key_self, c_key_state) bind(c,name='fv3jedi_gfs_finalize_f90')
119 
120 implicit none
121 integer(c_int), intent(in) :: c_key_self !< Model
122 integer(c_int), intent(in) :: c_key_state !< Model state
123 
124 type(gfs_model), pointer :: self
125 type(fv3jedi_state), pointer :: state
126 
127 call fv3jedi_state_registry%get(c_key_state,state)
128 call fv3jedi_gfs_registry%get(c_key_self, self)
129 
130 call gfs_finalize(self, state)
131 
132 end subroutine c_fv3jedi_gfs_finalize
133 
134 ! ------------------------------------------------------------------------------
135 
136 end module fv3jedi_gfs_interface_mod
fv3jedi_gfs_mod::gfs_model
Fortran derived type to hold model definition.
Definition: fv3jedi_gfs_mod.f90:35
fv3jedi_state_mod::fv3jedi_state
Fortran derived type to hold FV3JEDI state.
Definition: fv3jedi_state_mod.F90:30
fv3jedi_gfs_interface_mod::c_fv3jedi_gfs_create
subroutine c_fv3jedi_gfs_create(c_conf, c_key_geom, c_key_self)
Linked list implementation.
Definition: fv3jedi_gfs_interface_mod.F90:41
fv3jedi_gfs_interface_mod::c_fv3jedi_gfs_step
subroutine c_fv3jedi_gfs_step(c_key_self, c_key_state, c_dt)
Definition: fv3jedi_gfs_interface_mod.F90:96
fv3jedi_state_interface_mod
Definition: fv3jedi_state_interface_mod.F90:8
fv3jedi_state_mod
Definition: fv3jedi_state_mod.F90:6
fv3jedi_geom_interface_mod::fv3jedi_geom_registry
type(registry_t), public fv3jedi_geom_registry
Linked list interface - defines registry_t type.
Definition: fv3jedi_geom_interface_mod.F90:34
fv3jedi_state_interface_mod::fv3jedi_state_registry
type(registry_t), public fv3jedi_state_registry
Linked list interface - defines registry_t type.
Definition: fv3jedi_state_interface_mod.F90:40
fv3jedi_geom_mod
Fortran module handling geometry for the FV3 model.
Definition: fv3jedi_geom_mod.f90:8
fv3jedi_gfs_interface_mod
Definition: fv3jedi_gfs_interface_mod.F90:6
fv3jedi_gfs_mod::gfs_delete
subroutine, public gfs_delete(self)
Definition: fv3jedi_gfs_mod.f90:57
fv3jedi_geom_mod::fv3jedi_geom
Fortran derived type to hold geometry data for the FV3JEDI model.
Definition: fv3jedi_geom_mod.f90:46
fv3jedi_gfs_interface_mod::c_fv3jedi_gfs_initialize
subroutine c_fv3jedi_gfs_initialize(c_key_self, c_key_state)
Definition: fv3jedi_gfs_interface_mod.F90:78
fv3jedi_gfs_mod::gfs_step
subroutine, public gfs_step(self, state, vdate)
Definition: fv3jedi_gfs_mod.f90:76
fv3jedi_gfs_mod::gfs_finalize
subroutine, public gfs_finalize(self, state)
Definition: fv3jedi_gfs_mod.f90:93
fv3jedi_gfs_interface_mod::fv3jedi_gfs_registry
type(registry_t), public fv3jedi_gfs_registry
Linked list interface.
Definition: fv3jedi_gfs_interface_mod.F90:27
fv3jedi_gfs_interface_mod::c_fv3jedi_gfs_delete
subroutine c_fv3jedi_gfs_delete(c_key_self)
Definition: fv3jedi_gfs_interface_mod.F90:62
fv3jedi_geom_interface_mod
Fortran module handling geometry for the FV3 model.
Definition: fv3jedi_geom_interface_mod.F90:8
fv3jedi_gfs_mod::gfs_create
subroutine, public gfs_create(self, geom, c_conf)
Definition: fv3jedi_gfs_mod.f90:46
fv3jedi_gfs_interface_mod::c_fv3jedi_gfs_finalize
subroutine c_fv3jedi_gfs_finalize(c_key_self, c_key_state)
Definition: fv3jedi_gfs_interface_mod.F90:119
fv3jedi_kinds_mod
Definition: fv3jedi_kinds_mod.f90:6
fv3jedi_gfs_mod
Definition: fv3jedi_gfs_mod.f90:6
fv3jedi_gfs_mod::gfs_initialize
subroutine, public gfs_initialize(self, state)
Definition: fv3jedi_gfs_mod.f90:66