!----- LGPL --------------------------------------------------------------------
!                                                                               
!  Copyright (C)  Stichting Deltares, 2011-2013.                                
!                                                                               
!  This library is free software; you can redistribute it and/or                
!  modify it under the terms of the GNU Lesser General Public                   
!  License as published by the Free Software Foundation version 2.1.            
!                                                                               
!  This library is distributed in the hope that it will be useful,              
!  but WITHOUT ANY WARRANTY; without even the implied warranty of               
!  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU            
!  Lesser General Public License for more details.                              
!                                                                               
!  You should have received a copy of the GNU Lesser General Public             
!  License along with this library; if not, see <http://www.gnu.org/licenses/>. 
!                                                                               
!  contact: delft3d.support@deltares.nl                                         
!  Stichting Deltares                                                           
!  P.O. Box 177                                                                 
!  2600 MH Delft, The Netherlands                                               
!                                                                               
!  All indications and logos of, and references to, "Delft3D" and "Deltares"    
!  are registered trademarks of Stichting Deltares, and remain the property of  
!  Stichting Deltares. All rights reserved.                                     

!  $Id$
!  $HeadURL$

!> This module contains the Ec-module's enumerations and constants.
!! @author arjen.markus@deltares.nl
!! @author adri.mourits@deltares.nl
!! @author stef.hummel@deltares.nl
!! @author edwin.bos@deltares.nl
module m_ec_parameters
   use precision
   
   implicit none
   
   integer,  parameter :: maxNameLen           = 100
   integer,  parameter :: maxRecordLen         = 132
   integer,  parameter :: maxFileNameLen       = 256
   integer,  parameter :: maxFileReaderFiles   = 3
   integer,  parameter :: maxFileUnits         = 1000
   
   integer,  parameter :: EC_MISSING_VALUE = -999
   integer,  parameter :: ec_undef_int = -987
   real(fp), parameter :: ec_undef_fp = -9.87e+05_fp
   real(hp), parameter :: ec_undef_hp = -9.87e+10_hp
   
   integer, parameter :: ec_second = 1
   integer, parameter :: ec_minute = 2
   integer, parameter :: ec_hour   = 3
   
   !> Enumeration for tEcElementSet role
   integer, parameter :: elmSetType_undefined             = 0
   integer, parameter :: elmSetType_Cartesian             = 1
   integer, parameter :: elmSetType_Cartesian_equidistant = 2
   integer, parameter :: elmSetType_spheric               = 3
   integer, parameter :: elmSetType_spheric_equidistant   = 4
   integer, parameter :: elmSetType_Ids                   = 5
   integer, parameter :: elmSetType_Grib                  = 6
   integer, parameter :: elmSetType_spw                   = 7
   integer, parameter :: elmSetType_cart_gk               = 8
   integer, parameter :: elmSetType_scalar                = 9 ! This is a single point, without a location.
   integer, parameter :: elmSetType_polytim               = 10
   
   !> Enumeration for tEcItem role
   integer, parameter :: itemType_undefined = 0
   integer, parameter :: itemType_source    = 1
   integer, parameter :: itemType_target    = 2
   
   
   !> enumeration for tEcFileReader filetypes
   integer, parameter :: provFile_undefined           =  0
   integer, parameter :: provFile_uniform             =  1  !< kx values each timestep 1 dim arr       uni
   integer, parameter :: provFile_unimagdir           =  2  !< 2 values each timestep; magnitide, direction
   integer, parameter :: provFile_svwp                =  3  !< 3 fields each timestep 3 dim array      noint
   integer, parameter :: provFile_svwp_weight         =  4  !< 3 fields each timestep 3 dim array      noint
   integer, parameter :: provFile_arcinfo             =  5  !< 1 field each timestep 2 dim array        bilin/direct
   integer, parameter :: provFile_spiderweb           =  6  !< 3 field each timestep 3 dim array        bilin/spw
   integer, parameter :: provFile_curvi               =  7  !< 1 field each timestep 2 dim array        bilin/findnm
   integer, parameter :: provFile_curvi_weight        =  8  !< 1 field each timestep 2 dim array        bilin/findnm
   integer, parameter :: provFile_triangulation       =  9  !< 1 field each timestep                    triang
   integer, parameter :: provFile_triangulationmagdir = 10  !< 2 fields u,v each tijdstap 3 dim array  triang, vectormax = 2
                                                            !! based on timeseries of wind at stations mag/dir
   integer, parameter :: provFile_poly_tim            = 11  !< for line oriented bnd conditions, refs to uniform, fourier or harmonic
   integer, parameter :: provFile_fourier             = 12  !< period(hrs), ampl(m), phas(deg)
   integer, parameter :: provFile_grib                = 13  !< grib files from KNMI
   integer, parameter :: provFile_netcdf              = 14  !< NetCDF files
   integer, parameter :: provFile_qhtable             = 15  !< 
   integer, parameter :: provFile_t3D                 = 16  !< temporary type for 3D salinity boundaries
   integer, parameter :: provFile_bc                  = 17  !< BC-format
   integer, parameter :: provFile_fourier_cor         = 18  !< period(hrs), ampl(m), phas(deg) correction 
   
   ! enumeration for access types
   integer, parameter :: accessType_undefined     = 0
   integer, parameter :: accessType_fileReader    = 1
   integer, parameter :: accessType_fileWriter    = 2
   integer, parameter :: accessType_memory        = 3
   integer, parameter :: accessType_evaluate      = 4

   ! enumeration for interpolation types
   integer, parameter :: interpolate_unknown                    = 0 !< type is uninitialized
   integer, parameter :: interpolate_passthrough                = 1 !< no interpolation is performed
   integer, parameter :: interpolate_timespace                  = 2 !< interpolate in time, then in space
   integer, parameter :: interpolate_spacetime                  = 3 !< interpolate in space, then in time
   integer, parameter :: interpolate_time                       = 4 !< interpolate in time
   integer, parameter :: interpolate_space                      = 5 !< interpolate in space
   integer, parameter :: interpolate_spacetimeSaveWeightFactors = 6 !< interpolate in space, save the space weight factors, then interpolate in time
   integer, parameter :: interpolate_time_extrapolation_ok      = 7 !< interpolate in time
   !
   ! enumeration for operand types
   integer, parameter :: operand_undefined       = 0
   integer, parameter :: operand_add             = 1
   integer, parameter :: operand_replace         = 2
   integer, parameter :: operand_replace_element = 3
   !
   ! enumeration for tEcConverter types
   integer, parameter :: convType_undefined = 0
   !integer, parameter :: convType_default   = 1
   integer, parameter :: convType_unimagdir = 2 !< first time, then space
   integer, parameter :: convType_uniform = 3 !< only time
   !integer, parameter :: convType_svwp      = 4
   !integer, parameter :: convType_svwp_cpu  = 5
   !integer, parameter :: convType_grib      = 6
   !integer, parameter :: convType_ById      = 7
   integer, parameter :: convType_fourier = 8
   integer, parameter :: convType_arcinfo = 9
   integer, parameter :: convType_curvi = 10
   integer, parameter :: convType_uniform_to_magnitude = 11 !< first time, then space
   integer, parameter :: convType_polytim = 12
   integer, parameter :: convType_spiderweb = 13
   integer, parameter :: convType_netcdf = 14 
   integer, parameter :: convType_qhtable = 15 
   integer, parameter :: convType_sigma   = 16

   
   ! Error states, in addition to success=.true./.false. returns.
   integer, parameter :: EC_UNKNOWN_ERROR      = -1 !< Unknown error.
   integer, parameter :: EC_NOERR              = 0  !< Success
   integer, parameter :: EC_DATA_NOTFOUND      = 11 !< Data not found in data source. May not be problematic if data is optional.
   integer, parameter :: EC_METADATA_INVALID   = 12 !< Meta-data was mal-formatted or incomplete.
   integer, parameter :: EC_DATA_INVALID       = 13 !< Data was mal-formatted or incomplete.
   integer, parameter :: EC_EOF                = 14 !< EOF reached/file ended prematurely.

    !------------------------ BC-header related parameters ----------------------------------
    ! Function types 
    integer, parameter :: BC_FUNC_TSERIES      = 1   !< timeseries     
    integer, parameter :: BC_FUNC_HARMONIC     = 2   !< harmonic
    integer, parameter :: BC_FUNC_ASTRO        = 3   !< astronomic
    integer, parameter :: BC_FUNC_HARMOCORR    = 4   !< harmonic correction
    integer, parameter :: BC_FUNC_ASTROCORR    = 5   !< astronomic correction
    integer, parameter :: BC_FUNC_QHTABLE      = 6   !< qh-relation
    integer, parameter :: BC_FUNC_TIM3D        = 7   !< t3d  timeseries 
    integer, parameter :: BC_FUNC_CMP3D        = 8   !< t3d  components 

    ! Time interpolation type 
    integer, parameter :: BC_TIMEINT_LIN       = 1   !< linear
    integer, parameter :: BC_TIMEINT_BTO       = 2   !< block-to 
    integer, parameter :: BC_TIMEINT_BFROM     = 3   !< block-from 

    ! Vertical position type 
    integer, parameter :: BC_VPTYP_PERCBED     = 1   !< precentage from bed 
    integer, parameter :: BC_VPTYP_ZDATUM      = 2   !< z above datum 
    integer, parameter :: BC_VPTYP_BEDSURF     = 3   !< bedsurface 
    integer, parameter :: BC_VPTYP_PERCSURF    = 4   !< percentage from surface 
    integer, parameter :: BC_VPTYP_ZBED        = 5   !< z from bed 
    integer, parameter :: BC_VPTYP_ZSURF       = 6   !< z from surface 

    ! Vertical interpolation type 
    integer, parameter :: BC_VERTINT_LIN       = 1   !< linear
    integer, parameter :: BC_VERTINT_LOG       = 2   !< log
    integer, parameter :: BC_VERTINT_BLOCK     = 3   !< block
    !------------------------ BC-header related parameters ----------------------------------
   
end module m_ec_parameters

module m_ec_magic_number
   use precision
   implicit none
   real(hp), dimension(:), allocatable :: magic_array
end module m_ec_magic_number