https://mooseframework.inl.gov
MooseError.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "MooseError.h"
11 #include "MooseUtils.h"
12 #include "MooseVariable.h"
13 #include "Registry.h"
14 
15 #include "libmesh/string_to_enum.h"
16 
17 using namespace libMesh;
18 
19 namespace moose
20 {
21 
22 namespace internal
23 {
24 
25 std::string
27 {
28  std::stringstream ss;
29  ss << libMesh::Utility::enum_to_string<FEFamily>(var1.feType().family) << ",ORDER"
30  << var1.feType().order
31  << " != " << libMesh::Utility::enum_to_string<FEFamily>(var2.feType().family) << ",ORDER"
32  << var2.feType().order;
33  return ss.str();
34 }
35 
36 std::string
37 mooseMsgFmt(const std::string & msg, const std::string & title, const std::string & color)
38 {
39  std::ostringstream oss;
40  oss << "\n" << color << "\n" << title << "\n" << msg << COLOR_DEFAULT << "\n";
41  return oss.str();
42 }
43 
44 std::string
45 mooseMsgFmt(const std::string & msg, const std::string & color)
46 {
47  std::ostringstream oss;
48  oss << "\n" << color << "\n" << msg << COLOR_DEFAULT << "\n";
49  return oss.str();
50 }
51 
52 [[noreturn]] void
53 mooseErrorRaw(std::string msg, const std::string prefix)
54 {
56  throw std::runtime_error(msg);
57 
58  msg = mooseMsgFmt(msg, "*** ERROR ***", COLOR_RED);
59 
60  std::ostringstream oss;
61  oss << msg << "\n";
62 
63  // this independent flush of the partial error message (i.e. without the
64  // trace) is here because trace retrieval can be slow in some
65  // circumstances, and we want to get the error message out ASAP.
66  msg = oss.str();
67  if (!prefix.empty())
68  MooseUtils::indentMessage(prefix, msg);
69  {
70  Threads::spin_mutex::scoped_lock lock(moose_stream_lock);
71  Moose::err << msg << std::flush;
72  }
73 
74  oss.str("");
76  print_trace(oss);
77 
78  msg = oss.str();
79  if (!prefix.empty())
80  MooseUtils::indentMessage(prefix, msg);
81 
82  {
83  Threads::spin_mutex::scoped_lock lock(moose_stream_lock);
84  Moose::err << msg << std::flush;
85 
88  }
89 
90  MOOSE_ABORT;
91 }
92 
93 void
94 mooseStreamAll(std::ostringstream &)
95 {
96 }
97 
98 std::string
99 formatMooseDocumentedError(const std::string & repo_name,
100  const unsigned int issue_num,
101  const std::string & msg)
102 {
103  const auto & repo_url = Registry::getRepositoryURL(repo_name);
104  std::stringstream oss;
105  oss << msg << "\n\nThis error is documented at " << repo_url << "/issues/" << issue_num << ".";
106  return oss.str();
107 }
108 
109 } // namespace internal
110 
111 void
112 translateMetaPhysicLError(const MetaPhysicL::LogicError &)
113 {
114  mooseError(
115  "We caught a MetaPhysicL error in while performing element or face loops. This is "
116  "potentially due to AD not having a sufficiently large derivative container size. To "
117  "increase the AD container size, you can run configure in the MOOSE root directory with the "
118  "'--with-derivative-size=<n>' option and then recompile. Other causes of MetaPhysicL logic "
119  "errors include evaluating functions where they are not defined or differentiable like sqrt "
120  "(which gets called for vector norm functions) or log with arguments <= 0");
121 }
122 
123 } // namespace moose
void mooseStreamAll(std::ostringstream &ss)
All of the following are not meant to be called directly - they are called by the normal macros (moos...
Definition: MooseError.C:94
bool show_trace
Set to true (the default) to print the stack trace with error and warning messages - false to omit it...
Definition: Moose.C:765
const libMesh::FEType & feType() const
Get the type of finite element object.
processor_id_type global_n_processors()
std::string incompatVarMsg(MooseVariableFieldBase &var1, MooseVariableFieldBase &var2)
Builds and returns a string of the form:
Definition: MooseError.C:26
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
void translateMetaPhysicLError(const MetaPhysicL::LogicError &)
emit a relatively clear error message when we catch a MetaPhysicL logic error
Definition: MooseError.C:112
OrderWrapper order
This class provides an interface for common operations on field variables of both FE and FV types wit...
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
void write_traceout()
void indentMessage(const std::string &prefix, std::string &message, const char *color=COLOR_CYAN, bool dont_indent_first_line=true, const std::string &post_prefix=": ")
Indents the supplied message given the prefix and color.
Definition: MooseUtils.C:734
void mooseErrorRaw(std::string msg, const std::string prefix="")
Definition: MooseError.C:53
void print_trace(std::ostream &out_stream=std::cerr)
static const std::string & getRepositoryURL(const std::string &repo_name)
Returns the repository URL associated with repo_name.
Definition: Registry.C:173
libMesh::Threads::spin_mutex moose_stream_lock
Definition: MooseError.h:137
bool _throw_on_error
Variable to turn on exceptions during mooseError(), should only be used within MOOSE unit tests or wh...
Definition: Moose.C:762
std::string mooseMsgFmt(const std::string &msg, const std::string &title, const std::string &color)
Format a message for output with a title.
Definition: MooseError.C:37
std::string formatMooseDocumentedError(const std::string &repo_name, const unsigned int issue_num, const std::string &msg)
Formats a documented error.
Definition: MooseError.C:99