mod_da_param_estimation Module Reference

module Parameter Estimation More...

Functions/Subroutines
subroutine, public	da_param_estimation_setup
	Setup. More...
subroutine, public	da_param_estimation_finalize
	finalize More...
subroutine, public	da_param_estimation_update
	Data Assimilation. More...

Detailed Description

module Parameter Estimation

Description

Parameter Estimation

Author

Team SCALE

NAMELIST

• PARAM_DA_PARAM_ESTIMATION

  name	type	default value	comment
  ESTIMATION_TARGET	character(len=H_SHORT), dimension(MAXNUM_PARAM_ESTIMATION)
  PEST_TRANSLATION	logical, dimension(MAXNUM_PARAM_ESTIMATION)
  PEST_ULIMIT	real(RP), dimension(MAXNUM_PARAM_ESTIMATION)
  PEST_LLIMIT	real(RP), dimension(MAXNUM_PARAM_ESTIMATION)

  
  

History Output

No history output

Function/Subroutine Documentation

da_param_estimation_setup()

subroutine, public mod_da_param_estimation::da_param_estimation_setup

Setup.

Definition at line 70 of file mod_da_param_estimation.F90.

    use mpi
    use scale_prc, only: &
       prc_abort
    use scale_comm_ensemble, only: &
       ensemble_nprocs => comm_ensemble_nprocs, &
       ensemble_myrank => comm_ensemble_myrank
    implicit none
 
    namelist / param_da_param_estimation / &
       estimation_target, &
       pest_translation,  &
       pest_ulimit,       &
       pest_llimit
 
    integer :: v
    integer :: ierr
    !---------------------------------------------------------------------------
 
    num_param_estimation = 0
    do_param_estimation = .false.
 
    estimation_target(:) = ''
 
    pest_translation(:) = .false.
 
    pest_ulimit(:) = huge(0.0_rp)
    pest_llimit(:) = -huge(0.0_rp)
 
    !--- gather parameters from ensemble communication
    if     ( rp == sp ) then
       datatype = mpi_real
    else if( rp == dp ) then
       datatype = mpi_double_precision
    else
       log_error("DA_param_estimation_setup",*) 'The precision has not been implemented yet:', rp
       call prc_abort
    endif
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_da_param_estimation,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("DA_param_estimation_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("DA_param_estimation_setup",*) 'Not appropriate names in namelist PARAM_DA_PARAM_ESTIMATION. Check!'
       call prc_abort
    endif
    log_nml(param_da_param_estimation)
 
    do v = 1, maxnum_param_estimation
      if( trim(estimation_target(v)) /= '' ) then
        num_param_estimation = num_param_estimation + 1
      end if
    end do
 
    if( num_param_estimation > maxnum_param_estimation ) then
       log_error("DA_param_estimation_setup",*) 'NUM_PARAM_ESTIMATION has exceeded the limit! ( MAX = ', maxnum_param_estimation, ')'
       call prc_abort
    end if
 
    if( num_param_estimation > 0 ) then
      log_info("DA_param_estimation_setup",*) 'Set up Parameter Estimation module. The number of estimation target:', num_param_estimation
      do_param_estimation = .true.
 
      allocate( param_array( ensemble_nprocs, num_param_estimation ) )
 
      call estimation_getvar
      call estimation_log
 
    end if
 
    return

References scale_comm_ensemble::comm_ensemble_myrank, scale_comm_ensemble::comm_ensemble_nprocs, scale_precision::dp, scale_io::io_fid_conf, scale_prc::prc_abort(), and scale_precision::sp.

Referenced by mod_da_driver::da_driver_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

da_param_estimation_finalize()

subroutine, public mod_da_param_estimation::da_param_estimation_finalize

finalize

Definition at line 147 of file mod_da_param_estimation.F90.

    implicit none
    !---------------------------------------------------------------------------
 
    if( allocated( param_array ) ) deallocate( param_array )
 
    return

Referenced by mod_da_driver::da_driver_finalize().

Here is the caller graph for this function:

da_param_estimation_update()

subroutine, public mod_da_param_estimation::da_param_estimation_update

Data Assimilation.

Definition at line 158 of file mod_da_param_estimation.F90.

    use scale_comm_ensemble, only: &
      ensemble_nprocs => comm_ensemble_nprocs
    use scale_letkf, only: &
      letkf_param_estimation_system
    implicit none
 
    integer :: n, v
    !---------------------------------------------------------------------------
 
    if( .NOT. do_param_estimation ) return
 
    !--- get parameters for estimation
    call estimation_getvar
 
    do v = 1, num_param_estimation
    do n = 1, ensemble_nprocs
       if( pest_translation(v) ) then ! encoding function by Kotsuki (2015)
          param_array(n,v) = phys2func( v, param_array(n,v) )
       end if
    end do
    end do
 
    !--- execute parameter estimation
    call letkf_param_estimation_system( num_param_estimation, &
                                        param_array(:,:)      )
 
    do v = 1, num_param_estimation
    do n = 1, ensemble_nprocs
       if( pest_translation(v) ) then ! decoding function by Kotsuki (2015)
          param_array(n,v) = func2phys( v, param_array(n,v) )
       end if
    end do
    end do
 
    !--- overwrite parameters
    call estimation_putvar
    call estimation_log
 
    return

References scale_atmos_phy_cp_kf::atmos_phy_cp_kf_getvar(), scale_atmos_phy_cp_kf::atmos_phy_cp_kf_putvar(), scale_atmos_phy_mp_tomita08::atmos_phy_mp_tomita08_getvar(), scale_atmos_phy_mp_tomita08::atmos_phy_mp_tomita08_putvar(), scale_comm_ensemble::comm_ensemble_myrank, scale_comm_ensemble::comm_ensemble_nprocs, scale_comm_ensemble::comm_ensemble_world, scale_const::const_undef, scale_letkf::letkf_param_estimation_system(), scale_prc::prc_abort(), and scale_time::time_nowdate.

Referenced by mod_da_driver::da_driver_update().

Here is the call graph for this function:

Here is the caller graph for this function: