Loading...
Searching...
No Matches
RawKeyword.hpp
/*
Copyright 2013 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 RAWKEYWORD_HPP
#define RAWKEYWORD_HPP
#include <cstddef>
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include <opm/common/OpmLog/KeywordLocation.hpp>
#include "RawEnums.hpp"
#include "RawConsts.hpp"
namespace Opm {
class RawRecord;
class RawKeyword {
public:
RawKeyword(const std::string& name, const std::string& filename, std::size_t lineNR, bool raw_string, Raw::KeywordSizeEnum sizeType);
RawKeyword(const std::string& name, const std::string& filename, std::size_t lineNR, bool raw_string, Raw::KeywordSizeEnum sizeType, const std::optional<std::size_t>& min_size, std::size_t size_arg);
bool terminateKeyword();
bool addRecord(RawRecord record);
const std::string& getKeywordName() const;
Raw::KeywordSizeEnum getSizeType() const;
// Special case method only for inspecting INCLUDE keywords;
// the general getRecords functionality should use the
// iterator interface.
const RawRecord& getFirstRecord( ) const;
bool isFinished() const;
bool rawStringKeyword() const;
const KeywordLocation& location() const;
bool can_complete() const;
using const_iterator = std::vector< RawRecord >::const_iterator;
using iterator = std::vector< RawRecord >::iterator;
iterator begin();
iterator end();
const_iterator begin() const;
const_iterator end() const;
std::size_t size() const;
private:
std::string m_name;
KeywordLocation m_location;
bool raw_string_keyword;
Raw::KeywordSizeEnum m_sizeType;
std::size_t m_min_size = 0;
std::size_t m_fixedSize = 0;
std::size_t m_numTables = 0;
std::size_t m_currentNumTables = 0;
bool m_isTempFinished = false;
bool m_isFinished = false;
std::vector< RawRecord > m_records;
};
}
#endif /* RAWKEYWORD_HPP */
Opm::KeywordLocation
Definition KeywordLocation.hpp:27
Opm::RawRecord
Class representing the lowest level of the Raw datatypes, a record.
Definition RawRecord.hpp:36
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30