!----- AGPL --------------------------------------------------------------------
!                                                                               
!  Copyright (C)  Stichting Deltares, 2015.                                     
!                                                                               
!  This file is part of Delft3D (D-Flow Flexible Mesh component).               
!                                                                               
!  Delft3D is free software: you can redistribute it and/or modify              
!  it under the terms of the GNU Affero General Public License as               
!  published by the Free Software Foundation version 3.                         
!                                                                               
!  Delft3D  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 Affero General Public License for more details.                          
!                                                                               
!  You should have received a copy of the GNU Affero General Public License     
!  along with Delft3D.  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",                  
!  "D-Flow Flexible Mesh" and "Deltares" are registered trademarks of Stichting 
!  Deltares, and remain the property of Stichting Deltares. All rights reserved.
!                                                                               
!-------------------------------------------------------------------------------

! $Id: network_data.f90 42642 2015-10-21 11:34:20Z dam_ar $
! $HeadURL: https://repos.deltares.nl/repos/ds/trunk/additional/unstruc/src/network_data.f90 $

!> Global network data (==unstructured grid).
!! \see network
!!
!! <table>
!! <tr><th>Concept:</th><th>Description:                      </th><th>Count:</th><th>Conventional index:</th><th>Example variables:</th></tr>
!! <tr><td>net node</td><td>Grid point                        </td><td>numk  </td><td>K                  </td><td>xk, nod, kc       </td></tr>
!! <tr><td>net link</td><td>Connects 2 nodes                  </td><td>numl  </td><td>L                  </td><td>kn, lne, lc       </td></tr>
!! <tr><td>net cell</td><td>Surface delimited by links (edges)</td><td>nump  </td><td>N                  </td><td>netcell           </td></tr>
!! </table>

! NOTE: this document is automatically parsed
! CONVENTION:
! please use the following variable notation so the parser will pickup variables for dynamic exchange
! {=optional}
! typename, {allocatable, }target :: name{(:)} !< {(altname)} [units] description {JSON}
! NOTE: only one variable definition per line, the variable should not continue on the next line.
!
! The JSON part can contain additional key-value pairs in JSON format, e.g.:
! !< [m] waterlevel at previous timestep {"state":true,"slice":"1:nodtot","standard_name":"sea_surface_height"}
!
! For state variables values the following JSON key-value pairs are required:
! "standard_name" is the netcdf standard name for the variable, e.g. "sea_surface_height"

