OilfieldToolsNet/opm-common
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Output: Add Container for Transporting Guiderate Values

Browse Source 
This commit introduces a container

    Opm::data::GuideRateValue

that packages a 'std::array' and 'std::bitset' into that array.
This container is intended as the main vehicle for transporting
per-phase guiderate values (Oil, Gas, Water, and Resvoir Voidage
Volume supported initially) calculated by the simulator to the
output layer.  We support the serialization operations read and
write in order to plug into the collective communications layer used
in the simulator.

Add unit tests to exercise the new container.
This commit is contained in:
Bård Skaflestad
2020-07-09 16:44:15 +02:00
parent dc3dd89e09
commit 4f7d41ee10
3 changed files with 329 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_data_GuideRateValue.cpp
+190
View File
@@ -0,0 +1,190 @@
#define BOOST_TEST_MODULE data_GuideRateValue
#include <boost/test/unit_test.hpp>
#include <opm/output/data/GuideRateValue.hpp>
BOOST_AUTO_TEST_SUITE(GuideRate_Values)
namespace {
class MessageBuffer
{
private:
std::stringstream str_{};
public:
template <class T>
void read(T& value)
{
this->str_.read(reinterpret_cast<char *>(&value), sizeof value);
}
template <class T>
void write(T const& value)
{
this->str_.write(reinterpret_cast<const char *>(&value), sizeof value);
}
void write(const std::string& str)
{
const int size = str.size();
this->write(size);
for (int k = 0; k < size; ++k) {
this->write(str[k]);
}
}
void read(std::string& str)
{
int size = 0;
this->read(size);
str.resize(size);
for (int k = 0; k < size; ++k) {
this->read(str[k]);
}
}
};
}
BOOST_AUTO_TEST_CASE(Construct)
{
using GRValue = ::Opm::data::GuideRateValue;
auto grvalue = GRValue{};
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::Oil), "Default constructed GuideRateValue must not have Oil");
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::Gas), "Default constructed GuideRateValue must not have Gas");
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::Water), "Default constructed GuideRateValue must not have Water");
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::ResV), "Default constructed GuideRateValue must not have ResV");
BOOST_CHECK_MESSAGE(! grvalue.has(static_cast<GRValue::Item>(1729)),
"Default constructed GuideRateValue must not have out-of-bounds phase 1729");
BOOST_CHECK_MESSAGE(! grvalue.has(static_cast<GRValue::Item>(-1)),
"Default constructed GuideRateValue must not have out-of-bounds phase -1");
}
BOOST_AUTO_TEST_CASE(Set_and_Get)
{
using GRValue = ::Opm::data::GuideRateValue;
auto grvalue = GRValue{};
BOOST_CHECK_THROW(grvalue.get(GRValue::Item::Oil), std::invalid_argument);
BOOST_CHECK_THROW(grvalue.get(static_cast<GRValue::Item>(1729)), std::invalid_argument);
BOOST_CHECK_THROW(grvalue.get(static_cast<GRValue::Item>(-1)), std::invalid_argument);
grvalue.set(GRValue::Item::Oil, 123.456);
grvalue.set(GRValue::Item::Water, -0.98765);
grvalue.set(GRValue::Item::ResV, 567.89);
BOOST_CHECK_THROW(grvalue.set(static_cast<GRValue::Item>(355113), 0.1234),
std::invalid_argument);
BOOST_CHECK_CLOSE(grvalue.get(GRValue::Item::Oil), 123.456, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue.get(GRValue::Item::Water), -0.98765, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue.get(GRValue::Item::ResV), 567.89, 1.0e-10);
BOOST_CHECK_THROW(grvalue.get(GRValue::Item::Gas), std::invalid_argument);
}
BOOST_AUTO_TEST_CASE(Copy_and_Assignment)
{
using GRValue = ::Opm::data::GuideRateValue;
auto grvalue1 = GRValue{};
grvalue1.set(GRValue::Item::Oil, 123.456);
grvalue1.set(GRValue::Item::Water, -0.98765);
grvalue1.set(GRValue::Item::ResV, 567.89);
const auto grvalue2{ grvalue1 };
BOOST_CHECK_CLOSE(grvalue2.get(GRValue::Item::Oil), 123.456, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue2.get(GRValue::Item::Water), -0.98765, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue2.get(GRValue::Item::ResV), 567.89, 1.0e-10);
BOOST_CHECK_THROW(grvalue2.get(GRValue::Item::Gas), std::invalid_argument);
auto grvalue3 = GRValue{};
grvalue3 = grvalue2;
BOOST_CHECK_CLOSE(grvalue3.get(GRValue::Item::Oil), 123.456, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue3.get(GRValue::Item::Water), -0.98765, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue3.get(GRValue::Item::ResV), 567.89, 1.0e-10);
BOOST_CHECK_THROW(grvalue3.get(GRValue::Item::Gas), std::invalid_argument);
}
BOOST_AUTO_TEST_CASE(Addition)
{
using GRValue = ::Opm::data::GuideRateValue;
auto grvalue1 = GRValue{};
grvalue1.set(GRValue::Item::Oil, 123.456);
grvalue1.set(GRValue::Item::ResV, 567.89);
auto grvalue2 = GRValue{};
grvalue2.set(GRValue::Item::Water, -0.98765);
grvalue2.set(GRValue::Item::Oil, 123.321);
grvalue1 += grvalue2;
BOOST_CHECK_MESSAGE(grvalue1.has(GRValue::Item::Water),
"Operator '+=' must assign unset items");
BOOST_CHECK_CLOSE(grvalue1.get(GRValue::Item::Oil), 246.777, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue1.get(GRValue::Item::Water), -0.98765, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue1.get(GRValue::Item::ResV), 567.89, 1.0e-10);
}
BOOST_AUTO_TEST_CASE(Clear)
{
using GRValue = ::Opm::data::GuideRateValue;
auto grvalue = GRValue{};
grvalue.set(GRValue::Item::Oil, 123.456);
grvalue.set(GRValue::Item::Water, -0.98765);
grvalue.set(GRValue::Item::ResV, 567.89);
grvalue.clear();
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::Oil), "Cleared GuideRateValue must not have Oil");
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::Gas), "Cleared GuideRateValue must not have Gas");
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::Water), "Cleared GuideRateValue must not have Water");
BOOST_CHECK_MESSAGE(! grvalue.has(GRValue::Item::ResV), "Cleared GuideRateValue must not have ResV");
}
BOOST_AUTO_TEST_CASE(Serialize_ReadWrite)
{
using GRValue = ::Opm::data::GuideRateValue;
auto grvalue1 = GRValue{};
grvalue1.set(GRValue::Item::Oil, 123.456);
grvalue1.set(GRValue::Item::Water, -0.98765);
grvalue1.set(GRValue::Item::ResV, 567.89);
auto buffer = MessageBuffer{};
grvalue1.write(buffer);
auto grvalue2 = GRValue{};
grvalue2.read(buffer);
BOOST_CHECK_MESSAGE( grvalue2.has(GRValue::Item::Oil), "Serialized GuideRateValue must have Oil");
BOOST_CHECK_MESSAGE(! grvalue2.has(GRValue::Item::Gas), "Serialized GuideRateValue must NOT have Gas");
BOOST_CHECK_MESSAGE( grvalue2.has(GRValue::Item::Water), "Serialized GuideRateValue must have Water");
BOOST_CHECK_MESSAGE( grvalue2.has(GRValue::Item::ResV), "Serialized GuideRateValue must have Voidage");
BOOST_CHECK_MESSAGE(! grvalue2.has(static_cast<GRValue::Item>(1729)),
"Serialized GuideRateValue must not have out-of-bounds phase 1729");
BOOST_CHECK_MESSAGE(! grvalue2.has(static_cast<GRValue::Item>(-1)),
"Serialized GuideRateValue must not have out-of-bounds phase -1");
BOOST_CHECK_CLOSE(grvalue2.get(GRValue::Item::Oil), 123.456, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue2.get(GRValue::Item::Water), -0.98765, 1.0e-10);
BOOST_CHECK_CLOSE(grvalue2.get(GRValue::Item::ResV), 567.89, 1.0e-10);
BOOST_CHECK_THROW(grvalue2.get(GRValue::Item::Gas), std::invalid_argument);
BOOST_CHECK_MESSAGE(grvalue1 == grvalue2, "Serialized GuideRateValue must equal its original value");
}
BOOST_AUTO_TEST_SUITE_END()