MODFLOW 6  version 6.7.0.dev2
USGS Modular Hydrologic Model
Mf6FileStoInput.f90
Go to the documentation of this file.
1 !> @brief This module contains the Mf6FileStoInputModule
2 !!
3 !! This module contains the routines for reading STO period block input
4 !!
5 !<
7 
8  use kindmodule, only: i4b, dp, lgp
9  use constantsmodule, only: linelength
14 
15  implicit none
16  private
17  public :: stoinputtype
18 
19  !> @brief STO package loader
20  !!
21  !<
23  character(len=LINELENGTH), pointer :: storage => null()
24  contains
25  procedure :: ainit => sto_init
26  procedure :: rp => sto_rp
27  procedure :: destroy => sto_destroy
28  end type stoinputtype
29 
30 contains
31 
32  subroutine sto_init(this, mf6_input, component_name, component_input_name, &
33  input_name, iperblock, parser, iout)
36  class(stoinputtype), intent(inout) :: this
37  type(modflowinputtype), intent(in) :: mf6_input
38  character(len=*), intent(in) :: component_name
39  character(len=*), intent(in) :: component_input_name
40  character(len=*), intent(in) :: input_name
41  integer(I4B), intent(in) :: iperblock
42  type(blockparsertype), pointer, intent(inout) :: parser
43  integer(I4B), intent(in) :: iout
44  type(loadmf6filetype) :: loader
45 
46  ! init loader
47  call this%DynamicPkgLoadType%init(mf6_input, component_name, &
48  component_input_name, input_name, &
49  iperblock, iout)
50  ! initialize static loader
51  call loader%load(parser, mf6_input, this%nc_vars, this%input_name, iout)
52 
53  ! allocate storage string
54  call mem_allocate(this%storage, linelength, 'STORAGE', this%mf6_input%mempath)
55 
56  ! initialize storage to TRANSIENT (model iss=0)
57  this%storage = 'TRANSIENT'
58  end subroutine sto_init
59 
60  subroutine sto_rp(this, parser)
64  class(stoinputtype), intent(inout) :: this
65  type(blockparsertype), pointer, intent(inout) :: parser
66  character(len=LINELENGTH) :: tagname
67  type(inputparamdefinitiontype), pointer :: idt
68  logical(LGP) :: endOfBlock
69 
70  ! read next line
71  call parser%GetNextLine(endofblock)
72 
73  ! return if no input
74  if (endofblock) return
75 
76  ! read the tag
77  call parser%GetStringCaps(tagname)
78 
79  ! verify tag is supported
80  idt => get_param_definition_type(this%mf6_input%param_dfns, &
81  this%mf6_input%component_type, &
82  this%mf6_input%subcomponent_type, &
83  'PERIOD', tagname, this%input_name)
84  ! set storage
85  this%storage = idt%tagname
86 
87  ! only one input line is expected, terminate block
88  call parser%terminateblock()
89 
90  ! log lst file header
91  call idm_log_header(this%mf6_input%component_name, &
92  this%mf6_input%subcomponent_name, this%iout)
93 
94  call idm_log_var(this%storage, tagname, this%mf6_input%mempath, this%iout)
95 
96  ! close logging statement
97  call idm_log_close(this%mf6_input%component_name, &
98  this%mf6_input%subcomponent_name, this%iout)
99  end subroutine sto_rp
100 
101  subroutine sto_destroy(this)
103  class(stoinputtype), intent(inout) :: this
104  call mem_deallocate(this%storage, 'STORAGE', this%mf6_input%mempath)
105  call this%DynamicPkgLoadType%destroy()
106  end subroutine sto_destroy
107 
108 end module mf6filestoinputmodule
This module contains the AsciiInputLoadTypeModule.
This module contains block parser methods.
Definition: BlockParser.f90:7
This module contains simulation constants.
Definition: Constants.f90:9
integer(i4b), parameter linelength
maximum length of a standard line
Definition: Constants.f90:45
This module contains the DefinitionSelectModule.
type(inputparamdefinitiontype) function, pointer, public get_param_definition_type(input_definition_types, component_type, subcomponent_type, blockname, tagname, filename)
Return parameter definition.
This module contains the Input Data Model Logger Module.
Definition: IdmLogger.f90:7
subroutine, public idm_log_close(component, subcomponent, iout)
@ brief log the closing message
Definition: IdmLogger.f90:56
subroutine, public idm_log_header(component, subcomponent, iout)
@ brief log a header message
Definition: IdmLogger.f90:44
This module contains the InputDefinitionModule.
This module defines variable data types.
Definition: kind.f90:8
This module contains the LoadMf6FileModule.
Definition: LoadMf6File.f90:8
This module contains the Mf6FileStoInputModule.
subroutine sto_destroy(this)
subroutine sto_rp(this, parser)
subroutine sto_init(this, mf6_input, component_name, component_input_name, input_name, iperblock, parser, iout)
This module contains the ModflowInputModule.
Definition: ModflowInput.f90:9
base abstract type for ascii source dynamic load
Static parser based input loader.
Definition: LoadMf6File.f90:47
derived type for storing input definition for a file