//****************************************************************************************
//
//  Copyright (c) 2015-2020, Yoshifumi Nakamura <nakamura@riken.jp>
//  Copyright (c) 2015-2020, Yuta Mukai         <mukai.yuta@fujitsu.com>
//  Copyright (c) 2018-2020, Ken-Ichi Ishikawa  <ishikawa@theo.phys.sci.hirosima-u.ac.jp>
//  Copyright (c) 2019-2020, Issaku Kanamori    <kanamori-i@riken.jp>
//
//
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer. 
//
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer listed
//    in this license in the documentation and/or other materials
//    provided with the distribution.
//
//  * Neither the name of the copyright holders nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT  
//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
//  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
//  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
//  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
//  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
//  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  
//  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
//  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
//
//----------------------------------------------------------------------------------------
//  ACKNOWLEDGMENT
//
//  This software has been developed in a co-design working group for the lattice QCD
//  supported by MEXT's programs for the Development and Improvement for the Next
//  Generation Ultra High-Speed Computer System, under its Subsidies for Operating the
//  Specific Advanced Large Research Facilities, and Priority Issue 9 
//  (Elucidation of the Fundamental Laws and Evolution of the Universe) to be tackled by
//  using the Supercomputer Fugaku.
//
//****************************************************************************************

1) version information => VERSION

2) compile
make (or make -j _N_ for parallel make)

3) clean
make clean

4) vector length for double prec. array (SIMD width/64) 4th line of qws.h
5) vector length for single prec. array (SIMD width/32) 5th line of qws.h
6) it could be better to repalce functions of  qwsintrin.h by SIMD instructions

7) 4D local lattice size, (lx ...), proc. num (px ...) tolerance of outer and inner DD solver of BiCGStab 
are arguments of test program. When tol<0, iter will be maxiter and solution may become NaN
#      lx ly lz lt px py pz pt tol(outer) tol(inner) maxiter+1(outer) maxiter(inner)
./main 16  4  4  4  1  1  1  1      1e-14       1e-6               10            100

8) test cases
             ./main  4 1 1 1   1 1 1 1    -1   -1  6 50 > CASE_4111_1111    # with vlend=vlens=2
             ./main  4 1 1 1   1 1 1 1    -1   -1  6 50 > CASE_4111_1111_HP # with vlend=vlens=2, half_prec
mpirun -n 1  ./main 32 6 4 3   1 1 1 1    -1   -1  6 50 > CASE0
mpirun -n 2  ./main 32 6 4 3   1 1 1 2    -1   -1  6 50 > CASE1
mpirun -n 2  ./main 32 3 4 4   1 1 1 2    -1   -1  6 50 > CASE2
mpirun -n 2  ./main 32 3 6 4   1 1 1 2    -1   -1  6 50 > CASE3
mpirun -n 2  ./main 32 6 6 2   1 1 1 2    -1   -1  6 50 > CASE4
mpirun -n 2  ./main 32 6 6 4   1 1 1 2    -1   -1  6 50 > CASE5
mpirun -n 2  ./main 32 6 6 8   1 1 1 2    -1   -1  6 50 > CASE6
mpirun -n 8  ./main 32 6 4 3   1 2 2 2    -1   -1  6 50 > CASE7
mpirun -n 16 ./main 32 6 4 3   4 4 1 1    -1   -1  6 50 > CASE8
mpirun -n 16 ./main 32 6 4 3   1 1 4 4    -1   -1  6 50 > CASE9