module network_data

  use m_dimens
  use m_landboundary
  use m_polygon
  implicit none

  !> Type tnod describes connectivity for a net node (connected net links).
  !!
  !! For each link kn(1:2, L)==(/ k1, k2 /) there exist two entries:\n
  !! nod(k1)%lin(..) = L\n
  !! nod(k2)%lin(..) = L
  type tnod
     integer, ALLOCATABLE          :: lin(:)          !< Link nrs (==index in kn(:,L)).
  end type tnod

  type (tnod), allocatable         :: nod (:)         !< (numk) Net node connectivity.
  type (tnod), allocatable         :: nod0(:)         !< Backup for nod.


  !> Type tface describes a 'netcell', a cell with net nodes as vertices.
  type tface
    integer                        :: n               !< nr of nodes
    integer, allocatable           :: nod(:)          !< node nrs
    integer, allocatable           :: lin(:)          !< link nrs, kn(1 of 2,netcell(n)%lin(1)) =  netcell(n)%nod(1)  
  end type tface
  type (tface), allocatable        :: netcell(:)             !< (nump) 2D net cells (nodes and links)
  integer,  allocatable            :: cellmask(:)     !< (nump) Mask array for net cells

  double precision, allocatable, target :: xzw(:)  !< [m] centre of gravity {"shape": ["nump"]}
  double precision, allocatable, target :: yzw(:)  !< [m] centre of gravity {"shape": ["nump"]}
  

  ! Net node related
  double precision, allocatable, target :: xk(:) !< [-] Net node x coordinate {"shape": ["numk"]}
  double precision, allocatable, target :: yk(:) !< [-] Net node y coordinate {"shape": ["numk"]}
  double precision, allocatable, target :: zk(:) !< [-] Net node z coordinate {"shape": ["numk"]}
  double precision, allocatable    :: XK0(:), YK0(:), ZK0(:) !< Backup for xk, etc.
  double precision, allocatable    :: XK1(:), YK1(:), ZK1(:) !< Work array for xk, etc.
  real            , allocatable    :: RNOD(:)                !< Placeholder for node values to be displayed.

  real, allocatable    :: netlinkpath_xk(:), netlinkpath_yk(:), netlinkpath_zk(:)
  integer :: numpath
  integer, allocatable :: netlinkpath_end(:)
  
  integer,  allocatable            :: NMK (:)         !< (numk) Nr. of neighbouring netnodes for each netnode (ubound for nod(k)%lin).
  integer,  allocatable            :: KC  (:)         !< (numk) Mask array for net nodes.
  integer,  allocatable            :: NMK0(:)         !< Backup for nmk.
  integer,  allocatable            :: KC0 (:)         !< Backup for kc.
  integer,  allocatable            :: NB  (:)         !< (numk) Node codes (corner/boundary/internal classification)

  ! Net link related :
  integer,  allocatable, target    :: kn(:,:)         !< [-] Net links: kn(1,:)=from-idx, kn(2,:)=to-idx, kn(3,:)=net link type (0/1/2) {"shape": [3, "numl"]}
  integer,  allocatable            :: KN0 (:,:)       !< Backup for kn.
  integer,  allocatable            :: LC  (:)         !< (numl) Mask array for net links.
  integer,  allocatable            :: LC0 (:)         !< Backup for lc.
  real   , allocatable             :: RLIN(:)         !< (numl) Placeholder for link values to be displayed.
  double precision, allocatable    :: xe(:), ye(:)    !< (numl) Edge (link) center coordinates.
  integer,  allocatable            :: KTRI (:)  , KTON(:)  , KBT (:)

  ! Edge (and cell) related :      ! there are more edges than flow links .....
  integer, allocatable             :: lne(:,:)        !< (2,numl) Edge administration 1=nd1 , 2=nd2, rythm of kn
                                                      !! flow nodes between/next to which this net link lies.
  integer, allocatable             :: LNN(:)          !< (numl) Nr. of cells in which link participates (ubound for non-dummy values in lne(:,L))

  integer                          :: NUMK0, NUMK     !< Nr. of net nodes.
  integer                          :: NUML0, NUML     !< Total nr. of net links. In link arrays: 1D: 1:NUML1D, 2D: NUML1D+1:NUML
  integer                          :: NUML1D          !< Nr. of 1D net links.
  integer                          :: NUMP0, NUMP     !< Nr. of 2d netcells.
  integer                          :: nump1d2d        !< nr. of 1D and 2D netcells (2D netcells come first)
  integer                          :: KN3TYP = 2      !< Default netlink type (1D/2D).
  integer                          :: jconn = 0

  integer                          :: LNUMK = 0, LNUML = 0

  integer,  allocatable            :: ilin(:)           !< (numl) HELPARRAY for netw2curv
  integer,  allocatable            :: jlin(:)           !< (numl) HELPARRAY for netw2curv
  integer, allocatable             :: linkcross(:,:)    !< (2,nlinkcross) Helparray, pairs of net links that cross each other.
  integer                          :: nlinkcross        !< Nr. of crossing net links detected.
  integer, allocatable             :: linkbadqual(:)    !< (nlinkbadortho+nlinktoosmall) Net link nrs with a bad flow link orthogonality (>cosphiutrsh) or too short (<removesmalllinktrsh*...).
                                                        !! 1:nlinkbadortho for badortho links
                                                        !! nlinkbadortho+1:nlinkbadortho+nlinktoosmall for too short flow links.
  integer                          :: nlinkbadortho = 0 !< Nr. of net links with bad orthogonality detected.
  integer                          :: nlinktoosmall = 0 !< Nr. of net links with too small flow links across them.

  integer                          :: netflow = 2   ! 1=net, 2=flow

  integer                          :: JOCHECKNET = 0

  double precision                 :: zkUNI    = -5d0                   !< Uniform bottom level       (m)

