olfmodule Module Reference

Channel Flow (OLF) Module.

Data Types
type	olfmodeltype

Functions/Subroutines
subroutine, public	olf_cr (filename, id, modelname)
	Create a new overland flow model object. More...
subroutine	set_namfile_options (this)
	Handle namefile options. More...
subroutine	log_namfile_options (this, found)
	Write model namfile options to list file. More...

Variables
integer(i4b), parameter, public	olf_nbasepkg = 7
	OLF base package array descriptors. More...
character(len=lenpackagetype), dimension(olf_nbasepkg), public	olf_basepkg = ['DIS2D6 ', 'DISV2D6', 'DFW6 ', 'OC6 ', 'IC6 ', 'OBS6 ', 'STO6 ']
	candidates for input and these will be loaded in the order specified. More...
integer(i4b), parameter, public	olf_nmultipkg = 50
	OLF multi package array descriptors. More...
character(len=lenpackagetype), dimension(olf_nmultipkg), public	olf_multipkg
integer(i4b), parameter	niunit_olf = OLF_NBASEPKG + OLF_NMULTIPKG

Function/Subroutine Documentation

log_namfile_options()

subroutine olfmodule::log_namfile_options	(	class(olfmodeltype)	this,
		type(olfnamparamfoundtype), intent(in)	found
	)

Definition at line 130 of file olf.f90.

    use olfnaminputmodule, only: olfnamparamfoundtype
    class(OlfModelType) :: this
    type(OlfNamParamFoundType), intent(in) :: found
 
    write (this%iout, '(1x,a)') 'BEGIN NAMEFILE OPTIONS'
 
    if (found%print_input) then
      write (this%iout, '(4x,a)') 'STRESS PACKAGE INPUT WILL BE PRINTED '// &
        'FOR ALL MODEL STRESS PACKAGES'
    end if
 
    if (found%print_flows) then
      write (this%iout, '(4x,a)') 'PACKAGE FLOWS WILL BE PRINTED '// &
        'FOR ALL MODEL PACKAGES'
    end if
 
    if (found%save_flows) then
      write (this%iout, '(4x,a)') &
        'FLOWS WILL BE SAVED TO BUDGET FILE SPECIFIED IN OUTPUT CONTROL'
    end if
 
    write (this%iout, '(1x,a)') 'END NAMEFILE OPTIONS'
 

olf_cr()

subroutine, public olfmodule::olf_cr	(	character(len=*), intent(in)	filename,
		integer(i4b), intent(in)	id,
		character(len=*), intent(in)	modelname
	)

Parameters

[in]	filename	input file
[in]	id	consecutive model number listed in mfsim.nam
[in]	modelname	name of the model

Definition at line 54 of file olf.f90.

    ! modules
    ! dummy
    character(len=*), intent(in) :: filename !< input file
    integer(I4B), intent(in) :: id !< consecutive model number listed in mfsim.nam
    character(len=*), intent(in) :: modelname !< name of the model
    ! local
    class(OlfModelType), pointer :: this
    class(BaseModelType), pointer :: model
 
    ! Allocate a new model
    allocate (this)
    model => this
    call addbasemodeltolist(basemodellist, model)
 
    ! call parent initialize routine
    call this%initialize('OLF', filename, id, modelname)
 
    ! set and log namefile options
    call this%set_namfile_options()
 
    ! Create utility objects
    call budget_cr(this%budget, this%name)
 
    ! create model packages
    call this%create_packages()
 

Here is the call graph for this function:

Here is the caller graph for this function:

set_namfile_options()

subroutine olfmodule::set_namfile_options ( class(olfmodeltype)  this )

private

Set pointers to IDM namefile options, then create the list file and log options.

Definition at line 88 of file olf.f90.

    use simvariablesmodule, only: idm_context
    use memoryhelpermodule, only: create_mem_path
    use memorymanagerextmodule, only: mem_set_value
    use olfnaminputmodule, only: olfnamparamfoundtype
    class(OlfModelType) :: this
    type(OlfNamParamFoundType) :: found
    character(len=LENMEMPATH) :: input_mempath
    character(len=LINELENGTH) :: lst_fname
 
    ! set input model namfile memory path
    input_mempath = create_mem_path(this%name, 'NAM', idm_context)
 
    ! copy option params from input context
    call mem_set_value(lst_fname, 'LIST', input_mempath, found%list)
    call mem_set_value(this%inewton, 'NEWTON', input_mempath, found%newton)
    call mem_set_value(this%inewtonur, 'UNDER_RELAXATION', input_mempath, &
                       found%under_relaxation)
    call mem_set_value(this%iprpak, 'PRINT_INPUT', input_mempath, &
                       found%print_input)
    call mem_set_value(this%iprflow, 'PRINT_FLOWS', input_mempath, &
                       found%print_flows)
    call mem_set_value(this%ipakcb, 'SAVE_FLOWS', input_mempath, found%save_flows)
 
    ! create the list file
    call this%create_lstfile(lst_fname, this%filename, found%list, &
                             'CHANNEL FLOW MODEL (OLF)')
 
    ! activate save_flows if found
    if (found%save_flows) then
      this%ipakcb = -1
    end if
 
    ! log set options
    if (this%iout > 0) then
      call this%log_namfile_options(found)
    end if
 

Here is the call graph for this function:

Variable Documentation

niunit_olf

integer(i4b), parameter olfmodule::niunit_olf = OLF_NBASEPKG + OLF_NMULTIPKG

private

Definition at line 48 of file olf.f90.

  integer(I4B), parameter :: NIUNIT_OLF = olf_nbasepkg + olf_nmultipkg

olf_basepkg

character(len=lenpackagetype), dimension(olf_nbasepkg), public olfmodule::olf_basepkg = ['DIS2D6 ', 'DISV2D6', 'DFW6 ', 'OC6 ', 'IC6 ', 'OBS6 ', 'STO6 ']

Definition at line 33 of file olf.f90.

  character(len=LENPACKAGETYPE), dimension(OLF_NBASEPKG) :: &
    OLF_BASEPKG = ['DIS2D6 ', 'DISV2D6', 'DFW6   ', &
                   'OC6    ', 'IC6    ', 'OBS6   ', &
                   'STO6   ']

olf_multipkg

character(len=lenpackagetype), dimension(olf_nmultipkg), public olfmodule::olf_multipkg

Definition at line 43 of file olf.f90.

  character(len=LENPACKAGETYPE), dimension(OLF_NMULTIPKG) :: OLF_MULTIPKG

olf_nbasepkg

integer(i4b), parameter, public olfmodule::olf_nbasepkg = 7

OLF model base package types. Only listed packages are candidates

Definition at line 32 of file olf.f90.

  integer(I4B), parameter :: OLF_NBASEPKG = 7

olf_nmultipkg

integer(i4b), parameter, public olfmodule::olf_nmultipkg = 50

OLF model multi-instance package types. Only listed packages are

Definition at line 42 of file olf.f90.

  integer(I4B), parameter :: OLF_NMULTIPKG = 50