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 struct Configuration
40 {
41  static constexpr int getMinLogLevel() { return 2; }
42  static constexpr std::string_view getDescription() { return "Solver runtime settings"; }
43 };
44 
45 struct Convergence
46 {
47  static constexpr int getMinLogLevel() { return 1; }
48  static constexpr std::string_view getDescription() { return "Convergence information"; }
49 };
50 
51 struct Coupling
52 {
53  static constexpr int getMinLogLevel() { return 1; }
54  static constexpr std::string_view getDescription() { return "Coupling information"; }
55 };
56 
57 struct Fields
58 {
59  static constexpr int getMinLogLevel() { return 2; }
60  static constexpr std::string_view getDescription() { return "The summary of declared fields and coupling"; }
61 };
62 
63 struct LinearSolver
64 {
65  static constexpr int getMinLogLevel() { return 1; }
66  static constexpr std::string_view getDescription() { return "Linear solver information"; }
67 };
68 
69 struct LinearSolverConfiguration
70 {
71  static constexpr int getMinLogLevel() { return 1; }
72  static constexpr std::string_view getDescription() { return "Print linear solver configuration"; }
73 };
74 
75 struct LineSearch
76 {
77  static constexpr int getMinLogLevel() { return 1; }
78  static constexpr std::string_view getDescription() { return "Line search information"; }
79 };
80 
81 struct NonlinearSolver
82 {
83  static constexpr int getMinLogLevel() { return 1; }
84  static constexpr std::string_view getDescription() { return "Nonlinear solver information"; }
85 };
86 
87 struct ResidualNorm
88 {
89  static constexpr int getMinLogLevel() { return 1; }
90  static constexpr std::string_view getDescription() { return "Output residual norm"; }
91 };
92 
93 struct Solution
94 {
95  static constexpr int getMinLogLevel() { return 1; }
96  static constexpr std::string_view getDescription() { return "Solution information (scaling, maximum changes, quality check)"; }
97 };
98 
99 struct SolverInitialization
100 {
101  static constexpr int getMinLogLevel() { return 1; }
102  static constexpr std::string_view getDescription() { return "Information on solver Initialization"; }
103 };
104 
105 struct SolverExecution
106 {
107  static constexpr int getMinLogLevel() { return 1; }
108  static constexpr std::string_view getDescription() { return "Information on solver execution"; }
109 };
110 struct SolverExecutionDetails
111 {
112  static constexpr int getMinLogLevel() { return 2; }
113  static constexpr std::string_view getDescription() { return "More precise information on solver execution"; }
114 };
115 
116 struct SolverSteps
117 {
118  static constexpr int getMinLogLevel() { return 1; }
119  static constexpr std::string_view getDescription() { return "Solver step Information"; }
120 };
121 
122 struct Statistics
123 {
124  static constexpr int getMinLogLevel() { return 1; }
125  static constexpr std::string_view getDescription() { return "Print statistics"; }
126 };
127 
128 struct SurfaceGenerator
129 {
130  static constexpr int getMinLogLevel() { return 1; }
131  static constexpr std::string_view getDescription() { return "Fracture generation information"; }
132 };
133 
134 struct TimeStep
135 {
136  static constexpr int getMinLogLevel() { return 1; }
137  static constexpr std::string_view getDescription() { return "Time step information"; }
138 };
139 
140 struct Timers
141 {
142  static constexpr int getMinLogLevel() { return 1; }
143  static constexpr std::string_view getDescription() { return "Solver timers information"; }
144 };
145 
148 
149 }
150 
151 }
152 
153 #endif // GEOS_PHYSICSSOLVERS_LOGLEVELSINFO_HPP
geos::units::getDescription
constexpr std::string_view getDescription(Unit unit)
Definition: Units.hpp:120
geos::string_view
std::string_view string_view
String type.
Definition: DataTypes.hpp:93
Generated by doxygen 1.9.1