loadncinputmodule Module Reference

This module contains the LoadNCInputModule. More...

Data Types
interface	netcdf_read_array

Functions/Subroutines
subroutine	error_and_exit (tagname, input_fname)
	Set an error and exit if NetCDF libraries aren't available. More...
subroutine	nc_read_int1d (int1d, mshape, idt, mf6_input, nc_vars, input_fname, iout, kper)
	Read a NetCDF integer 1d array. More...
subroutine	nc_read_int2d (int2d, mshape, idt, mf6_input, nc_vars, input_fname, iout)
	Read a NetCDF integer 2d array. More...
subroutine	nc_read_int3d (int3d, mshape, idt, mf6_input, nc_vars, input_fname, iout)
	Read a NetCDF integer 3d array. More...
subroutine	nc_read_dbl1d (dbl1d, mshape, idt, mf6_input, nc_vars, input_fname, iout, kper, iaux)
	Read a NetCDF double 1d array. More...
subroutine	nc_read_dbl2d (dbl2d, mshape, idt, mf6_input, nc_vars, input_fname, iout)
	Read a NetCDF double 2d array. More...
subroutine	nc_read_dbl3d (dbl3d, mshape, idt, mf6_input, nc_vars, input_fname, iout)
	Read a NetCDF double 3d array. More...

Detailed Description

Access interfaces for netcdf reads optioned from a traditional modflow 6 input. These interfaces throw an error when netcdf libraries aren't compiled in.

Function/Subroutine Documentation

error_and_exit()

subroutine loadncinputmodule::error_and_exit ( character(len=*), intent(in)  tagname, character(len=*), intent(in)  input_fname  )

private

Definition at line 32 of file LoadNCInput.F90.

    use simvariablesmodule, only: errmsg
    use simmodule, only: store_error, store_error_filename
    character(len=*), intent(in) :: tagname
    character(len=*), intent(in) :: input_fname
    write (errmsg, '(a)') &
      'Cannot load NetCDF array for variable "'//trim(tagname)// &
      '". NetCDF libraries are not available. Ensure Extended MODFLOW 6 in use.'
    call store_error(errmsg)
    call store_error_filename(input_fname)

Here is the call graph for this function:

Here is the caller graph for this function:

nc_read_dbl1d()

subroutine loadncinputmodule::nc_read_dbl1d ( real(dp), dimension(:), intent(in), pointer, contiguous  dbl1d, integer(i4b), dimension(:), intent(in), pointer, contiguous  mshape, type(inputparamdefinitiontype), intent(in)  idt, type(modflowinputtype), intent(in)  mf6_input, type(ncpackagevarstype), intent(in), pointer  nc_vars, character(len=*), intent(in)  input_fname, integer(i4b), intent(in)  iout, integer(i4b), intent(in), optional  kper, integer(i4b), intent(in), optional  iaux  )

private

Parameters

[in]	mshape	model shape
[in]	idt	input data type object describing this record

Definition at line 105 of file LoadNCInput.F90.

    real(DP), dimension(:), pointer, contiguous, intent(in) :: dbl1d
    integer(I4B), dimension(:), contiguous, pointer, intent(in) :: mshape !< model shape
    type(InputParamDefinitionType), intent(in) :: idt !< input data type object describing this record
    type(ModflowInputType), intent(in) :: mf6_input
    type(NCPackageVarsType), pointer, intent(in) :: nc_vars
    character(len=*), intent(in) :: input_fname
    integer(I4B), intent(in) :: iout
    integer(I4B), optional, intent(in) :: kper
    integer(I4B), optional, intent(in) :: iaux
#if defined(__WITH_NETCDF__)
    call netcdf_array_load(dbl1d, mshape, idt, mf6_input, nc_vars, input_fname, &
                           iout, kper=kper, iaux=iaux)
#else
    call error_and_exit(idt%tagname, input_fname)
#endif

nc_read_dbl2d()

subroutine loadncinputmodule::nc_read_dbl2d ( real(dp), dimension(:, :), intent(in), pointer, contiguous  dbl2d, integer(i4b), dimension(:), intent(in), pointer, contiguous  mshape, type(inputparamdefinitiontype), intent(in)  idt, type(modflowinputtype), intent(in)  mf6_input, type(ncpackagevarstype), intent(in), pointer  nc_vars, character(len=*), intent(in)  input_fname, integer(i4b), intent(in)  iout  )

private

Parameters

[in]	mshape	model shape
[in]	idt	input data type object describing this record

Definition at line 126 of file LoadNCInput.F90.

    real(DP), dimension(:, :), pointer, contiguous, intent(in) :: dbl2d
    integer(I4B), dimension(:), contiguous, pointer, intent(in) :: mshape !< model shape
    type(InputParamDefinitionType), intent(in) :: idt !< input data type object describing this record
    type(ModflowInputType), intent(in) :: mf6_input
    type(NCPackageVarsType), pointer, intent(in) :: nc_vars
    character(len=*), intent(in) :: input_fname
    integer(I4B), intent(in) :: iout
#if defined(__WITH_NETCDF__)
    call netcdf_array_load(dbl2d, mshape, idt, mf6_input, nc_vars, input_fname, &
                           iout)
#else
    call error_and_exit(idt%tagname, input_fname)
#endif

nc_read_dbl3d()

