MODFLOW 6  version 6.9.0.dev0
USGS Modular Hydrologic Model
mf6bmi.f90 File Reference

Go to the source code of this file.

Modules

module  mf6bmi
 This module contains the MODFLOW 6 BMI.
 

Functions/Subroutines

integer(kind=c_int) function mf6bmi::bmi_get_component_name (name)
 
integer(kind=c_int) function mf6bmi::bmi_initialize ()
 Initialize the computational core. More...
 
integer(kind=c_int) function mf6bmi::bmi_update ()
 Perform a computational time step. More...
 
integer(kind=c_int) function mf6bmi::bmi_update_until (time)
 Perform time steps until the current time reaches time. More...
 
integer(kind=c_int) function mf6bmi::bmi_finalize ()
 Clean up the initialized simulation. More...
 
integer(kind=c_int) function mf6bmi::get_start_time (start_time)
 Get the start time of the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_end_time (end_time)
 Get the end time of the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_current_time (current_time)
 Get the current time of the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_time_step (time_step)
 Get the time step for the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_time_units (c_time_units)
 Get the time units of the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_input_item_count (count)
 Get the number of input variables in the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_output_item_count (count)
 Get the number of output variables in the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_input_var_names (c_names)
 Returns all input variables in the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_output_var_names (c_names)
 Returns all output variables in the simulation. More...
 
integer(kind=c_int) function mf6bmi::get_var_itemsize (c_var_address, var_size)
 Get the size (in bytes) of a single element of a variable. More...
 
integer(kind=c_int) function mf6bmi::get_var_nbytes (c_var_address, var_nbytes)
 Get size of the variable, in bytes. More...
 
integer(kind=c_int) function mf6bmi::get_value_double (c_var_address, c_arr_ptr)
 Copy the double precision values of a variable into the array. More...
 
integer(kind=c_int) function mf6bmi::get_value_int (c_var_address, c_arr_ptr)
 Copy the integer values of a variable into the array. More...
 
integer(kind=c_int) function mf6bmi::get_value_bool (c_var_address, c_arr_ptr)
 Copy the logical scalar value into the array. More...
 
integer(kind=c_int) function mf6bmi::get_value_string (c_var_address, c_arr_ptr)
 Copy the string(s) of a variable into the array. More...
 
integer(kind=c_int) function mf6bmi::get_value (c_var_address, c_arr_ptr)
 Copy the value of a variable into the array. More...
 
integer(kind=c_int) function mf6bmi::get_value_ptr (c_var_address, c_arr_ptr)
 Get a pointer to an array. More...
 
integer(kind=c_int) function mf6bmi::get_value_ptr_double (c_var_address, c_arr_ptr)
 Get a pointer to the array of double precision numbers. More...
 
integer(kind=c_int) function mf6bmi::get_value_ptr_int (c_var_address, c_arr_ptr)
 Get a pointer to the array of integer numbers. More...
 
integer(kind=c_int) function mf6bmi::get_value_ptr_bool (c_var_address, c_arr_ptr)
 Get a pointer to the logical scalar value. More...
 
integer(kind=c_int) function mf6bmi::set_value (c_var_address, c_arr_ptr)
 Set new values for a given variable. More...
 
integer(kind=c_int) function mf6bmi::set_value_double (c_var_address, c_arr_ptr)
 Set new values for a variable of type double. More...
 
integer(kind=c_int) function mf6bmi::set_value_int (c_var_address, c_arr_ptr)
 Set new values for a variable of type integer. More...
 
integer(kind=c_int) function mf6bmi::set_value_bool (c_var_address, c_arr_ptr)
 Set new value for a logical scalar variable. More...
 
integer(kind=c_int) function mf6bmi::get_value_at_indices (c_var_address, c_arr_ptr, c_inds, count)
 Copy the values of a variable at the given indices into the array. More...
 
integer(kind=c_int) function mf6bmi::set_value_at_indices (c_var_address, c_inds, count, c_arr_ptr)
 Set the values of a variable at the given indices. More...
 
logical(lgp) function mf6bmi::valid_indices (mem_path, var_name, c_inds, count, nvalues)
 Check that every index is within the variable, and count its values. More...
 
integer(kind=c_int) function mf6bmi::get_var_type (c_var_address, c_var_type)
 Get the variable type as a string. More...
 
integer(kind=c_int) function mf6bmi::get_var_units (c_var_address, c_var_units)
 Get the units of a variable. More...
 
integer(kind=c_int) function mf6bmi::get_var_location (c_var_address, c_var_location)
 Get the grid location of a variable. More...
 
integer(kind=c_int) function mf6bmi::get_var_rank (c_var_address, c_var_rank)
 Get the variable rank (non-BMI) More...
 
integer(kind=c_int) function mf6bmi::get_var_shape (c_var_address, c_var_shape)
 Get the shape of the array for the variable (non-BMI) More...
 

Variables

integer(c_int), bind(C, name="ISTDOUTTOFILE") mf6bmi::istdout_to_file = 1
 output control: =0 to screen, >0 to file More...