!-------------------------------------------------------------------------
!     NASA GSFC Land Information Systems LIS 2.3                         !
!-------------------------------------------------------------------------
!BOP
!
! !MODULE: lsm_pluginMod.F90  
! 
! !DESCRIPTION: 
!   This module contains the definition of the functions used for
!   land surface model initialization, execution, reading and 
!   writing of restart files and other relevant land surface
!   model computations, corresponding to each of the LSMs used in LIS.
!   
! !REVISION HISTORY: 
!  09 Oct 03    Sujay Kumar  Initial Specification
! 
! !INTERFACE:
module lsm_pluginMod
!EOP  
  implicit none
  
contains
!BOP
! !ROUTINE: lsm_plugin
!
! !DESCRIPTION:
!
! This is a custom-defined plugin point for introducing a new LSM. 
! The interface mandates that the following routines be implemented
! and registered for each of the LSM that is included in LIS. 
!
!  \begin{description}
!  \item[Initialization]
!      Definition of LSM variables 
!      (to be registered using registerlsmini)
!  \item[Setup] 
!      Initialization of parameters
!      (to be registered using registerlsmsetup)
!  \item[DynamicSetup]
!      Routines to setup time dependent parameters
!      (to be registered using registerlsmdynsetup)
!  \item[Run]
!      Routines to execute LSM on a single gridcell for single timestep
!      (to be registered using registerlsmrun)
!  \item[Read restart]
!      Routines to read a restart file for an LSM run
!      (to be registered using registerlsmrestart)
!  \item[Output]
!      Routines to write output
!      (to be registered using registerlsmoutput)
!  \item[Forcing transfer to model tiles]
!      Routines to transfer an array of given forcing to model tiles
!      (to be registered using registerlsmf2t)
!  \item[Write restart]
!      Routines to write a restart file
!      (to be registered using registerlsmwrst)
!  \end{description}
! Multiple LSMs can be 
! included as well, each distinguished in the function table registry
! by the associated LSM index assigned in the card file. 
! 
! !INTERFACE:
  subroutine lsm_plugin
! !USES:
    use ensemble1_varder
!EOP
    external ensemble1_setup
    external ensemble1_dynsetup
    external ensemble1_main
    external ensemble1rst
    external ensemble1_output
    external ensemble1_f2t
    external ensemble1_writerst

!BOC
    call registerlsmini(5,ensemble1_varder_ini)
    call registerlsmsetup(5,ensemble1_setup)
    call registerlsmdynsetup(5, ensemble1_dynsetup)
    call registerlsmrun(5, ensemble1_main)
    call registerlsmrestart(5,ensemble1rst)
    call registerlsmoutput(5,ensemble1_output)
    call registerlsmf2t(5, ensemble1_f2t)
    call registerlsmwrst(5, ensemble1_writerst)
!EOC         
  end subroutine lsm_plugin
end module lsm_pluginMod