fms_yaml_output.F90

!***********************************************************************
!*                             Apache License 2.0
!*
!* This file is part of the GFDL Flexible Modeling System (FMS).
!*
!* Licensed under the Apache License, Version 2.0 (the "License");
!* you may not use this file except in compliance with the License.
!* You may obtain a copy of the License at
!*
!*     http://www.apache.org/licenses/LICENSE-2.0
!*
!* FMS is distributed in the hope that it will be useful, but WITHOUT
!* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied;
!* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
!* PARTICULAR PURPOSE. See the License for the specific language
!* governing permissions and limitations under the License.
!***********************************************************************
!> @defgroup fms_yaml_output_mod fms_yaml_output_mod
!> @ingroup parser
!> @author Tom Robinson
!> @description Writes a 3 tiered yaml where the first and second tier can have 1 key that has an
!! array of values.  This is usefule for writing a diag_output.yaml Here is an example:
!! \verbatim
!! ---
!! basedate: 0 0 0 0 0 0 0
!! experiment: c192L65_exp
!! files:
!! - name: atmos_daily
!!   freq: days
!!   vars:
!!   - name: temp
!!     units: K
!!   - name: P
!!     longname: pressure
!!   - name: wind
!!     units: m/s
!!     longname: wind velocity magnitude
!! - name: atmos_monthly
!!   freq: months
!!   vars:
!!   - name: temp
!!     units: K
!! ...
!! \endverbatim
!! In this example, basedate, experiment, and files are the level 1 (top level) keys.  files is the
!! level2key in the keys struct.  The array of structs for the files with name, freq has a size of 2, and
!! vars is the level2key.  The key3 and var3 arrays should have a size of 4, and a3each=(\3,1\‍)
!! corresponding to the number of elements in each array within the yaml.
 
!> @file
!> @brief File for @ref fms_yaml_output_mod
 
