MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
bmif::bmi Type Referenceabstract
Collaboration diagram for bmif::bmi:
Collaboration graph

Public Member Functions

procedure(bmif_get_component_name), deferred get_component_name (this, name)
procedure(bmif_get_input_var_names), deferred get_input_var_names (this, names)
procedure(bmif_get_output_var_names), deferred get_output_var_names (this, names)
procedure(bmif_initialize), deferred initialize (this, config_file)
procedure(bmif_finalize), deferred finalize (this)
procedure(bmif_get_start_time), deferred get_start_time (this, time)
procedure(bmif_get_end_time), deferred get_end_time (this, time)
procedure(bmif_get_current_time), deferred get_current_time (this, time)
procedure(bmif_get_time_step), deferred get_time_step (this, time_step)
procedure(bmif_get_time_units), deferred get_time_units (this, time_units)
procedure(bmif_update), deferred update (this)
procedure(bmif_update_frac), deferred update_frac (this, time_frac)
procedure(bmif_update_until), deferred update_until (this, time)
procedure(bmif_get_var_grid), deferred get_var_grid (this, var_name, grid_id)
procedure(bmif_get_grid_type), deferred get_grid_type (this, grid_id, grid_type)
procedure(bmif_get_grid_rank), deferred get_grid_rank (this, grid_id, grid_rank)
procedure(bmif_get_grid_shape), deferred get_grid_shape (this, grid_id, grid_shape)
procedure(bmif_get_grid_size), deferred get_grid_size (this, grid_id, grid_size)
procedure(bmif_get_grid_spacing), deferred get_grid_spacing (this, grid_id, grid_spacing)
procedure(bmif_get_grid_origin), deferred get_grid_origin (this, grid_id, grid_origin)
procedure(bmif_get_grid_x), deferred get_grid_x (this, grid_id, grid_x)
procedure(bmif_get_grid_y), deferred get_grid_y (this, grid_id, grid_y)
procedure(bmif_get_grid_z), deferred get_grid_z (this, grid_id, grid_z)
procedure(bmif_get_grid_connectivity), deferred get_grid_connectivity (this, grid_id, grid_conn)
procedure(bmif_get_grid_offset), deferred get_grid_offset (this, grid_id, grid_offset)
procedure(bmif_get_var_type), deferred get_var_type (this, var_name, var_type)
procedure(bmif_get_var_units), deferred get_var_units (this, var_name, var_units)
procedure(bmif_get_var_itemsize), deferred get_var_itemsize (this, var_name, var_size)
procedure(bmif_get_var_nbytes), deferred get_var_nbytes (this, var_name, var_nbytes)
procedure(bmif_get_value_int), deferred get_value_int (this, var_name, dest)
procedure(bmif_get_value_float), deferred get_value_float (this, var_name, dest)
procedure(bmif_get_value_double), deferred get_value_double (this, var_name, dest)
procedure(bmif_get_value_ptr_int), deferred get_value_ptr_int (this, var_name, dest)
procedure(bmif_get_value_ptr_float), deferred get_value_ptr_float (this, var_name, dest)
procedure(bmif_get_value_ptr_double), deferred get_value_ptr_double (this, var_name, dest)
procedure(bmif_get_value_at_indices_int), deferred get_value_at_indices_int (this, var_name, dest, indices)
procedure(bmif_get_value_at_indices_float), deferred get_value_at_indices_float (this, var_name, dest, indices)
procedure(bmif_get_value_at_indices_double), deferred get_value_at_indices_double (this, var_name, dest, indices)
procedure(bmif_set_value_int), deferred set_value_int (this, var_name, src)
procedure(bmif_set_value_float), deferred set_value_float (this, var_name, src)
procedure(bmif_set_value_double), deferred set_value_double (this, var_name, src)
procedure(bmif_set_value_at_indices_int), deferred set_value_at_indices_int (this, var_name, indices, src)
procedure(bmif_set_value_at_indices_float), deferred set_value_at_indices_float (this, var_name, indices, src)
procedure(bmif_set_value_at_indices_double), deferred set_value_at_indices_double (this, var_name, indices, src)

Detailed Description

Definition at line 13 of file bmi.f90.

Member Function/Subroutine Documentation

◆ finalize()

procedure(bmif_finalize), deferred bmif::bmi::finalize ( class(bmi), intent(inout) this)
pure virtual

Definition at line 19 of file bmi.f90.

◆ get_component_name()

procedure(bmif_get_component_name), deferred bmif::bmi::get_component_name ( class(bmi), intent(in) this,
character(len=*), intent(out), pointer name )
pure virtual

Definition at line 15 of file bmi.f90.

◆ get_current_time()

procedure(bmif_get_current_time), deferred bmif::bmi::get_current_time ( class(bmi), intent(in) this,
double precision, intent(out) time )
pure virtual

Definition at line 22 of file bmi.f90.

◆ get_end_time()

procedure(bmif_get_end_time), deferred bmif::bmi::get_end_time ( class(bmi), intent(in) this,
double precision, intent(out) time )
pure virtual

