InitTimeKeepLog.hpp 1.27 KB
Newer Older
GILLES Sebastien's avatar
GILLES Sebastien committed
1 2 3 4 5 6 7 8 9 10 11 12 13
/*!
//
// \file
//
//
// Created by Sebastien Gilles <sebastien.gilles@inria.fr> on the Wed, 7 Jan 2015 14:19:22 +0100
// Copyright (c) Inria. All rights reserved.
//
// \ingroup CoreGroup
// \addtogroup CoreGroup
// \{
*/

14

15 16
#ifndef MOREFEM_x_CORE_x_INIT_TIME_KEEP_LOG_HPP_
# define MOREFEM_x_CORE_x_INIT_TIME_KEEP_LOG_HPP_
17

18
# include "ThirdParty/Wrappers/Mpi/Mpi.hpp"
19

20 21
# include "Utilities/TimeKeep/TimeKeep.hpp"
# include "Utilities/Filesystem/File.hpp"
22

23
# include "Core/InputData/InputData.hpp"
24
# include "Core/InputData/Instances/Result.hpp"
25 26


27
namespace MoReFEM
28
{
29 30


31
    /// \addtogroup CoreGroup
32
    ///@{
33 34 35


    /*!
36
     * \brief Init the time keeper and write its logs in the output directory specified in \a input_data.
37 38
     *
     * This function is to be called early in your main if you want to time keep some information lines.
39
     *
40
     * \copydetails doxygen_hide_mpi_param
41 42
     * \param[in] result_directory Directory into which all outputs should be written. It is assumed to exist when
     * it is given to this function.
43
     */
44
    void InitTimeKeepLog(const Wrappers::Mpi& mpi,
45
                         const std::string& result_directory);
46 47 48



49
    ///@} // \addtogroup
50 51


52
} // namespace MoReFEM
53 54


55 56 57
/// @} // addtogroup CoreGroup


58
#endif // MOREFEM_x_CORE_x_INIT_TIME_KEEP_LOG_HPP_