File: test_parametersystem.cpp

package info (click to toggle)
opm-simulators 2025.10%2Bds-5
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 21,552 kB
  • sloc: cpp: 193,037; sh: 1,807; python: 1,704; lisp: 1,108; makefile: 31; awk: 10
file content (183 lines) | stat: -rw-r--r-- 7,008 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
  Copyright 2024 Equinor.

  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <config.h>

#include <opm/models/utils/parametersystem.hpp>

#define BOOST_TEST_MODULE ParameterSystemTest
#include <boost/test/unit_test.hpp>

namespace Opm::Parameters {

struct SimpleParamBool { static constexpr bool value = false; };
struct SimpleParamDouble { static constexpr double value = 1.0; };
struct SimpleParamFloat { static constexpr float value = 2.0; };
struct SimpleParamInt { static constexpr int value = 1; };
struct SimpleParamString  { static constexpr auto value = "foo"; };
struct SimpleParamBoolN2
{
  static constexpr auto name = "SimpleB2";
  static constexpr bool value = true;
};

}

namespace {

struct Fixture
{
    Fixture()
    {
        Opm::Parameters::reset();
        Opm::Parameters::Register<Opm::Parameters::SimpleParamBool>("Simple bool parameter");
        Opm::Parameters::Register<Opm::Parameters::SimpleParamBoolN2>("Simpler bool parameter");
        Opm::Parameters::Register<Opm::Parameters::SimpleParamDouble>("Simple double parameter");
        Opm::Parameters::Register<Opm::Parameters::SimpleParamFloat>("Simple float parameter");
        Opm::Parameters::Register<Opm::Parameters::SimpleParamInt>("Simple int parameter");
        Opm::Parameters::Register<Opm::Parameters::SimpleParamString>("Simple string parameter");
        Opm::Parameters::SetDefault<Opm::Parameters::SimpleParamInt>(10);
        Opm::Parameters::Hide<Opm::Parameters::SimpleParamInt>();
        Opm::Parameters::endRegistration();
    }
};

std::string trimString(const std::string& input)
{
    std::string result(input);
    result.erase(std::remove(result.begin(), result.end(), ' '), result.end());
    result.erase(std::remove(result.begin(), result.end(), '\n'), result.end());
    return result;
}

}

BOOST_FIXTURE_TEST_CASE(GetLists, Fixture)
{
  const char* argv[] = {
      "test_parametersystem",
      "--simple-param-bool=true",
      "--simple-param-float=3.0",
      "--simple-param-string=bar",
      "--unused-param=foo",
  };

    auto noPositional = [](std::function<void(const std::string&,
                                              const std::string&)>,
                           std::set<std::string>&,
                           std::string&,
                           int,
                           const char**,
                           int,
                           int) -> int
                        {
                            assert("Should not be here!");
                            return 0;
                        };


  Opm::Parameters::parseCommandLineOptions(5, argv, noPositional);

  BOOST_CHECK_EQUAL(Opm::Parameters::IsSet<Opm::Parameters::SimpleParamBool>(), true);
  BOOST_CHECK_EQUAL(Opm::Parameters::IsSet<Opm::Parameters::SimpleParamFloat>(), true);
  BOOST_CHECK_EQUAL(Opm::Parameters::IsSet<Opm::Parameters::SimpleParamString>(), true);
  BOOST_CHECK_EQUAL(Opm::Parameters::IsSet<Opm::Parameters::SimpleParamBoolN2>(), false);
  BOOST_CHECK_EQUAL(Opm::Parameters::IsSet<Opm::Parameters::SimpleParamDouble>(), false);
  BOOST_CHECK_EQUAL(Opm::Parameters::IsSet<Opm::Parameters::SimpleParamInt>(), false);

  using SettingMap = std::vector<Opm::Parameters::Parameter>;

  const SettingMap set_ref = {
      {"SimpleParamBool", "true"},
      {"SimpleParamFloat", "3.0"},
      {"SimpleParamString", "bar"},
  };

  const SettingMap unused_ref = {
      {"UnusedParam", "foo"},
  };

  SettingMap  set, unused;
  Opm::Parameters::getLists(set, unused);

  BOOST_CHECK_EQUAL_COLLECTIONS(set.begin(), set.end(),
                                set_ref.begin(), set_ref.end());
  BOOST_CHECK_EQUAL_COLLECTIONS(unused.begin(), unused.end(),
                                unused_ref.begin(), unused_ref.end());
}

BOOST_FIXTURE_TEST_CASE(ParseParameterFile, Fixture)
{
  Opm::Parameters::parseParameterFile("parametersystem.ini", true);

  BOOST_CHECK_EQUAL(Opm::Parameters::Get<Opm::Parameters::SimpleParamBool>(), true);
  BOOST_CHECK_EQUAL(Opm::Parameters::Get<Opm::Parameters::SimpleParamFloat>(), 3.f);
  BOOST_CHECK_EQUAL(Opm::Parameters::Get<Opm::Parameters::SimpleParamString>(), "bar");
  BOOST_CHECK_EQUAL(Opm::Parameters::Get<Opm::Parameters::SimpleParamBoolN2>(), true);
  BOOST_CHECK_EQUAL(Opm::Parameters::Get<Opm::Parameters::SimpleParamDouble>(), 1.0);
  BOOST_CHECK_EQUAL(Opm::Parameters::Get<Opm::Parameters::SimpleParamInt>(), 10);
}

BOOST_FIXTURE_TEST_CASE(PrintUsage, Fixture)
{
  std::stringstream usage;
  Opm::Parameters::printUsage("", usage);
  BOOST_CHECK_EQUAL(trimString(usage.str()),
trimString(R"(
Recognized options:
    --simple-b2=BOOLEAN                           Simpler bool parameter. Default: true
    --simple-param-bool=BOOLEAN                   Simple bool parameter. Default: false
    --simple-param-double=SCALAR                  Simple double parameter. Default: 1
    --simple-param-float=SCALAR                   Simple float parameter. Default: 2
    --simple-param-string=STRING                  Simple string parameter. Default: "foo"
)"));
}

BOOST_FIXTURE_TEST_CASE(PrintUsageAll, Fixture)
{
  std::stringstream usage;
  Opm::Parameters::printUsage("===foobar===", usage, "", true);
  BOOST_CHECK_EQUAL(trimString(usage.str()),
trimString(R"(===foobar===
Recognized options:
    -h,--help                                     Print this help message and exit
    --help-all                                    Print all parameters, including obsolete, hidden and deprecated ones.
    --simple-b2=BOOLEAN                           Simpler bool parameter. Default: true
    --simple-param-bool=BOOLEAN                   Simple bool parameter. Default: false
    --simple-param-double=SCALAR                  Simple double parameter. Default: 1
    --simple-param-float=SCALAR                   Simple float parameter. Default: 2
    --simple-param-int=INTEGER                    Simple int parameter. Default: 10
    --simple-param-string=STRING                  Simple string parameter. Default: "foo"
)"));
}

BOOST_FIXTURE_TEST_CASE(PrintValues, Fixture)
{
  std::stringstream values;
  Opm::Parameters::printValues(values);
  BOOST_CHECK_EQUAL(trimString(values.str()),
trimString(R"(# [parameters which were specified at compile-time]
SimpleB2="1"
SimpleParamBool="0"
SimpleParamDouble="1"
SimpleParamFloat="2"
SimpleParamInt="10"
SimpleParamString="foo"
)"));
}