Definition at line 21 of file bmi.f90.

◆ get_grid_connectivity()

procedure(bmif_get_grid_connectivity), deferred bmif::bmi::get_grid_connectivity ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
integer, dimension(:), intent(out) grid_conn )
pure virtual

Definition at line 38 of file bmi.f90.

◆ get_grid_offset()

procedure(bmif_get_grid_offset), deferred bmif::bmi::get_grid_offset ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
integer, dimension(:), intent(out) grid_offset )
pure virtual

Definition at line 39 of file bmi.f90.

◆ get_grid_origin()

procedure(bmif_get_grid_origin), deferred bmif::bmi::get_grid_origin ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
double precision, dimension(:), intent(out) grid_origin )
pure virtual

Definition at line 34 of file bmi.f90.

◆ get_grid_rank()

procedure(bmif_get_grid_rank), deferred bmif::bmi::get_grid_rank ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
integer, intent(out) grid_rank )
pure virtual

Definition at line 30 of file bmi.f90.

◆ get_grid_shape()

procedure(bmif_get_grid_shape), deferred bmif::bmi::get_grid_shape ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
integer, dimension(:), intent(out) grid_shape )
pure virtual

Definition at line 31 of file bmi.f90.

◆ get_grid_size()

procedure(bmif_get_grid_size), deferred bmif::bmi::get_grid_size ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
integer, intent(out) grid_size )
pure virtual

Definition at line 32 of file bmi.f90.

◆ get_grid_spacing()

procedure(bmif_get_grid_spacing), deferred bmif::bmi::get_grid_spacing ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
double precision, dimension(:), intent(out) grid_spacing )
pure virtual

Definition at line 33 of file bmi.f90.

◆ get_grid_type()

procedure(bmif_get_grid_type), deferred bmif::bmi::get_grid_type ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
character(len=*), intent(out) grid_type )
pure virtual

Definition at line 29 of file bmi.f90.

◆ get_grid_x()

procedure(bmif_get_grid_x), deferred bmif::bmi::get_grid_x ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
double precision, dimension(:), intent(out) grid_x )
pure virtual

Definition at line 35 of file bmi.f90.

◆ get_grid_y()

procedure(bmif_get_grid_y), deferred bmif::bmi::get_grid_y ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
double precision, dimension(:), intent(out) grid_y )
pure virtual

Definition at line 36 of file bmi.f90.

◆ get_grid_z()

procedure(bmif_get_grid_z), deferred bmif::bmi::get_grid_z ( class(bmi), intent(in) this,
integer, intent(in) grid_id,
double precision, dimension(:), intent(out) grid_z )
pure virtual

Definition at line 37 of file bmi.f90.

◆ get_input_var_names()

procedure(bmif_get_input_var_names), deferred bmif::bmi::get_input_var_names ( class(bmi), intent(in) this,
character(len=*), dimension(:), intent(out), pointer names )
pure virtual

Definition at line 16 of file bmi.f90.

◆ get_output_var_names()

procedure(bmif_get_output_var_names), deferred bmif::bmi::get_output_var_names ( class(bmi), intent(in) this,
character(len=*), dimension(:), intent(out), pointer names )
pure virtual

Definition at line 17 of file bmi.f90.

◆ get_start_time()

procedure(bmif_get_start_time), deferred bmif::bmi::get_start_time ( class(bmi), intent(in) this,
double precision, intent(out) time )
pure virtual

Definition at line 20 of file bmi.f90.

◆ get_time_step()

procedure(bmif_get_time_step), deferred bmif::bmi::get_time_step ( class(bmi), intent(in) this,
double precision, intent(out) time_step )
pure virtual

Definition at line 23 of file bmi.f90.

◆ get_time_units()

procedure(bmif_get_time_units), deferred bmif::bmi::get_time_units ( class(bmi), intent(in) this,
character(len=*), intent(out) time_units )
pure virtual

Definition at line 24 of file bmi.f90.

◆ get_value_at_indices_double()

procedure(bmif_get_value_at_indices_double), deferred bmif::bmi::get_value_at_indices_double ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
double precision, dimension(:), intent(inout) dest,
integer, dimension(:), intent(in) indices )
pure virtual

Definition at line 54 of file bmi.f90.

◆ get_value_at_indices_float()

procedure(bmif_get_value_at_indices_float), deferred bmif::bmi::get_value_at_indices_float ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
real, dimension(:), intent(inout) dest,
integer, dimension(:), intent(in) indices )
pure virtual

Definition at line 52 of file bmi.f90.

◆ get_value_at_indices_int()

procedure(bmif_get_value_at_indices_int), deferred bmif::bmi::get_value_at_indices_int ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(inout) dest,
integer, dimension(:), intent(in) indices )
pure virtual

Definition at line 50 of file bmi.f90.

◆ get_value_double()

procedure(bmif_get_value_double), deferred bmif::bmi::get_value_double ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
double precision, dimension(:), intent(inout) dest )
pure virtual

