03b3be48b0
This commit adds new helper classes,
Opm::RestartIO::Helpers::CharArrayNullTerm<NChar>
Opm::RestartIO::Helpers::WindowedArray<T>
Opm::RestartIO::Helpers::WindowedMatrix<T>
the first of which represents a nul-terminated character string of
'NChar' user data (total array size is NChar + 1). Mainly intended
for representing Fortran-compatible characters arrays--especially
for ZWEL and similar restart vectors (e.g., ZGRP).
The second two simplify working with subsets of large linear arrays,
particularly those that represent N items per well, group, or
segment. The WindowedArray is a linear array of windows (N items
per window) packed into a std::vector<T> and the WindowedMatrix
additionally imposes a Row-by-Colum structure which is useful for
the case of N windows (each of size K) for each of M entities (e.g.,
K items for each of N connections for each of M wells).
104 lines
3.2 KiB
C++
104 lines
3.2 KiB
C++
/*
|
|
Copyright (c) 2018 Statoil ASA
|
|
|
|
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/>.
|
|
*/
|
|
|
|
#ifndef OPM_CHARARRAY_HEADER_HPP
|
|
#define OPM_CHARARRAY_HEADER_HPP
|
|
|
|
#include <algorithm>
|
|
#include <array>
|
|
#include <cstring>
|
|
#include <cstddef>
|
|
#include <string>
|
|
|
|
namespace Opm { namespace RestartIO { namespace Helpers {
|
|
|
|
/// Null-terminated, left adjusted, space padded array of N characters.
|
|
///
|
|
/// Simple container of character data. Exists solely for purpose of
|
|
/// outputting std::string (or types convertible to std::string) as
|
|
/// Fortran-style \code character (len=N) \endcode values.
|
|
///
|
|
/// \tparam N Number of characters.
|
|
template <std::size_t N>
|
|
class CharArrayNullTerm
|
|
{
|
|
public:
|
|
CharArrayNullTerm()
|
|
{
|
|
this->clear();
|
|
}
|
|
|
|
explicit CharArrayNullTerm(const std::string& s)
|
|
: CharArrayNullTerm()
|
|
{
|
|
this->copy_in(s.c_str(), s.size());
|
|
}
|
|
|
|
~CharArrayNullTerm() = default;
|
|
|
|
CharArrayNullTerm(const CharArrayNullTerm& rhs) = default;
|
|
CharArrayNullTerm(CharArrayNullTerm&& rhs) = default;
|
|
|
|
CharArrayNullTerm& operator=(const CharArrayNullTerm& rhs) = default;
|
|
CharArrayNullTerm& operator=(CharArrayNullTerm&& rhs) = default;
|
|
|
|
/// Assign from \code std::string \endcode.
|
|
CharArrayNullTerm& operator=(const std::string& s)
|
|
{
|
|
this->clear();
|
|
this->copy_in(s.data(), s.size());
|
|
|
|
return *this;
|
|
}
|
|
|
|
const char* c_str() const
|
|
{
|
|
return this->s_.data();
|
|
}
|
|
|
|
private:
|
|
enum : typename std::array<char, N + 1>::size_type { NChar = N };
|
|
|
|
std::array<char, NChar + 1> s_;
|
|
|
|
/// Clear contents of internal array (fill with ' ').
|
|
void clear()
|
|
{
|
|
this->s_.fill(' ');
|
|
this->s_[NChar] = '\0';
|
|
}
|
|
|
|
/// Assign new value to internal array (left adjusted, space padded
|
|
/// and null-terminated).
|
|
void copy_in(const char* s,
|
|
const typename std::array<char, NChar + 1>::size_type len)
|
|
{
|
|
const auto ncpy = std::min(len, static_cast<decltype(len)>(NChar));
|
|
|
|
// Note: Not strcpy() or strncpy() here. The former has no bounds
|
|
// checking, the latter writes a null-terminator at position 'ncpy'
|
|
// (s_[ncpy]) which violates the post condition if ncpy < NChar.
|
|
std::memcpy(this->s_.data(), s,
|
|
ncpy * sizeof *this->s_.data());
|
|
}
|
|
};
|
|
|
|
}}} // Opm::RestartIO::Helpers
|
|
#endif // CHARARRAY_HEADER
|