!  integer                          :: jacenterinside = 1                !< Force cell center inside or not: 1 = inside, on edge ,  0 = true circumcenter 
  double precision                 :: dcenterinside = 1d0               !< Force cell center inside cell with factor dcenterinside, 1: confined by cell edges, 0: at mass center
 
  double precision                 :: removesmalllinkstrsh = 1d-1       !< 0.0 = remove no links ,  0.1 = remove links smaller than 0.1 sqrt(ba)  
                                                                        !< used for removelinks, but *also* in geominit: no flow link created if dx < dxtrsh  
 
  integer                          :: maxfaceallow = 4                  !< Nr. of faces allowed in removesmallflowlinks
                                                                        
  INTEGER                          :: NUMITCOURANT = 0                  !< Nr. of smooth. iter. in Courant network (need samples).

  double precision                 :: SMALLESTSIZEINCOURANT = 100d0     !< Smallest cellsize generated in Courant network.
 
  double precision                 :: TRIAREAREMFRAC = 0.2d0            !< Triangle to be removed if AREA < AV. ADJACAEREA.
 
  integer                          :: linmin = 0, linmax = 0, nodmin= 0, nodmax = 0, netcelmax = 0, netcelmin=0

  integer                          :: jathindams = 0                    !< For quick check whether any of the kn(3,:)==0

  integer                          :: M13QUAD = 0                       !< Quad refinement dir 0 = both, 1 =this, -1 = that.

  double precision                 :: cosphiutrsh = 0.5d0               !< No flow network generated if cosphiu > cospiutrsh  
  
  double precision                 :: CORNERCOS   = 0.25d0              !< threshold in makenetnodescoding cornerpoints

  double precision                 :: TOOCLOSE = 0.001d0                !< Network points closer than tooclose are merged

  double precision                 :: CONNECT1DEND = 200d0              !< Merge 1D endpoint ti closest branch point 

  double precision                 :: Unidx1D = 100d0                   !< Uniform 1D dx in copylandboundaryto1Dnetw  

  integer                          :: makeorthocenters = 0              !< shift from circumcentre to orthocentre  

! 1d NET BRANCHES
  type tNETbr                                        !< this is a NET branch type 
   integer                         :: nx             !< with nx links and nx + 1 nodes in it
   integer, allocatable            :: ln (:)         !< successive NET linknrs
!  parallel: this branch may belong to a larger globally connected branch, distributed in multiple domains
   integer                         :: iconn           !< connected-branch number this branch belongs to
   double precision                :: doff            !< offset length of this branch in global branch
  end type tNETBR
 
  INTEGER                          :: MXNETBR = 0
  type (tNETBR), allocatable       :: NETBR(:)       !< FOR 1d BRANCHES

  INTEGER, ALLOCATABLE             :: IBN(:), LIB(:), K1BR(:), NRLB(:)  ! TEMPORARY 
  
  integer                          :: lasttopology = 0                     ! network checker fingerprint  
  !  UNSWAN course
  integer                          :: jaswan = 0  
  
  
!  network administration status
  integer, parameter               :: NETSTAT_OK    = 0 !< Network administration up-to-date
  integer, parameter               :: NETSTAT_CELLS_DIRTY = 1 !< Network administration needs findcells call.
  integer                          :: netstat = NETSTAT_CELLS_DIRTY
  
! keep circumcenters before orthogonalization in case of quadtree meshes
  integer                          :: keepcircumcenters = 0    !< keep circumcenter (1) or not (0)

end module network_data