module wave_boundary_datastore
   ! The module stores essential information for wave boundary conditions in the following
   ! derived types:
   !  - waveBoundaryParameters
   !  - waveBoundaryAdministration
   !  - waveBoundaryTimeSeries
   !  - waveSpectrumAdministration
   !
   ! These derived types are accessed by wave_boundary_main, wave_boundary_init and
   ! wave_boundary_update
   implicit none
   save
   !
   !
   ! Define derived type to store wave parameter information
   type waveBoundaryParametersType
      character(1024)                  :: masterFileName
      integer                          :: np,ntheta
      real*8                           :: x0,y0
      real*8                           :: hboundary
      logical                          :: nonhspectrum
      real*8                           :: sprdthr,trepfac
      integer                          :: Tm01switch
      real*8,dimension(:),allocatable  :: xb,yb,theta     ! Note, can these be changed to pointers?
      integer                          :: randomseed
      integer                          :: nspr
      real*8                           :: rho
      real*8                           :: nmax
      real*8                           :: fcutoff
   end type waveBoundaryParametersType
   !
   !
   ! Define derived type to store information on boundary condition file (only required for
   ! spectral wave boundary conditions
   type filenames
      character(1024)                        :: fname  ! file name of boundary condition file
      integer                                :: listline ! read position in FILELIST files
      logical                                :: repeat = .false. ! indicate to repeat this file every rtbc cycle
   endtype filenames
   !
   !
   ! Define derived type to store wave boundary administration information
   type waveBoundaryAdministrationType
      logical                                 :: initialized = .false.   ! Initialisation status
      real*8                                  :: startComputeNewSeries   ! Time at which to compute a boundary condition time series (s)
      real*8                                  :: startCurrentSeries      ! Time at which current boundary conditions started (s)
   end type waveBoundaryAdministrationType
   !
   !
   ! Define derived type to store spectral boundary administration information
   type waveSpectrumAdministrationType
      integer                                  :: nspectra        ! number of input spectrs, set in init spectrum
      type(filenames),dimension(:),allocatable :: bcfiles         ! input wave spectrum files
      logical                                  :: repeatwbc       ! switch to repeat all of the wave boundary conditions
      integer                                  :: bccount         ! number of times boundary conditions have been generated, set in init spectrum
      real*8                                   :: spectrumendtime ! end time of boundary condition written to administration file
      real*8,dimension(:,:),allocatable        :: lastwaveelevation ! wave height at the end of the last spectrum
      real*8,dimension(:),allocatable          :: xspec,yspec     ! x,y coordinates of input wave spectra
      real*8                                   :: Hbc,Tbc,Dbc     ! computed representative wave height, period and wave direction
   end type waveSpectrumAdministrationType
   !
   !
   ! Define derived type to store wave boundary time series information
   type waveBoundaryTimeSeriesType
      real*8,dimension(:,:,:),allocatable  :: eebct
      real*8,dimension(:,:),allocatable    :: qxbct,qybct
      real*8,dimension(:,:),allocatable    :: zsbct,ubct,vbct,wbct
      real*8,dimension(:),allocatable      :: tbc
   end type waveBoundaryTimeSeriesType
   !
   !
   ! Declare variables of type above
   type(waveBoundaryParametersType)       :: waveBoundaryParameters
   type(waveBoundaryAdministrationType)   :: waveBoundaryAdministration
   type(waveBoundaryTimeSeriesType)       :: waveBoundaryTimeSeries
   type(waveSpectrumAdministrationType)   :: waveSpectrumAdministration

end module wave_boundary_datastore