optionsdatabase_mod::options_add Interface Reference

Generic add interface for adding different types of data to the databases. More...

Private Member Functions
recursive subroutine	options_add_integer (options_database, key, int_value, do_not_replace, array_index)
	Adds an integer value to the options database with a specific key. More...
subroutine	options_add_real (options_database, key, real_value, do_not_replace, array_index)
	Adds a real value to the options database with a specific key. More...
subroutine	options_add_logical (options_database, key, logical_value, do_not_replace, array_index)
	Adds a logical value to the options database with a specific key. More...
subroutine	options_add_string (options_database, key, string_value, do_not_replace, array_index)
	Adds a string value to the options database with a specific key. More...

Detailed Description

Generic add interface for adding different types of data to the databases.

Definition at line 28 of file optionsdatabase.F90.

Member Function/Subroutine Documentation

options_add_integer()

recursive subroutine optionsdatabase_mod::options_add::options_add_integer ( type(hashmap_type), intent(inout)  options_database, character(len=*), intent(in)  key, integer, intent(in)  int_value, logical, intent(in), optional  do_not_replace, integer, intent(in), optional  array_index  )

private

Adds an integer value to the options database with a specific key.

Parameters

options_database	The options database
key	The key to use
value	The integer value to add to the database
do_not_replace	Optional flag whether to ignore existing values or replace them
array_index	Optional array index which specifies which location in the array to write to

