This module contains helper routines and parameters for the MODFLOW 6 BMI.

Functions/Subroutines
subroutine	split_address (c_var_address, mem_path, var_name, success)
	Split the variable address string. More...

subroutine	check_mem_address (mem_path, var_name, found)
	Check if the variable exists in the memory manager. More...

subroutine	warn_deprecated_address (mem_path, var_name)
	Store a warning the first time a deprecated variable name is used. More...

pure integer(i4b) function	strlen (char_array, max_len)
	Returns the string length without the trailing null character. More...

pure character(len=length) function	char_array_to_string (char_array, length)
	Convert C-style string to Fortran character string. More...

pure character(kind=c_char, len=1) function, dimension(length+1)	string_to_char_array (string, length)
	Convert Fortran string to C-style character string. More...

character(len=lenmodelname) function	extract_model_name (var_address, success)
	Extract the model name from a memory address string. More...

character(len=lenmodelname) function	get_model_name (grid_id)
	Get the model name from the grid id. More...

class(basesolutiontype) function, pointer	getsolution (subcomponent_idx)
	Get the solution object for this index. More...

subroutine	get_grid_type_model (model_name, grid_type_f)
	Get the grid type for a named model as a fortran string. More...

logical function	confirm_grid_type (grid_id, expected_type)
	Confirm that grid is of an expected type. More...

Variables
integer(i4b), parameter	lengridtype = 16
	max length for Fortran grid type string More...

integer(i4b), parameter	lenunits = 16
	max length for Fortran units string More...

integer(i4b), parameter	lenvarlocation = 16
	max length for Fortran variable location string More...

integer(c_int), bind(C, name="BMI_LENVARTYPE")	bmi_lenvartype = LENMEMTYPE + 1
	max. length for variable type C-strings More...

integer(c_int), bind(C, name="BMI_LENGRIDTYPE")	bmi_lengridtype = LENGRIDTYPE + 1
	max. length for grid type C-strings More...

integer(c_int), bind(C, name="BMI_LENUNITS")	bmi_lenunits = LENUNITS + 1
	max. length for units C-strings More...

integer(c_int), bind(C, name="BMI_LENVARLOCATION")	bmi_lenvarlocation = LENVARLOCATION + 1
	max. length for variable location C-strings More...

integer(c_int), bind(C, name="BMI_LENVARADDRESS")	bmi_lenvaraddress = LENMEMADDRESS + 1
	max. length for the variable's address C-string More...

integer(c_int), bind(C, name="BMI_LENCOMPONENTNAME")	bmi_lencomponentname = 256
	component name length, i.e. 'MODFLOW 6' More...

integer(c_int), bind(C, name="BMI_LENVERSION")	bmi_lenversion = 256
	length of version string, e.g. '6.3.1' or '6.4.1-dev' More...

Function/Subroutine Documentation

◆ char_array_to_string()

pure character(len=length) function mf6bmiutil::char_array_to_string	(	character(c_char), dimension(length), intent(in)	char_array,
		integer(c_int), intent(in)	length
	)

Parameters

[in]	length	string length without terminating null character
[in]	char_array	string to convert

Returns: Fortran fixed length character string

Definition at line 171 of file mf6bmiUtil.f90.

     ! -- dummy variables
     integer(c_int), intent(in) :: length !< string length without terminating null character
     character(c_char), intent(in) :: char_array(length) !< string to convert
     character(len=length) :: f_string !< Fortran fixed length character string
     ! -- local variables
     integer(I4B) :: i
  
     do i = 1, length
       f_string(i:i) = char_array(i)
     end do
  

Here is the caller graph for this function:

◆ check_mem_address()

subroutine mf6bmiutil::check_mem_address	(	character(len=lenmempath), intent(in)	mem_path,
		character(len=lenvarname), intent(in)	var_name,
		logical(lgp), intent(out)	found
	)

Parameters

[in]	mem_path	memory path used by the memory manager
[in]	var_name	name of the variable
[out]	found	true when found

Definition at line 104 of file mf6bmiUtil.f90.

     ! -- modules
     use memorymanagermodule, only: get_from_memorystore
     use memorytypemodule, only: memorytype
     ! -- dummy variables
     character(len=LENMEMPATH), intent(in) :: mem_path !< memory path used by the memory manager
     character(len=LENVARNAME), intent(in) :: var_name !< name of the variable
     logical(LGP), intent(out) :: found !< true when found
     ! -- local variables
     type(MemoryType), pointer :: mt
  
     found = .false.
     mt => null()
  
     ! check = false: otherwise stop is called when the variable does not exist
     call get_from_memorystore(var_name, mem_path, mt, found, check=.false.)
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirm_grid_type()