subroutine loadncinputmodule::nc_read_dbl3d ( real(dp), dimension(:, :, :), intent(in), pointer, contiguous  dbl3d, integer(i4b), dimension(:), intent(in), pointer, contiguous  mshape, type(inputparamdefinitiontype), intent(in)  idt, type(modflowinputtype), intent(in)  mf6_input, type(ncpackagevarstype), intent(in), pointer  nc_vars, character(len=*), intent(in)  input_fname, integer(i4b), intent(in)  iout  )

private

Parameters

[in]	mshape	model shape
[in]	idt	input data type object describing this record

Definition at line 145 of file LoadNCInput.F90.

    real(DP), dimension(:, :, :), pointer, contiguous, intent(in) :: dbl3d
    integer(I4B), dimension(:), contiguous, pointer, intent(in) :: mshape !< model shape
    type(InputParamDefinitionType), intent(in) :: idt !< input data type object describing this record
    type(ModflowInputType), intent(in) :: mf6_input
    type(NCPackageVarsType), pointer, intent(in) :: nc_vars
    character(len=*), intent(in) :: input_fname
    integer(I4B), intent(in) :: iout
#if defined(__WITH_NETCDF__)
    call netcdf_array_load(dbl3d, mshape, idt, mf6_input, nc_vars, input_fname, &
                           iout)
#else
    call error_and_exit(idt%tagname, input_fname)
#endif

nc_read_int1d()

subroutine loadncinputmodule::nc_read_int1d	(	integer(i4b), dimension(:), intent(in), pointer, contiguous	int1d,
		integer(i4b), dimension(:), intent(in), pointer, contiguous	mshape,
		type(inputparamdefinitiontype), intent(in)	idt,
		type(modflowinputtype), intent(in)	mf6_input,
		type(ncpackagevarstype), intent(in), pointer	nc_vars,
		character(len=*), intent(in)	input_fname,
		integer(i4b), intent(in)	iout,
		integer(i4b), intent(in), optional	kper
	)

Parameters

[in]	mshape	model shape
[in]	idt	input data type object describing this record

Definition at line 47 of file LoadNCInput.F90.

    integer(I4B), dimension(:), pointer, contiguous, intent(in) :: int1d
    integer(I4B), dimension(:), contiguous, pointer, intent(in) :: mshape !< model shape
    type(InputParamDefinitionType), intent(in) :: idt !< input data type object describing this record
    type(ModflowInputType), intent(in) :: mf6_input
    type(NCPackageVarsType), pointer, intent(in) :: nc_vars
    character(len=*), intent(in) :: input_fname
    integer(I4B), intent(in) :: iout
    integer(I4B), optional, intent(in) :: kper
#if defined(__WITH_NETCDF__)
    call netcdf_array_load(int1d, mshape, idt, mf6_input, nc_vars, input_fname, &
                           iout, kper)
#else
    call error_and_exit(idt%tagname, input_fname)
#endif

nc_read_int2d()

subroutine loadncinputmodule::nc_read_int2d ( integer(i4b), dimension(:, :), intent(in), pointer, contiguous  int2d, integer(i4b), dimension(:), intent(in), pointer, contiguous  mshape, type(inputparamdefinitiontype), intent(in)  idt, type(modflowinputtype), intent(in)  mf6_input, type(ncpackagevarstype), intent(in), pointer  nc_vars, character(len=*), intent(in)  input_fname, integer(i4b), intent(in)  iout  )

private

Parameters

[in]	mshape	model shape
[in]	idt	input data type object describing this record

Definition at line 67 of file LoadNCInput.F90.

    integer(I4B), dimension(:, :), pointer, contiguous, intent(in) :: int2d
    integer(I4B), dimension(:), contiguous, pointer, intent(in) :: mshape !< model shape
    type(InputParamDefinitionType), intent(in) :: idt !< input data type object describing this record
    type(ModflowInputType), intent(in) :: mf6_input
    type(NCPackageVarsType), pointer, intent(in) :: nc_vars
    character(len=*), intent(in) :: input_fname
    integer(I4B), intent(in) :: iout
#if defined(__WITH_NETCDF__)
    call netcdf_array_load(int2d, mshape, idt, mf6_input, nc_vars, input_fname, &
                           iout)
#else
    call error_and_exit(idt%tagname, input_fname)
#endif

nc_read_int3d()

subroutine loadncinputmodule::nc_read_int3d ( integer(i4b), dimension(:, :, :), intent(in), pointer, contiguous  int3d, integer(i4b), dimension(:), intent(in), pointer, contiguous  mshape, type(inputparamdefinitiontype), intent(in)  idt, type(modflowinputtype), intent(in)  mf6_input, type(ncpackagevarstype), intent(in), pointer  nc_vars, character(len=*), intent(in)  input_fname, integer(i4b), intent(in)  iout  )

private

Parameters

[in]	mshape	model shape
[in]	idt	input data type object describing this record

Definition at line 86 of file LoadNCInput.F90.

    integer(I4B), dimension(:, :, :), pointer, contiguous, intent(in) :: int3d
    integer(I4B), dimension(:), contiguous, pointer, intent(in) :: mshape !< model shape
    type(InputParamDefinitionType), intent(in) :: idt !< input data type object describing this record
    type(ModflowInputType), intent(in) :: mf6_input
    type(NCPackageVarsType), pointer, intent(in) :: nc_vars
    character(len=*), intent(in) :: input_fname
    integer(I4B), intent(in) :: iout
#if defined(__WITH_NETCDF__)
    call netcdf_array_load(int3d, mshape, idt, mf6_input, nc_vars, input_fname, &
                           iout)
#else
    call error_and_exit(idt%tagname, input_fname)
#endif