chfmodule Module Reference

Channel Flow (CHF) Module.

Data Types
type	chfmodeltype

Functions/Subroutines
subroutine, public	chf_cr (filename, id, modelname)
	Create a new surface water 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	chf_nbasepkg = 7
	CHF base package array descriptors. More...
character(len=lenpackagetype), dimension(chf_nbasepkg), public	chf_basepkg = ['DISV1D6', 'DFW6 ', 'CXS6 ', 'OC6 ', 'IC6 ', 'OBS6 ', 'STO6 ']
	candidates for input and these will be loaded in the order specified. More...
integer(i4b), parameter, public	chf_nmultipkg = 50
	CHF multi package array descriptors. More...
character(len=lenpackagetype), dimension(chf_nmultipkg), public	chf_multipkg
integer(i4b), parameter	niunit_chf = CHF_NBASEPKG + CHF_NMULTIPKG

Function/Subroutine Documentation

chf_cr()

subroutine, public chfmodule::chf_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 chf.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(ChfModelType), 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('CHF', 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:

log_namfile_options()

subroutine chfmodule::log_namfile_options	(	class(chfmodeltype)	this,
		type(chfnamparamfoundtype), intent(in)	found
	)

Definition at line 130 of file chf.f90.

    use chfnaminputmodule, only: chfnamparamfoundtype
    class(ChfModelType) :: this
    type(ChfNamParamFoundType), 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'
 

set_namfile_options()

subroutine chfmodule::set_namfile_options ( class(chfmodeltype)  this )

private

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

Definition at line 88 of file chf.f90.

    use simvariablesmodule, only: idm_context
    use memoryhelpermodule, only: create_mem_path
    use memorymanagerextmodule, only: mem_set_value
    use chfnaminputmodule, only: chfnamparamfoundtype
    class(ChfModelType) :: this
    type(ChfNamParamFoundType) :: 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 (CHF)')
 
    ! 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

chf_basepkg

character(len=lenpackagetype), dimension(chf_nbasepkg), public chfmodule::chf_basepkg = ['DISV1D6', 'DFW6 ', 'CXS6 ', 'OC6 ', 'IC6 ', 'OBS6 ', 'STO6 ']

Definition at line 33 of file chf.f90.

  character(len=LENPACKAGETYPE), dimension(CHF_NBASEPKG) :: &
    CHF_BASEPKG = ['DISV1D6', 'DFW6   ', 'CXS6   ', &
                   'OC6    ', 'IC6    ', 'OBS6   ', &
                   'STO6   ']

chf_multipkg

character(len=lenpackagetype), dimension(chf_nmultipkg), public chfmodule::chf_multipkg

Definition at line 43 of file chf.f90.

  character(len=LENPACKAGETYPE), dimension(CHF_NMULTIPKG) :: CHF_MULTIPKG

chf_nbasepkg

integer(i4b), parameter, public chfmodule::chf_nbasepkg = 7

CHF model base package types. Only listed packages are candidates

Definition at line 32 of file chf.f90.

  integer(I4B), parameter :: CHF_NBASEPKG = 7

chf_nmultipkg

integer(i4b), parameter, public chfmodule::chf_nmultipkg = 50

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

Definition at line 42 of file chf.f90.

  integer(I4B), parameter :: CHF_NMULTIPKG = 50

niunit_chf

integer(i4b), parameter chfmodule::niunit_chf = CHF_NBASEPKG + CHF_NMULTIPKG

private

Definition at line 48 of file chf.f90.

  integer(I4B), parameter :: NIUNIT_CHF = chf_nbasepkg + chf_nmultipkg