logical function mf6bmiutil::confirm_grid_type	(	integer(kind=c_int), intent(in)	grid_id,
		character(len=*), intent(in)	expected_type
	)

Definition at line 299 of file mf6bmiUtil.f90.

     ! -- dummy variables
     integer(kind=c_int), intent(in) :: grid_id
     character(len=*), intent(in) :: expected_type
     logical :: is_match
     ! -- local variables
     character(len=LENMODELNAME) :: model_name
     character(len=LENGRIDTYPE) :: grid_type
  
     is_match = .false.
  
     model_name = get_model_name(grid_id)
     call get_grid_type_model(model_name, grid_type)
     ! careful comparison:
     if (expected_type == grid_type) is_match = .true.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extract_model_name()

character(len=lenmodelname) function mf6bmiutil::extract_model_name	(	character(len=*), intent(in)	var_address,
		logical(lgp), intent(out)	success
	)

Parameters

[in] var_address the memory address for the variable

Returns: the extracted model name

Definition at line 204 of file mf6bmiUtil.f90.

     ! -- dummy variables
     character(len=*), intent(in) :: var_address !< the memory address for the variable
     character(len=LENMODELNAME) :: model_name !< the extracted model name
     logical(LGP), intent(out) :: success
     ! -- local variables
     character(len=LENMEMPATH) :: mem_path
     character(len=LENCOMPONENTNAME) :: dummy_component
     character(len=LENVARNAME) :: var_name
     logical(LGP) :: split_succeeded
  
     success = .false.
  
     call split_mem_address(var_address, mem_path, var_name, split_succeeded)
     if (.not. split_succeeded) then
       return
     end if
  
     call split_mem_path(mem_path, model_name, dummy_component)
     success = .true.
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_grid_type_model()

subroutine mf6bmiutil::get_grid_type_model	(	character(len=lenmodelname)	model_name,
		character(len=lengridtype)	grid_type_f
	)

Definition at line 277 of file mf6bmiUtil.f90.

     ! -- modules
     use listsmodule, only: basemodellist
     use basemodelmodule, only: basemodeltype, getbasemodelfromlist
     ! -- dummy variables
     character(len=LENMODELNAME) :: model_name
     character(len=LENGRIDTYPE) :: grid_type_f
     ! -- local variables
     integer(I4B) :: i
     class(BaseModelType), pointer :: baseModel
  
     do i = 1, basemodellist%Count()
       basemodel => getbasemodelfromlist(basemodellist, i)
       if (basemodel%name == model_name) then
         call basemodel%dis%get_dis_type(grid_type_f)
         return
       end if
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_model_name()

character(len=lenmodelname) function mf6bmiutil::get_model_name ( integer(kind=c_int), intent(in) grid_id )

Parameters

[in] grid_id grid id

Returns: model name

Definition at line 229 of file mf6bmiUtil.f90.

     ! -- modules
     use listsmodule, only: basemodellist
     use basemodelmodule, only: basemodeltype, getbasemodelfromlist
     ! -- dummy variables
     integer(kind=c_int), intent(in) :: grid_id !< grid id
     character(len=LENMODELNAME) :: model_name !< model name
     ! -- local variables
     integer(I4B) :: i
     class(BaseModelType), pointer :: baseModel
     character(len=LINELENGTH) :: error_msg
  
     model_name = ''
  
     do i = 1, basemodellist%Count()
       basemodel => getbasemodelfromlist(basemodellist, i)
       if (basemodel%id == grid_id) then
         model_name = basemodel%name
         return
       end if
     end do
  
     write (error_msg, '(a,i0)') 'BMI error: no model for grid id ', grid_id
     call write_message(error_msg, iunit=istdout, skipbefore=1, skipafter=1)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getsolution()

class(basesolutiontype) function, pointer mf6bmiutil::getsolution ( integer(i4b), intent(in) subcomponent_idx )

Parameters

[in] subcomponent_idx index of solution

Returns: Base Solution

Definition at line 257 of file mf6bmiUtil.f90.

     ! -- modules
     use solutiongroupmodule
     use basesolutionmodule, only: basesolutiontype, getbasesolutionfromlist
     use listsmodule, only: basesolutionlist, solutiongrouplist
     ! -- dummy variables
     integer(I4B), intent(in) :: subcomponent_idx !< index of solution
     class(BaseSolutionType), pointer :: solution !< Base Solution
     ! -- local variables
     class(SolutionGroupType), pointer :: sgp
     integer(I4B) :: solutionIdx
  
     ! this is equivalent to how it's done in sgp_ca
     sgp => getsolutiongroupfromlist(solutiongrouplist, 1)
     solutionidx = sgp%idsolutions(subcomponent_idx)
     solution => getbasesolutionfromlist(basesolutionlist, solutionidx)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ split_address()