Definition at line 552 of file optionsdatabase.F90.

    type(hashmap_type), intent(inout) :: options_database
    character(len=*), intent(in) :: key
    integer, intent(in) :: int_value
    integer, intent(in), optional :: array_index
    logical, intent(in), optional :: do_not_replace
 
    integer :: temp_size
    character(len=len(key)+ARRAY_APPEND_SIZE) :: lookup_key
 
    if (present(do_not_replace)) then
      if (do_not_replace) then
        if (present(array_index)) then
          if (options_has_key(options_database, trim(key)//"a_"//conv_to_string(array_index))) return
        else
          if (options_has_key(options_database, key)) return
        end if
      end if      
    end if
 
    if (present(array_index)) then
      if (options_has_key(options_database, trim(key)//"a_size")) then
        temp_size=options_get_integer(options_database, trim(key)//"a_size")
        if (temp_size .lt. array_index) temp_size=temp_size+1
      else
        temp_size=1
      end if
      call options_add(options_database, trim(key)//"a_size", temp_size)
      lookup_key=get_options_array_key(key, array_index)
    else
      lookup_key=key
    end if
    call c_put_integer(options_database, lookup_key, int_value)    

options_add_logical()

subroutine optionsdatabase_mod::options_add::options_add_logical ( type(hashmap_type), intent(inout)  options_database, character(len=*), intent(in)  key, logical, intent(in)  logical_value, logical, intent(in), optional  do_not_replace, integer, intent(in), optional  array_index  )

private

Adds a logical value to the options database with a specific key.

Parameters

options_database	The options database
key	The key to use
value	The logical value to add to the database
do_not_replace	Optional flag whether to ignore existing values or replace them
array_index	Optional array index which specifies which location in the array to write to

Definition at line 468 of file optionsdatabase.F90.

    type(hashmap_type), intent(inout) :: options_database
    character(len=*), intent(in) :: key
    logical, intent(in) :: logical_value
    integer, intent(in), optional :: array_index
    logical, intent(in), optional :: do_not_replace
 
    integer :: temp_size
    character(len=len(key)+ARRAY_APPEND_SIZE) :: lookup_key
 
    if (present(do_not_replace)) then
      if (do_not_replace) then
        if (present(array_index)) then
          if (options_has_key(options_database, trim(key)//"a_"//conv_to_string(array_index))) return
        else
          if (options_has_key(options_database, key)) return
        end if
      end if      
    end if
 
    if (present(array_index)) then
      if (options_has_key(options_database, trim(key)//"a_size")) then
        temp_size=options_get_integer(options_database, trim(key)//"a_size")
        if (temp_size .lt. array_index) temp_size=temp_size+1
      else
        temp_size=1
      end if
      call options_add(options_database, trim(key)//"a_size", temp_size)
      lookup_key=get_options_array_key(key, array_index)
    else
      lookup_key=key
    end if
    call c_put_logical(options_database, lookup_key, logical_value)    

options_add_real()

subroutine optionsdatabase_mod::options_add::options_add_real ( type(hashmap_type), intent(inout)  options_database, character(len=*), intent(in)  key, real(kind=default_precision), intent(in)  real_value, logical, intent(in), optional  do_not_replace, integer, intent(in), optional  array_index  )

private

Adds a real value to the options database with a specific key.

Parameters

options_database	The options database
key	The key to use
value	The real value to add to the database
do_not_replace	Optional flag whether to ignore existing values or replace them
array_index	Optional array index which specifies which location in the array to write to

Definition at line 427 of file optionsdatabase.F90.

    type(hashmap_type), intent(inout) :: options_database
    character(len=*), intent(in) :: key
    real(kind=default_precision), intent(in) :: real_value
    integer, intent(in), optional :: array_index
    logical, intent(in), optional :: do_not_replace
 
    integer :: temp_size
    character(len=len(key)+ARRAY_APPEND_SIZE) :: lookup_key
 
    if (present(do_not_replace)) then
      if (do_not_replace) then
        if (present(array_index)) then
          if (options_has_key(options_database, trim(key)//"a_"//conv_to_string(array_index))) return
        else
          if (options_has_key(options_database, key)) return
        end if
      end if      
    end if
 
    if (present(array_index)) then
      if (options_has_key(options_database, trim(key)//"a_size")) then
        temp_size=options_get_integer(options_database, trim(key)//"a_size")
        if (temp_size .lt. array_index) temp_size=temp_size+1
      else
        temp_size=1
      end if
      call options_add(options_database, trim(key)//"a_size", temp_size)      
      lookup_key=get_options_array_key(key, array_index)
    else
      lookup_key=key
    end if
    call c_put_real(options_database, lookup_key, real_value)

options_add_string()

subroutine optionsdatabase_mod::options_add::options_add_string ( type(hashmap_type), intent(inout)  options_database, character(len=*), intent(in)  key, character(len=*), intent(in)  string_value, logical, intent(in), optional  do_not_replace, integer, intent(in), optional  array_index  )

private

Adds a string value to the options database with a specific key.

Parameters

options_database	The options database
key	The key to use
value	The string value to add to the database
do_not_replace	Optional flag whether to ignore existing values or replace them
array_index	Optional array index which specifies which location in the array to write to

Definition at line 509 of file optionsdatabase.F90.

    type(hashmap_type), intent(inout) :: options_database
    character(len=*), intent(in) :: key, string_value
    integer, intent(in), optional :: array_index
    logical, intent(in), optional :: do_not_replace
 
    character(len=STRING_LENGTH) :: value_to_store
    integer :: temp_size
    character(len=len(key)+ARRAY_APPEND_SIZE) :: lookup_key
 
    if (present(do_not_replace)) then
      if (do_not_replace) then
        if (present(array_index)) then
          if (options_has_key(options_database, trim(key)//"a_"//conv_to_string(array_index))) return
        else
          if (options_has_key(options_database, key)) return
        end if
      end if      
    end if
 
    value_to_store=string_value
 
    if (present(array_index)) then
      if (options_has_key(options_database, trim(key)//"a_size")) then
        temp_size=options_get_integer(options_database, trim(key)//"a_size")
        if (temp_size .lt. array_index) temp_size=temp_size+1
      else
        temp_size=1
      end if
      call options_add(options_database, trim(key)//"a_size", temp_size)
      lookup_key=get_options_array_key(key, array_index)
    else
      lookup_key=key
    end if
    call c_put_string(options_database, lookup_key, value_to_store)

---

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

• model_core/src/configuration/optionsdatabase.F90