My Project
Loading...
Searching...
No Matches
FilterCake.hpp
1/*
2 Copyright 2023 Equinor.
3
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18*/
19
20#ifndef OPM_FILTERCAKE_HPP
21#define OPM_FILTERCAKE_HPP
22
23#include <string>
24#include <optional>
25
26namespace Opm {
27
28 class DeckRecord;
29 class KeywordLocation;
30
31 struct FilterCake {
32
33 enum class FilterCakeGeometry {
34 LINEAR,
35 RADIAL,
36 NONE,
37 };
38
39 static FilterCakeGeometry filterCakeGeometryFromString(const std::string& str, const KeywordLocation& location);
40 static std::string filterCakeGeometryToString(const FilterCakeGeometry& geometry);
41
42 FilterCakeGeometry geometry{FilterCakeGeometry::NONE};
43 double perm{0.};
44 double poro{0.};
45 std::optional<double> radius;
46 std::optional<double> flow_area;
47 // skin factor multiplier
48 // it is controlled by keyword WINJCLN
49 double sf_multiplier{1.};
50
51 FilterCake() = default;
52
53 explicit FilterCake(const DeckRecord& record, const KeywordLocation& location);
54
55 template<class Serializer>
56 void serializeOp(Serializer& serializer) {
57 serializer(geometry);
58 serializer(perm);
59 serializer(poro);
60 serializer(radius);
61 serializer(flow_area);
62 serializer(sf_multiplier);
63 }
64
65 static FilterCake serializationTestObject();
66
67 bool operator==(const FilterCake& other) const;
68
69 void applyCleanMultiplier(const double factor);
70
71 static std::string filterCakeToString(const FilterCake& fc);
72 };
73
74}
75
76#endif //OPM_FILTERCAKE_HPP
Definition DeckRecord.hpp:32
Definition KeywordLocation.hpp:27
Class for (de-)serializing.
Definition Serializer.hpp:84
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Definition FilterCake.hpp:31