!> @addtogroup fms_yaml_output_mod
!> @{
module fms_yaml_output_mod
#ifdef use_yaml
 
use iso_c_binding
use fms_string_utils_mod, only: fms_f2c_string
implicit none
 
private
 
public :: fmsyamloutkeys_type, fmsyamloutvalues_type
public :: write_yaml_from_struct_3
public :: yaml_out_add_level2key
public :: string_len_parameter
public :: initialize_key_struct, initialize_val_struct
 
integer, parameter :: string_len_parameter = 255 !< Max number of characters in the key and value strings.
                                                 !! Must match whats in yaml_output_functions.c
integer, parameter :: lvl2_key_parameter = 8     !< Max number of strings to be stored in lvl2keys
                                                 !! Must match whats in yaml_output_functions.c
!> Keys for the output yaml on a given level corresponding to the struct in yaml_output_functions.c
!! Should be set using the fms_f2c_string routine to get properly formatted c style strings
!! level2keys should be set with  add_level2key()
type, bind(c) :: fmsYamlOutKeys_type
        character (c_char) :: key1 (string_len_parameter)
        character (c_char) :: key2 (string_len_parameter)
        character (c_char) :: key3 (string_len_parameter)
        character (c_char) :: key4 (string_len_parameter)
        character (c_char) :: key5 (string_len_parameter)
        character (c_char) :: key6 (string_len_parameter)
        character (c_char) :: key7 (string_len_parameter)
        character (c_char) :: key8 (string_len_parameter)
        character (c_char) :: key9 (string_len_parameter)
        character (c_char) :: key10 (string_len_parameter)
        character (c_char) :: key11 (string_len_parameter)
        character (c_char) :: key12 (string_len_parameter)
        character (c_char) :: key13 (string_len_parameter)
        character (c_char) :: key14 (string_len_parameter)
        character (c_char) :: key15 (string_len_parameter)
        character (c_char) :: key16 (string_len_parameter)
        character (c_char) :: level2key (string_len_parameter * lvl2_key_parameter)
        integer(c_int)     :: level2key_offset
end type fmsyamloutkeys_type
!> Values for the output yaml on a given level corresponding to the struct in yaml_output_functions.c
type, bind(c) :: fmsYamlOutValues_type
        character (c_char) :: val1 (string_len_parameter)
        character (c_char) :: val2 (string_len_parameter)
        character (c_char) :: val3 (string_len_parameter)
        character (c_char) :: val4 (string_len_parameter)
        character (c_char) :: val5 (string_len_parameter)
        character (c_char) :: val6 (string_len_parameter)
        character (c_char) :: val7 (string_len_parameter)
        character (c_char) :: val8 (string_len_parameter)
        character (c_char) :: val9 (string_len_parameter)
        character (c_char) :: val10 (string_len_parameter)
        character (c_char) :: val11 (string_len_parameter)
        character (c_char) :: val12 (string_len_parameter)
        character (c_char) :: val13 (string_len_parameter)
        character (c_char) :: val14 (string_len_parameter)
        character (c_char) :: val15 (string_len_parameter)
        character (c_char) :: val16 (string_len_parameter)
end type fmsyamloutvalues_type
 
 
interface
subroutine write_yaml_from_struct_3 (yamlname, a1size, keys, vals, a2size, key2, val2, a3size, a3each,&
                       key3, val3, lvl2keyeach) bind(C, name="write_yaml_from_struct_3")
use iso_c_binding
import fmsyamloutkeys_type, fmsyamloutvalues_type, lvl2_key_parameter
character (c_char) :: yamlname !< The output yaml file name
integer (c_int), value :: a1size !< The size of the first yaml array
type (fmsYamlOutKeys_type) :: keys(a1size) !< Top level yaml keys
type (fmsYamlOutValues_type) :: vals(a1size) !< Values corresponding to keys
integer (c_int), value :: a2size !< The size of the second yaml array
type (fmsYamlOutKeys_type) :: key2(a2size) !< Second level keys
type (fmsYamlOutValues_type) :: val2(a2size) !< Values corresponding to key2
integer (c_int), value :: a3size !< The size of the third yaml array
integer (c_int) :: a3each (a2size) !< Array that has the number of elements for each level 2 key's
                                   !! third level elements. If using multiple lvl2keys, a value must be
                                   !! present for each key.
type (fmsYamlOutKeys_type) :: key3(a3size) !< Third level keys
type (fmsYamlOutValues_type) :: val3(a3size) !< Values corresponding to keys2
integer (c_int)        :: lvl2keyeach(lvl2_key_parameter) !< amount of key2 'blocks' to print per level2key in keys
end subroutine write_yaml_from_struct_3
!> Adds a level 2 key (key that starts new tabbed section) to the list.
!! @ref yaml_out_add_level2key (wrapper routine) should be used instead.
subroutine yaml_out_add_level2key_c(key_length, key_name, keytype) bind(C, name="add_level2key")
  use iso_c_binding
  import fmsyamloutkeys_type
  character(c_char), intent(in) :: key_name !< name of level 2 key (starts a new tabbed section) to add to list
  integer(c_int), value    :: key_length !< length of key_name
  type(fmsyamloutkeys_type), intent(inout) :: keytype !< struct of keys to output
end subroutine
end interface
 
contains
 
!> Adds a level 2 key (key that starts new tabbed section) to the list.
!! Will print level 2 keys in the order added. See write_yaml_from_struct_3 for more details.
!! This routine is a wrapper for @ref yaml_out_add_level2key_c .
subroutine yaml_out_add_level2key(key_name, keytype)
  character(len=*) :: key_name
  type(fmsyamloutkeys_type), intent(inout) :: keytype
  call yaml_out_add_level2key_c(len_trim(key_name), key_name, keytype )
end subroutine
 
!! Initialize one instance of the fmsYamlOutKeys_type structure.
subroutine initialize_key_struct( yk )
  type (fmsyamloutkeys_type), intent(inout) :: yk !< Instance of the stucture
  call fms_f2c_string (yk%key1,"")
  call fms_f2c_string (yk%key2,"")
  call fms_f2c_string (yk%key3,"")
  call fms_f2c_string (yk%key4,"")
  call fms_f2c_string (yk%key5,"")
  call fms_f2c_string (yk%key6,"")
  call fms_f2c_string (yk%key7,"")
  call fms_f2c_string (yk%key8,"")
  call fms_f2c_string (yk%key9,"")
  call fms_f2c_string (yk%key10,"")
  call fms_f2c_string (yk%key11,"")
  call fms_f2c_string (yk%key12,"")
  call fms_f2c_string (yk%key13,"")
  call fms_f2c_string (yk%key14,"")
  call fms_f2c_string (yk%key15,"")
  call fms_f2c_string (yk%key16,"")
  call fms_f2c_string(yk%level2key,"")
  yk%level2key_offset = -1
end subroutine initialize_key_struct
 
!! Initialize one instance of the fmsYamlOutValues_type structure.
subroutine initialize_val_struct( yv)
  type (fmsyamloutvalues_type), intent(inout):: yv !< Instance of the stucture
  call fms_f2c_string (yv%val1,"")
  call fms_f2c_string (yv%val2,"")
  call fms_f2c_string (yv%val3,"")
  call fms_f2c_string (yv%val4,"")
  call fms_f2c_string (yv%val5,"")
  call fms_f2c_string (yv%val6,"")
  call fms_f2c_string (yv%val7,"")
  call fms_f2c_string (yv%val8,"")
  call fms_f2c_string (yv%val9,"")
  call fms_f2c_string (yv%val10,"")
  call fms_f2c_string (yv%val11,"")
  call fms_f2c_string (yv%val12,"")
  call fms_f2c_string (yv%val13,"")
  call fms_f2c_string (yv%val14,"")
  call fms_f2c_string (yv%val15,"")
  call fms_f2c_string (yv%val16,"")
end subroutine initialize_val_struct
 
#endif
end module fms_yaml_output_mod
!> @}
! close documentation grouping