Definition at line 46 of file bmi.f90.

◆ get_value_float()

procedure(bmif_get_value_float), deferred bmif::bmi::get_value_float ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
real, dimension(:), intent(inout) dest )
pure virtual

Definition at line 45 of file bmi.f90.

◆ get_value_int()

procedure(bmif_get_value_int), deferred bmif::bmi::get_value_int ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(inout) dest )
pure virtual

Definition at line 44 of file bmi.f90.

◆ get_value_ptr_double()

procedure(bmif_get_value_ptr_double), deferred bmif::bmi::get_value_ptr_double ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
double precision, dimension(:), intent(inout), pointer dest )
pure virtual

Definition at line 49 of file bmi.f90.

◆ get_value_ptr_float()

procedure(bmif_get_value_ptr_float), deferred bmif::bmi::get_value_ptr_float ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
real, dimension(:), intent(inout), pointer dest )
pure virtual

Definition at line 48 of file bmi.f90.

◆ get_value_ptr_int()

procedure(bmif_get_value_ptr_int), deferred bmif::bmi::get_value_ptr_int ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(inout), pointer dest )
pure virtual

Definition at line 47 of file bmi.f90.

◆ get_var_grid()

procedure(bmif_get_var_grid), deferred bmif::bmi::get_var_grid ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
integer, intent(out) grid_id )
pure virtual

Definition at line 28 of file bmi.f90.

◆ get_var_itemsize()

procedure(bmif_get_var_itemsize), deferred bmif::bmi::get_var_itemsize ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
integer, intent(out) var_size )
pure virtual

Definition at line 42 of file bmi.f90.

◆ get_var_nbytes()

procedure(bmif_get_var_nbytes), deferred bmif::bmi::get_var_nbytes ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
integer, intent(out) var_nbytes )
pure virtual

Definition at line 43 of file bmi.f90.

◆ get_var_type()

procedure(bmif_get_var_type), deferred bmif::bmi::get_var_type ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
character(len=*), intent(out) var_type )
pure virtual

Definition at line 40 of file bmi.f90.

◆ get_var_units()

procedure(bmif_get_var_units), deferred bmif::bmi::get_var_units ( class(bmi), intent(in) this,
character(len=*), intent(in) var_name,
character(len=*), intent(out) var_units )
pure virtual

Definition at line 41 of file bmi.f90.

◆ initialize()

procedure(bmif_initialize), deferred bmif::bmi::initialize ( class(bmi), intent(out) this,
character(len=*), intent(in) config_file )
pure virtual

Definition at line 18 of file bmi.f90.

◆ set_value_at_indices_double()

procedure(bmif_set_value_at_indices_double), deferred bmif::bmi::set_value_at_indices_double ( class(bmi), intent(inout) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(in) indices,
double precision, dimension(:), intent(in) src )
pure virtual

Definition at line 63 of file bmi.f90.

◆ set_value_at_indices_float()

procedure(bmif_set_value_at_indices_float), deferred bmif::bmi::set_value_at_indices_float ( class(bmi), intent(inout) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(in) indices,
real, dimension(:), intent(in) src )
pure virtual

Definition at line 61 of file bmi.f90.

◆ set_value_at_indices_int()

procedure(bmif_set_value_at_indices_int), deferred bmif::bmi::set_value_at_indices_int ( class(bmi), intent(inout) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(in) indices,
integer, dimension(:), intent(in) src )
pure virtual

Definition at line 59 of file bmi.f90.

◆ set_value_double()

procedure(bmif_set_value_double), deferred bmif::bmi::set_value_double ( class(bmi), intent(inout) this,
character(len=*), intent(in) var_name,
double precision, dimension(:), intent(in) src )
pure virtual

Definition at line 58 of file bmi.f90.

◆ set_value_float()

procedure(bmif_set_value_float), deferred bmif::bmi::set_value_float ( class(bmi), intent(inout) this,
character(len=*), intent(in) var_name,
real, dimension(:), intent(in) src )
pure virtual

Definition at line 57 of file bmi.f90.

◆ set_value_int()

procedure(bmif_set_value_int), deferred bmif::bmi::set_value_int ( class(bmi), intent(inout) this,
character(len=*), intent(in) var_name,
integer, dimension(:), intent(in) src )
pure virtual

Definition at line 56 of file bmi.f90.

◆ update()

procedure(bmif_update), deferred bmif::bmi::update ( class(bmi), intent(inout) this)
pure virtual

Definition at line 25 of file bmi.f90.

◆ update_frac()

procedure(bmif_update_frac), deferred bmif::bmi::update_frac ( class(bmi), intent(inout) this,
double precision, intent(in) time_frac )
pure virtual

Definition at line 26 of file bmi.f90.

◆ update_until()

procedure(bmif_update_until), deferred bmif::bmi::update_until ( class(bmi), intent(inout) this,
double precision, intent(in) time )
pure virtual

Definition at line 27 of file bmi.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/srcbmi/bmi.f90