Loading...
Searching...
No Matches
Keywords.hpp
/*
Copyright 2020 Equinor AS.
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_KEYWORDS_HPP
#define OPM_KEYWORDS_HPP
#include <optional>
#include <string>
namespace Opm {
namespace Fieldprops {
namespace keywords {
template <typename T>
struct keyword_info {
std::optional<std::string> unit = std::nullopt;
std::optional<T> scalar_init = std::nullopt;
bool multiplier = false;
bool top = false;
bool global = false;
bool local_in_schedule = true;
// For FieldProps-related keywords, each grid cell can have multiple values.
// This occurs specifically during compositional simulations, where the number
// of values depends on the number of compositions. In other simulations, num_value is typically one.
// The 'mutable' keyword allows num_value to be updated at a later stage when parsing relevant keywords.
mutable std::size_t num_value = 1;
bool operator==(const keyword_info& other) const {
return this->unit == other.unit &&
this->scalar_init == other.scalar_init &&
this->multiplier == other.multiplier &&
this->top == other.top &&
this->global == other.global &&
this->num_value == other.num_value;
}
keyword_info<T>& init(T init_value) {
this->scalar_init = init_value;
return *this;
}
keyword_info<T>& unit_string(const std::string& unit_string) {
this->unit = unit_string;
return *this;
}
keyword_info<T>& distribute_top(bool dtop) {
this->top = dtop;
return *this;
}
keyword_info<T>& mult(bool m) {
this->multiplier = m;
return *this;
}
keyword_info<T>& global_kw(bool g) {
this->global = g;
if(g)
this->local_in_schedule = false;
return *this;
}
keyword_info<T>& global_kw_until_edit() {
this->global = true;
this->local_in_schedule = true;
return *this;
}
const keyword_info<T>& num_value_per_cell(const std::size_t n) const {
if (n > 0) {
this->num_value = n;
}
return *this;
}
};
} // end namespace Keywords
} // end namespace Fieldprops
} //end namespace Opm
#endif //OPM_KEYWORDS_HPP
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Opm::Fieldprops::keywords::keyword_info
Definition Keywords.hpp:31
Opm::Fieldprops::keywords::keyword_info::local_in_schedule
bool local_in_schedule
Supply global storage but remove it once the SCHEDULE is executed.
Definition Keywords.hpp:44
Opm::Fieldprops::keywords::keyword_info::global
bool global
Whether a keyword is global.
Definition Keywords.hpp:40