opm-simulators
simulatorutils.hpp
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
23 
24 #ifndef OPM_SIMULATOR_UTILS_HPP
25 #define OPM_SIMULATOR_UTILS_HPP
26 
27 #include <string>
28 #include <vector>
29 
30 namespace Opm {
31 
38 std::string humanReadableTime(double timeInSeconds, bool isAmendment = true);
39 
43 std::string simulatorOutputDir();
44 
49 template<class Scalar>
50 std::vector<Scalar> readTimeStepFile(const std::string& file);
51 
52 } // namespace Opm
53 
54 #endif
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
std::string humanReadableTime(double timeInSeconds, bool isAmendment)
Given a time step size in seconds, return it in a format which is more easily parsable by humans...
Definition: simulatorutils.cpp:45
std::vector< Scalar > readTimeStepFile(const std::string &file)
Read explicitly defined time steps from file.
Definition: simulatorutils.cpp:146
std::string simulatorOutputDir()
Determine and check the configured directory for simulation output.
Definition: simulatorutils.cpp:119