MOM6
g_tracer_utils::g_tracer_get_values Interface Reference

Detailed Description

Reverse of interface g_tracer_set_values for getting the tracer member arrays in the argument value.

This means "get the values of array %field_name for tracer tracer_name and put them in argument array_out"

Definition at line 78 of file generic_tracer_utils.F90.

Private functions

subroutine g_tracer_get_4d_val (g_tracer_list, name, member, array, isd, jsd)
 Unknown. More...
 
subroutine g_tracer_get_3d_val (g_tracer_list, name, member, array, isd, jsd, ntau, positive)
 Unknown. More...
 
subroutine g_tracer_get_2d_val (g_tracer_list, name, member, array, isd, jsd)
 Unknown. More...
 
subroutine g_tracer_get_real (g_tracer_list, name, member, value)
 Unknown. More...
 
subroutine g_tracer_get_string (g_tracer_list, name, member, string)
 Unknown. More...
 

Detailed Description

Reverse of interface g_tracer_set_values for getting the tracer member arrays in the argument value.

This means "get the values of array %field_name for tracer tracer_name and put them in argument array_out"

Definition at line 78 of file generic_tracer_utils.F90.

Functions and subroutines

◆ g_tracer_get_2d_val()

subroutine g_tracer_utils::g_tracer_get_values::g_tracer_get_2d_val ( type(g_tracer_type), pointer  g_tracer_list,
character(len=*), intent(in)  name,
character(len=*), intent(in)  member,
real, dimension(isd:,jsd:), intent(out)  array,
integer, intent(in)  isd,
integer, intent(in)  jsd 
)
private

Unknown.

Parameters
[in]nameUnknown
[in]memberUnknown
g_tracer_listUnknown
[in]isdUnknown
[in]jsdUnknown
[out]arrayUnknown

Definition at line 193 of file generic_tracer_utils.F90.

194  character(len=*), intent(in) :: name !< Unknown
195  character(len=*), intent(in) :: member !< Unknown
196  type(g_tracer_type), pointer :: g_tracer_list !< Unknown
197  integer, intent(in) :: isd !< Unknown
198  integer, intent(in) :: jsd !< Unknown
199  real, dimension(isd:,jsd:), intent(out):: array !< Unknown

◆ g_tracer_get_3d_val()

subroutine g_tracer_utils::g_tracer_get_values::g_tracer_get_3d_val ( type(g_tracer_type), pointer  g_tracer_list,
character(len=*), intent(in)  name,
character(len=*), intent(in)  member,
real, dimension(isd:,jsd:,:), intent(out)  array,
integer, intent(in)  isd,
integer, intent(in)  jsd,
integer, intent(in), optional  ntau,
logical, intent(in), optional  positive 
)
private

Unknown.

Parameters
[in]nameUnknown
[in]memberUnknown
g_tracer_listUnknown
[in]isdUnknown
[in]jsdUnknown
[in]ntauUnknown
[in]positiveUnknown
[out]arrayUnknown

Definition at line 179 of file generic_tracer_utils.F90.

180  character(len=*), intent(in) :: name !< Unknown
181  character(len=*), intent(in) :: member !< Unknown
182  type(g_tracer_type), pointer :: g_tracer_list !< Unknown
183  integer, intent(in) :: isd !< Unknown
184  integer, intent(in) :: jsd !< Unknown
185  integer, optional, intent(in) :: ntau !< Unknown
186  logical, optional, intent(in) :: positive !< Unknown
187  real, dimension(isd:,jsd:,:), intent(out):: array !< Unknown
188  integer :: tau
189  character(len=fm_string_len), parameter :: sub_name = 'g_tracer_get_3D_val'

◆ g_tracer_get_4d_val()

subroutine g_tracer_utils::g_tracer_get_values::g_tracer_get_4d_val ( type(g_tracer_type), pointer  g_tracer_list,
character(len=*), intent(in)  name,
character(len=*), intent(in)  member,
real, dimension(isd:,jsd:,:,:), intent(out)  array,
integer, intent(in)  isd,
integer, intent(in)  jsd 
)
private

Unknown.

Parameters
[in]nameUnknown
[in]memberUnknown
g_tracer_listUnknown
[in]isdUnknown
[in]jsdUnknown
[out]arrayUnknown

Definition at line 169 of file generic_tracer_utils.F90.

170  character(len=*), intent(in) :: name !< Unknown
171  character(len=*), intent(in) :: member !< Unknown
172  type(g_tracer_type), pointer :: g_tracer_list !< Unknown
173  integer, intent(in) :: isd !< Unknown
174  integer, intent(in) :: jsd !< Unknown
175  real, dimension(isd:,jsd:,:,:), intent(out):: array !< Unknown

◆ g_tracer_get_real()

subroutine g_tracer_utils::g_tracer_get_values::g_tracer_get_real ( type(g_tracer_type), pointer  g_tracer_list,
character(len=*), intent(in)  name,
character(len=*), intent(in)  member,
real, intent(out)  value 
)
private

Unknown.

Parameters
[in]nameUnknown
[in]memberUnknown
g_tracer_listUnknown
[out]valueUnknown

Definition at line 203 of file generic_tracer_utils.F90.

204  character(len=*), intent(in) :: name !< Unknown
205  character(len=*), intent(in) :: member !< Unknown
206  type(g_tracer_type), pointer :: g_tracer_list !< Unknown
207  real, intent(out):: value !< Unknown

◆ g_tracer_get_string()

subroutine g_tracer_utils::g_tracer_get_values::g_tracer_get_string ( type(g_tracer_type), pointer  g_tracer_list,
character(len=*), intent(in)  name,
character(len=*), intent(in)  member,
character(len=fm_string_len), intent(out)  string 
)
private

Unknown.

Parameters
[in]nameUnknown
[in]memberUnknown
g_tracer_listUnknown
[out]stringUnknown

Definition at line 211 of file generic_tracer_utils.F90.

212  character(len=*), intent(in) :: name !< Unknown
213  character(len=*), intent(in) :: member !< Unknown
214  type(g_tracer_type), pointer :: g_tracer_list !< Unknown
215  character(len=fm_string_len), intent(out) :: string !< Unknown

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