subroutine mf6bmiutil::split_address	(	character(kind=c_char), dimension(*), intent(in)	c_var_address,
		character(len=lenmempath), intent(out)	mem_path,
		character(len=lenvarname), intent(out)	var_name,
		logical(lgp), intent(out)	success
	)

Splits the full address string into a memory path and variable name, following the rules used by the memory manager. The error handling is inside to avoid lots of duplication

Parameters

[in]	c_var_address	full address of a variable
[out]	mem_path	memory path used by the memory manager
[out]	var_name	name of the variable
[out]	success	false when invalid

Definition at line 63 of file mf6bmiUtil.f90.

     ! -- modules
     use memoryhelpermodule, only: mempathseparator
     ! -- dummy variables
     character(kind=c_char), intent(in) :: c_var_address(*) !< full address of a variable
     character(len=LENMEMPATH), intent(out) :: mem_path !< memory path used by the memory manager
     character(len=LENVARNAME), intent(out) :: var_name !< name of the variable
     logical(LGP), intent(out) :: success !< false when invalid
     ! -- local variables
     character(len=LENMEMADDRESS) :: var_address
     logical(LGP) :: valid, found
  
     success = .false.
  
     ! try and split the address string:
     var_address = char_array_to_string(c_var_address, &
                                        strlen(c_var_address, lenmemaddress + 1))
     call split_mem_address(var_address, mem_path, var_name, valid)
     if (.not. valid) then
       write (bmi_last_error, fmt_invalid_var) trim(var_address)
       call report_bmi_error(bmi_last_error)
       return
     end if
  
     ! check if the variable even exists:
     call check_mem_address(mem_path, var_name, found)
     if (.not. found) then
       write (bmi_last_error, fmt_unknown_var) trim(var_name), trim(mem_path)
       call report_bmi_error(bmi_last_error)
       return
     end if
  
     ! warn if the variable is addressed by a deprecated name
     call warn_deprecated_address(mem_path, var_name)
  
     success = .true.
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ string_to_char_array()

pure character(kind=c_char, len=1) function, dimension(length + 1) mf6bmiutil::string_to_char_array	(	character(len=length), intent(in)	string,
		integer(c_int), intent(in)	length
	)

Parameters

[in]	length	Fortran string length
[in]	string	string to convert

Returns: C-style character string

Definition at line 187 of file mf6bmiUtil.f90.

     ! -- dummy variables
     integer(c_int), intent(in) :: length !< Fortran string length
     character(len=length), intent(in) :: string !< string to convert
     character(kind=c_char, len=1) :: c_array(length + 1) !< C-style character string
     ! -- local variables
     integer(I4B) :: i
  
     do i = 1, length
       c_array(i) = string(i:i)
     end do
     c_array(length + 1) = c_null_char
  

Here is the caller graph for this function:

◆ strlen()

pure integer(i4b) function mf6bmiutil::strlen	(	character(c_char), dimension(max_len), intent(in)	char_array,
		integer(i4b), intent(in)	max_len
	)

Parameters

[in] char_array C-style character string

Returns: Fortran string length

Definition at line 151 of file mf6bmiUtil.f90.

     ! -- dummy variables
     integer(I4B), intent(in) :: max_len
     character(c_char), intent(in) :: char_array(max_len) !< C-style character string
     integer(I4B) :: string_length !< Fortran string length
     ! -- local variables
     integer(I4B) :: i
  
     string_length = 0
     do i = 1, size(char_array)
       if (char_array(i) .eq. c_null_char) then
         string_length = i - 1
         exit
       end if
     end do
  

Here is the caller graph for this function:

◆ warn_deprecated_address()

subroutine mf6bmiutil::warn_deprecated_address	(	character(len=lenmempath), intent(in)	mem_path,
		character(len=lenvarname), intent(in)	var_name
	)

Parameters

[in]	mem_path	memory path used by the memory manager
[in]	var_name	name of the variable

Definition at line 125 of file mf6bmiUtil.f90.

     ! -- modules
     use memoryaliasmodule, only: get_deprecated_alias
     use simmodule, only: store_warning
     ! -- dummy variables
     character(len=LENMEMPATH), intent(in) :: mem_path !< memory path used by the memory manager
     character(len=LENVARNAME), intent(in) :: var_name !< name of the variable
     ! -- local variables
     logical(LGP) :: found
     character(len=LENMEMADDRESS) :: replacement
     character(len=LINELENGTH) :: version
     character(len=MAXCHARLEN) :: msg
  
     call get_deprecated_alias(var_name, mem_path, found, replacement, version)
     if (.not. found) return
  
     write (msg, '(a)') &
       "API VARIABLE '"//trim(var_name)//"' IN '"//trim(mem_path)// &
       "' WAS DEPRECATED IN VERSION "//trim(version)//". USE '"// &
       trim(replacement)//"' INSTEAD."
     call store_warning(trim(msg), substring=trim(msg))
  

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ bmi_lencomponentname

