GEOS
LogLevelsInfo.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 TotalEnergies
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
21 #ifndef GEOS_PHYSICSSOLVERS_LOGLEVELSINFO_HPP
22 #define GEOS_PHYSICSSOLVERS_LOGLEVELSINFO_HPP
23 
24 #include "common/DataTypes.hpp"
25 
26 namespace geos
27 {
28 
29 namespace logInfo
30 {
31 
36 
38 
39 
40 struct BoundaryConditions
41 {
42  static constexpr int getMinLogLevel() { return 1; }
43  static constexpr std::string_view getDescription() { return "Boundary conditions information (incl. source flux)"; }
44 };
45 
46 struct Convergence
47 {
48  static constexpr int getMinLogLevel() { return 1; }
49  static constexpr std::string_view getDescription() { return "Convergence information"; }
50 };
51 
52 struct Coupling
53 {
54  static constexpr int getMinLogLevel() { return 1; }
55  static constexpr std::string_view getDescription() { return "Coupling information"; }
56 };
57 
58 struct Fields
59 {
60  static constexpr int getMinLogLevel() { return 2; }
61  static constexpr std::string_view getDescription() { return "The summary of declared fields and coupling"; }
62 };
63 
64 struct LinearSolver
65 {
66  static constexpr int getMinLogLevel() { return 1; }
67  static constexpr std::string_view getDescription() { return "Linear solver information"; }
68 };
69 
70 struct LineSearch
71 {
72  static constexpr int getMinLogLevel() { return 1; }
73  static constexpr std::string_view getDescription() { return "Line search information"; }
74 };
75 
76 struct NonlinearSolver
77 {
78  static constexpr int getMinLogLevel() { return 1; }
79  static constexpr std::string_view getDescription() { return "Nonlinear solver information"; }
80 };
81 
82 struct ResidualNorm
83 {
84  static constexpr int getMinLogLevel() { return 1; }
85  static constexpr std::string_view getDescription() { return "Output residual norm"; }
86 };
87 
88 struct Solution
89 {
90  static constexpr int getMinLogLevel() { return 1; }
91  static constexpr std::string_view getDescription() { return "Solution information (scaling, maximum changes, quality check)"; }
92 };
93 
94 struct SolverInitialization
95 {
96  static constexpr int getMinLogLevel() { return 1; }
97  static constexpr std::string_view getDescription() { return "Information on solver initialization"; }
98 };
99 
100 struct SolverExecution
101 {
102  static constexpr int getMinLogLevel() { return 1; }
103  static constexpr std::string_view getDescription() { return "Information on solver execution"; }
104 };
105 struct SolverExecutionDetails
106 {
107  static constexpr int getMinLogLevel() { return 2; }
108  static constexpr std::string_view getDescription() { return "More precise information on solver execution"; }
109 };
110 
111 struct SolverSteps
112 {
113  static constexpr int getMinLogLevel() { return 1; }
114  static constexpr std::string_view getDescription() { return "Solver step Information"; }
115 };
116 
117 struct Statistics
118 {
119  static constexpr int getMinLogLevel() { return 1; }
120  static constexpr std::string_view getDescription() { return "Print statistics"; }
121 };
122 
123 struct SurfaceGenerator
124 {
125  static constexpr int getMinLogLevel() { return 1; }
126  static constexpr std::string_view getDescription() { return "Fracture generation information"; }
127 };
128 
129 struct TimeStep
130 {
131  static constexpr int getMinLogLevel() { return 1; }
132  static constexpr std::string_view getDescription() { return "Time step information"; }
133 };
134 
135 struct Timers
136 {
137  static constexpr int getMinLogLevel() { return 1; }
138  static constexpr std::string_view getDescription() { return "Solver timers information"; }
139 };
140 
143 
144 }
145 
146 }
147 
148 #endif // GEOS_PHYSICSSOLVERS_LOGLEVELSINFO_HPP
geos::units::getDescription
constexpr std::string_view getDescription(Unit unit)
Definition: Units.hpp:123
geos::string_view
std::string_view string_view
String type.
Definition: DataTypes.hpp:93
Generated by doxygen 1.9.1