INSTALL

/*
 * LPTlib
 * Lagrangian Particle Tracking library
 *
 * Copyright (c) 2012-2014 Advanced Institute for Computational Science, RIKEN. 
 * All rights reserved.
 *
 */
 

Prerequisite
============
- MPI library
- Performance Monitor library is required if a timing report option is selected.



How to compile
==============

1. with configure

$ ./configure [options]
$ make
# make install


Configure options:

 --prefix=INSTALL_DIR
 Specify a directory to be installed. The default directory is /usr/local/LPTlib.

 --with-mpich=MPICH_DIR
 If you will use a MPICH library, specify the directory that MPICH library is installed.
 Either --with-mpich of --with-ompi option will be required except. If the wrapper compiler,
 e.g., mpic++ or mpicxx is used to compile, both options can be eliminated.

 --with-ompi=OPENMPI_DIR
 If you will use an OpenMPI library, specify the directory path of OpenMPI.

 --with-comp=(INTEL|FJ)
 If Intel compiler is used, choose INTEL, and if Fujitsu compiler, specify FJ.

 --with-pm=PMLIB_DIR
 Specify the directory path that Performance Monitor library is installed. This option is 
 required if only you need a performance report.

 --with-log=(disable|enable)
 If a log file is demanded, specify enable.

 --with-realtype=(float|double)
 Specify floating type. Default is float.

 --with-container=(deque|list)
 Specify a container type of STL that is used to this program.

 --host=hostname
 Specify in case of cross-compilation.

 CXX=CXX_COMPILER
 Specify a C++ compiler, e.g., g++, icpc, xlc++ or others.

 FC=FORTRAN90_COMPILER
 Specify a fortran compiler.

 CXXFLAGS=CXX_OPTIONS
 Specify compiler options.

Compiled library and a FileConverter program will be installed at the specified directory.

Here is a example for Intel compile and OpenMPI.

$./configure --with-pm=/usr/local/FFV/PMlib \
            --with-comp=INTEL \
            --with-ompi=/opt/openmpi \
            --with-log=enable \
            CXXFLAGS="-O3 -openmp -qopt-report=5" \
            CXX=mpicxx \
            FC=mpif90


Following example is for K-computer.

$./configure --prefix=$1 \
	     --with-pm=/hogehoge \
             --with-comp=FJ \
             --with-log=enable \
             --host=sparc64-unknown-linux-gnu \
             CXX=mpiFCCpx \
             CXXFLAGS=-Kfast \
	     FC=



2. Hand compile

If a provided configure does not work, use Makefile_hand to build this library. At first,
edit a make_setting file to tell your machine environment.