InputDefinition.f90

Go to the documentation of this file.

!> @brief Input definition module.
!!
!! This module contains derived types that represent
!! input parameters as described in definition files.
!!
!<
module inputdefinitionmodule
 
  use kindmodule, only: lgp
  use constantsmodule, only: linelength, lenvarname, lencomponentname
 
  implicit none
  private
  public :: inputparamdefinitiontype, &
            inputblockdefinitiontype
 
  !> @brief Input parameter definition. Describes an input parameter.
  type inputparamdefinitiontype
    character(len=LENCOMPONENTNAME) :: component_type = '' !< type of component, e.g. GWF
    character(len=LENCOMPONENTNAME) :: subcomponent_type = '' !< type of subcomponent, e.g. CHD
    character(len=LINELENGTH) :: blockname = '' !< input block, e.g. DiMENSIONS
    character(len=LINELENGTH) :: tagname = '' !< parameter user tag name
    character(len=LENVARNAME) :: mf6varname = '' !< parameter internal managed memory name
    character(len=LINELENGTH) :: datatype = '' !< parameter data type
    character(len=LINELENGTH) :: shape = '' !< shape of data type
    character(len=LINELENGTH) :: longname = '' !< description of variable
    logical(LGP) :: required = .false. !< is the parameter required
    logical(LGP) :: developmode = .false. !< is the parameter developmode
    logical(LGP) :: in_record = .false. !< is the parameter within an input record
    logical(LGP) :: preserve_case = .false. !< should string case be preserved
    logical(LGP) :: layered = .false. !< does the parameter support a layered read
    logical(LGP) :: timeseries = .false. !< does the parameter support timeseries
  end type inputparamdefinitiontype
 
  !> @brief Input block definition. Describes an input block.
  type inputblockdefinitiontype
    character(len=LINELENGTH) :: blockname = '' !< name of block, e.g. DIMENSIONS
    logical(LGP) :: required = .false. !< is the block required
    logical(LGP) :: aggregate = .false. !< is this structarray style input
    logical(LGP) :: block_variable = .false. !< does this block have a block variable
    logical(LGP) :: timeseries = .false. !< does this block support timeseries
  end type inputblockdefinitiontype
 
end module inputdefinitionmodule