fleur_help.f90 3.26 KB
Newer Older
1 2 3 4 5
!--------------------------------------------------------------------------------
! Copyright (c) 2016 Peter Grünberg Institut, Forschungszentrum Jülich, Germany
! This file is part of FLEUR and available as free software under the conditions
! of the MIT license as expressed in the LICENSE file in more detail.
!--------------------------------------------------------------------------------
6
MODULE m_fleur_help
7 8
  IMPLICIT NONE
CONTAINS
9
  SUBROUTINE fleur_help()
10 11 12 13
    USE m_compile_descr
    USE m_constants
    USE m_juDFT
    IMPLICIT NONE
Daniel Wortmann's avatar
Daniel Wortmann committed
14
    CHARACTER(LEN=500):: infostring
15

16
    PRINT *,"     Welcome to FLEUR        (www.flapw.de)   "
Daniel Wortmann's avatar
Daniel Wortmann committed
17
    PRINT *,"     MaX-Release 1.3       (www.max-centre.eu)"
18 19 20 21

    IF (.NOT. (juDFT_was_argument("-h").OR.juDFT_was_argument("--help"))) RETURN

    !now print version info and help on command line arguments:
Daniel Wortmann's avatar
Daniel Wortmann committed
22 23
    CALL get_compile_desc_string(infostring)
    WRITE(*,'(a500)') infostring
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
    WRITE(*,'(a)')
    WRITE(*,'(a)')"------------------------------------------------------"
    WRITE(*,'(a)')"Usage info:"
    WRITE(*,'(a)')"The following command line options are known:"
    WRITE(*,'(a)')"-da,-mem,-mpi,-hdf: choose a storage for the eigenvalues"
    WRITE(*,'(a)')"                    and eigenvectors. The default will depend"
    WRITE(*,'(a)')"                    be -mem for serial and -mpi for parallel builds" 
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-lapack,-lapack2,"
    WRITE(*,'(a)')"-elpa,-scalapack,"
    WRITE(*,'(a)')"-elemental,-magma : choose diagonalization. Not all might be available"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-debugtime        : write out the start/stop of all timers to STDOUT"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-genEnpara        : write enpara file"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-xmlInput or -xml : use inp.xml instead of inp"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-check            : run in check mode, i.e. stop after init"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-n_min_size  XXX  : try to use at least XXX PE in Eigenvalue parallelization" 
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-wtime XXXXX      : run for XXXX minutes (used to estimate if another iteration is started"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-j #:DIR          : run subjob in directory DIR using # PEs"
    WRITE(*,'(a)')"-f FILENAME       : obtain info on subjobs from file FILENAME"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-info             : Print out information on recommended parallelization and available charge densities"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"-h, --help        : print this text :-)"
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"HDF density file relevant options:"
    WRITE(*,'(a)')""
57 58 59 60 61
    WRITE(*,'(a)')"-no_cdn_hdf        : disable HDF charge density mode (activated by default if HDF5 is available)"
    WRITE(*,'(a)')"-sd N              : use starting density N, where N is the index of the density according to -info"
    WRITE(*,'(a)')"-delden N-M        : delete densities N to M"
    WRITE(*,'(a)')"-delden N          : delete density N"
    WRITE(*,'(a)')"-delden allbutlast : delete all but the last density"
62 63
    WRITE(*,'(a)')""
    WRITE(*,'(a)')"Please check the documentation on www.flapw.de for more details"
64

65
    CALL juDFT_end("help was written",l_endXML=.FALSE.)
66 67
  END SUBROUTINE fleur_help
END MODULE m_fleur_help