initialize.f90

!!
!!  Copyright (C) 2011-2017  Johns Hopkins University
!!
!!  This file is part of lesgo.
!!
!!  lesgo is free software: you can redistribute it and/or modify
!!  it under the terms of the GNU General Public License as published by
!!  the Free Software Foundation, either version 3 of the License, or
!!  (at your option) any later version.
!!
!!  lesgo 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 General Public License for more details.
!!
!!  You should have received a copy of the GNU General Public License
!!  along with lesgo.  If not, see <http://www.gnu.org/licenses/>.
!!

!*******************************************************************************
subroutine initialize()
!*******************************************************************************
!
! This subroutine is a driver that calls all top-level initialization
! subroutines.
!
use types, only : rprec
use param, only : path
use param, only : USE_MPI, coord, dt, jt_total, nsteps
use param, only : use_cfl_dt, cfl, cfl_f, dt_dim, z_i, u_star
use iwmles
use param, only : lbc_mom
use sponge
#ifdef PPMPI
use param, only : MPI_COMM_WORLD, ierr
#else
use param, only : chcoord, nproc
#endif

use cfl_util
use io, only : output_init
use sgs_param, only : sgs_param_init
use input_util, only : read_input_conf
use test_filtermodule, only : test_filter_init
use sim_param, only : sim_param_init
use grid_m
use fft, only : init_fft
use io, only : openfiles
use coriolis
use inflow, only : inflow_init

#ifdef PPMPI
use mpi_defs, only : initialize_mpi
#ifdef PPCPS
use concurrent_precursor, only : initialize_cps
#endif
#endif

#ifdef PPLVLSET
use level_set_base, only : level_set_base_init
use level_set, only : level_set_init
#endif

#ifdef PPTURBINES
use turbines, only : turbines_init, turbines_forcing
#endif

! HIT Inflow
#ifdef PPHIT
use hit_inflow, only : initialize_HIT
#endif

#ifdef PPATM
use atm_lesgo_interface, only : atm_lesgo_initialize
#endif

#ifdef PPSCALARS
use scalars, only : scalars_init
#endif

implicit none

! Create output directory
if (coord == 0) call system( 'mkdir -p ' // path // 'output' )

! Initialize MPI
#ifdef PPMPI
call initialize_mpi()
#else
if (nproc /= 1) then
    write (*, *) 'nproc /=1 for non-MPI run is an error'
    stop
end if
if (USE_MPI) then
    write (*, *) 'inconsistent use of USE_MPI and CPP MPI flag'
    stop
end if
chcoord = ''
#endif

! Read input file
! This obtains all major data defined in param
call read_input_conf()

! Open output files (total_time.dat and check_ke.out)
call openfiles()

if( jt_total >= nsteps ) then

    if (coord == 0) write(*,'(a)') 'Full number of time steps reached'
#ifdef PPMPI
    ! First make sure everyone in has finished
    call mpi_barrier( MPI_COMM_WORLD, ierr )
    call mpi_finalize (ierr)
#endif
    stop
endif

! Write simulation data to file
! Commented out since we now have an input file and case information
! can be preserved via it; may still be useful for double checking that
! the input was read correctly and is sane.
if (coord == 0) call param_output()

! Define simulation parameters
call sim_param_init ()

! Initialize sgs variables
call sgs_param_init()

! Initialize uv grid (calculate x,y,z vectors)
call grid%build()

! Initialize coriolis forcing
call coriolis_init()

!  Initialize variables used for output statistics and instantaneous data
call output_init()

! Initialize turbines
#ifdef PPTURBINES
call turbines_init()    ! must occur before initial is called
#endif

#ifdef PPATM
call atm_lesgo_initialize()
#endif

#ifdef PPHIT
! This initializes HIT Data
! The input is read from lesgo.conf
write(*,*) 'Inflow Condition using HIT Data'
call initialize_HIT()
#endif

! If using level set method
#ifdef PPLVLSET
call level_set_base_init()
call level_set_init()
#endif

call inflow_init

#ifdef PPSCALARS
call scalars_init()
#endif

call sponge_init()

! Formulate the fft plans--may want to use FFTW_USE_WISDOM
! Initialize the kx,ky arrays
call init_fft()

! Initialize test filter(s)
! this is used for lower BC, even if no dynamic model
call test_filter_init( )

! Initialize velocity field
call initial()

! Initialize integral wall model xiang
if (lbc_mom == 3) then
    if (coord==0) call iwm_init()
endif

! Initialize concurrent precursor stuff
#if defined(PPMPI) && defined(PPCPS)
call initialize_cps()
#endif

! Initialize dt if needed to force 1st order Euler
if( use_cfl_dt ) then
    if( jt_total == 0 .or. abs((cfl_f - cfl)/cfl) > 1.e-2_rprec ) then
        if (coord == 0) write(*,*)                                             &
            '--> Using 1st order Euler for first time step.'
        dt = get_cfl_dt()
        dt = dt * huge(1._rprec) ! Force Euler advection (1st order)
        dt_dim = dt * z_i / u_star
    endif
endif

end subroutine initialize