integer(c_int), bind(C, name="BMI_LENCOMPONENTNAME") mf6bmiutil::bmi_lencomponentname = 256

Definition at line 48 of file mf6bmiUtil.f90.

48 integer(c_int), bind(C, name="BMI_LENCOMPONENTNAME") :: BMI_LENCOMPONENTNAME = &

49 256 !< component name length, i.e. 'MODFLOW 6'

◆ bmi_lengridtype

integer(c_int), bind(C, name="BMI_LENGRIDTYPE") mf6bmiutil::bmi_lengridtype = LENGRIDTYPE + 1

Definition at line 32 of file mf6bmiUtil.f90.

32 integer(c_int), bind(C, name="BMI_LENGRIDTYPE") :: BMI_LENGRIDTYPE = &

33 lengridtype + 1 !< max. length for grid type C-strings

◆ bmi_lenunits

integer(c_int), bind(C, name="BMI_LENUNITS") mf6bmiutil::bmi_lenunits = LENUNITS + 1

Definition at line 36 of file mf6bmiUtil.f90.

36 integer(c_int), bind(C, name="BMI_LENUNITS") :: BMI_LENUNITS = &

37 lenunits + 1 !< max. length for units C-strings

◆ bmi_lenvaraddress

integer(c_int), bind(C, name="BMI_LENVARADDRESS") mf6bmiutil::bmi_lenvaraddress = LENMEMADDRESS + 1

Definition at line 44 of file mf6bmiUtil.f90.

44 integer(c_int), bind(C, name="BMI_LENVARADDRESS") :: BMI_LENVARADDRESS = &

45 lenmemaddress + 1 !< max. length for the variable's address C-string

◆ bmi_lenvarlocation

integer(c_int), bind(C, name="BMI_LENVARLOCATION") mf6bmiutil::bmi_lenvarlocation = LENVARLOCATION + 1

Definition at line 40 of file mf6bmiUtil.f90.

40 integer(c_int), bind(C, name="BMI_LENVARLOCATION") :: BMI_LENVARLOCATION = &

41 lenvarlocation + 1 !< max. length for variable location C-strings

◆ bmi_lenvartype

integer(c_int), bind(C, name="BMI_LENVARTYPE") mf6bmiutil::bmi_lenvartype = LENMEMTYPE + 1

Definition at line 28 of file mf6bmiUtil.f90.

28 integer(c_int), bind(C, name="BMI_LENVARTYPE") :: BMI_LENVARTYPE = &

29 lenmemtype + 1 !< max. length for variable type C-strings

◆ bmi_lenversion

integer(c_int), bind(C, name="BMI_LENVERSION") mf6bmiutil::bmi_lenversion = 256

Definition at line 52 of file mf6bmiUtil.f90.

52 integer(c_int), bind(C, name="BMI_LENVERSION") :: BMI_LENVERSION = 256 !< length of version string, e.g. '6.3.1' or '6.4.1-dev'

◆ lengridtype

integer(i4b), parameter mf6bmiutil::lengridtype = 16

Definition at line 24 of file mf6bmiUtil.f90.

24 integer(I4B), parameter :: LENGRIDTYPE = 16 !< max length for Fortran grid type string

◆ lenunits

integer(i4b), parameter mf6bmiutil::lenunits = 16

Definition at line 25 of file mf6bmiUtil.f90.

25 integer(I4B), parameter :: LENUNITS = 16 !< max length for Fortran units string

◆ lenvarlocation

integer(i4b), parameter mf6bmiutil::lenvarlocation = 16

Definition at line 26 of file mf6bmiUtil.f90.

26 integer(I4B), parameter :: LENVARLOCATION = 16 !< max length for Fortran variable location string

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ char_array_to_string()

◆ check_mem_address()

◆ confirm_grid_type()

◆ extract_model_name()

◆ get_grid_type_model()

◆ get_model_name()

◆ getsolution()

◆ split_address()

◆ string_to_char_array()

◆ strlen()

◆ warn_deprecated_address()

Variable Documentation

◆ bmi_lencomponentname

◆ bmi_lengridtype

◆ bmi_lenunits

◆ bmi_lenvaraddress

◆ bmi_lenvarlocation

◆ bmi_lenvartype

◆ bmi_lenversion

◆ lengridtype

◆ lenunits

◆ lenvarlocation