mod_user Module Reference

module USER More...

Functions/Subroutines
subroutine, public	user_config
	Config before setup of other components. More...
subroutine, public	user_setup
	Setup before setup of other components. More...
subroutine, public	user_resume0
	Resuming operation, before calculating tendency. More...
subroutine, public	user_resume
	Resuming operation. More...
subroutine, public	user_step
	User step. More...

Detailed Description

module USER

Description

User defined module

Author

Team SCALE

History

• 2012-12-26 (H.Yashiro) [new]

NAMELIST

• PARAM_USER

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

  
  

History Output

No history output

Function/Subroutine Documentation

user_config()

subroutine, public mod_user::user_config

(

)

Config before setup of other components.

Definition at line 56 of file mod_user.f90.

References scale_tracer::tracer_regist().

Referenced by mod_rm_driver::scalerm(), and mod_rm_prep::scalerm_prep().

    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

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 85 of file mod_user.f90.

References scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_fid_nml, scale_stdio::io_l, scale_stdio::io_nml, and scale_process::prc_mpistop().

Referenced by mod_rm_driver::scalerm().

    use scale_process, only: &
       prc_mpistop
    implicit none

    namelist / param_user / &
       user_do

    integer :: ierr
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[DRIVER] / Categ[USER] / Origin[SCALE-RM]'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_user,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       write(*,*) 'xxx Not appropriate names in namelist PARAM_USER. Check!'
       call prc_mpistop
    endif
    if( io_nml ) write(io_fid_nml,nml=param_user)

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '*** This module is dummy.'

    return

Here is the call graph for this function:

Here is the caller graph for this function:

user_resume0()

subroutine, public mod_user::user_resume0

(

)

Resuming operation, before calculating tendency.

Definition at line 118 of file mod_user.f90.

Referenced by mod_rm_driver::resume_state().

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

    ! If you need, calculate first step and put diagnostic value to history buffer.
    ! USER_resume0 calls before setup of Atmos/Ocean/Land/Urban submodels.
    ! All variables are set before surface coupling.

    !call USER_step

    return

Here is the caller graph for this function:

user_resume()

subroutine, public mod_user::user_resume

(

)

Resuming operation.

Definition at line 133 of file mod_user.f90.

Referenced by mod_rm_driver::resume_state().

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

    ! If you need, calculate first step and put diagnostic value to history buffer.
    ! USER_resume calls after setup of Atmos/Ocean/Land/Urban submodels.
    ! All variables are set after surface coupling.

    !call USER_step

    return

Here is the caller graph for this function:

user_step()

subroutine, public mod_user::user_step

(

)

User step.

Definition at line 148 of file mod_user.f90.

References scale_process::prc_mpistop().

Referenced by mod_rm_driver::scalerm().

    use scale_process, only: &
       prc_mpistop
    implicit none
    !---------------------------------------------------------------------------

    if ( user_do ) then
       call prc_mpistop
    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function: