mod_user Module Reference

module USER More...

Functions/Subroutines
subroutine, public	user_tracer_setup
	Config before setup of tracers. More...
subroutine, public	user_setup
	Setup before setup of other components. More...
subroutine, public	user_finalize
	Finalization. More...
subroutine, public	user_mkinit
	Make initial state. More...
subroutine, public	user_calc_tendency
	Calculation tendency. More...
subroutine, public	user_update
	User step. More...

Detailed Description

module USER

Description

User defined module

Author

Team SCALE

NAMELIST

• PARAM_USER

  name	type	default value	comment
  USER_DO	logical	.false.	do user step?

  
  

History Output

No history output

Function/Subroutine Documentation

user_tracer_setup()

subroutine, public mod_user::user_tracer_setup

Config before setup of tracers.

Definition at line 55 of file mod_user.F90.

    use scale_tracer, only: &
       tracer_regist
    implicit none
 
    ! if you want to add tracers, call the TRACER_regist subroutine.
    ! e.g.,
!    integer, parameter     :: NQ = 1
!    integer                :: QS
!    character(len=H_SHORT) :: NAME(NQ)
!    character(len=H_MID)   :: DESC(NQ)
!    character(len=H_SHORT) :: UNIT(NQ)
!
!    data NAME (/ 'name' /)
!    data DESC (/ 'tracer name' /)
!    data UNIT (/ 'kg/kg' /)
    !---------------------------------------------------------------------------
 
!    call TRACER_regist( QS,   & ! [OUT]
!                        NQ,   & ! [IN]
!                        NAME, & ! [IN]
!                        DESC, & ! [IN]
!                        UNIT  ) ! [IN]
 
    return

References scale_tracer::tracer_regist().

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

Here is the call graph for this function:

Here is the caller graph for this function:

user_setup()

subroutine, public mod_user::user_setup

Setup before setup of other components.

Definition at line 84 of file mod_user.F90.

    use scale_prc, only: &
       prc_abort
    implicit none
 
    namelist / param_user / &
       user_do
 
    integer :: ierr
    !---------------------------------------------------------------------------
 
    log_newline
    log_info("USER_setup",*) 'Setup'
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_user,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("USER_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("USER_setup",*) 'Not appropriate names in namelist PARAM_USER. Check!'
       call prc_abort
    endif
    log_nml(param_user)
 
    log_newline
    log_info("USER_setup",*) 'This module is dummy.'
 
    return

References scale_io::io_fid_conf, and scale_prc::prc_abort().

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

Here is the call graph for this function:

Here is the caller graph for this function:

user_finalize()

subroutine, public mod_user::user_finalize

Finalization.

Definition at line 117 of file mod_user.F90.

    implicit none
    !---------------------------------------------------------------------------
 
    return

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

Here is the caller graph for this function:

user_mkinit()

subroutine, public mod_user::user_mkinit

Make initial state.

Definition at line 126 of file mod_user.F90.

    implicit none
    !---------------------------------------------------------------------------
 
    return

Referenced by mod_rm_prep::rm_prep().

Here is the caller graph for this function:

user_calc_tendency()

subroutine, public mod_user::user_calc_tendency

Calculation tendency.

Definition at line 135 of file mod_user.F90.

    implicit none
    !---------------------------------------------------------------------------
 
    return

Referenced by mod_rm_driver::restart_read(), and mod_rm_driver::rm_driver().

Here is the caller graph for this function:

user_update()

subroutine, public mod_user::user_update

User step.

Definition at line 144 of file mod_user.F90.

    use scale_prc, only: &
       prc_abort
    implicit none
    !---------------------------------------------------------------------------
 
    if ( user_do ) then
       call prc_abort
    endif
 
    return

References scale_prc::prc_abort().

Referenced by mod_rm_driver::rm_driver().

Here is the call graph for this function:

Here is the caller graph for this function: