Move solution invalid into a helper class at a higher level that also defines the mooseInfo/Warning/Error

so we no longer need to do "usingSolutionInvalidWarnings" in every user class
refs #28181

Author: GiudGiud

framework/include/actions/Action.h

@@ -15,7 +15,6 @@
 #include "Registry.h"
 #include "PerfGraphInterface.h"
 #include "MooseObjectParameterName.h"
-#include "SolutionInvalidInterface.h"
 
 #include <string>
 #include <ostream>
@@ -31,10 +30,7 @@ class Factory;
 /**
  * Base class for actions.
  */
-class Action : public ParallelParamObject,
-               public MeshMetaDataInterface,
-               public PerfGraphInterface,
-               public SolutionInvalidInterface
+class Action : public ParallelParamObject, public MeshMetaDataInterface, public PerfGraphInterface
 {
 public:
   /// The name of the parameter that contains the unique action name
@@ -51,9 +47,6 @@ class Action : public ParallelParamObject,
    */
   void timedAct();
 
-  // To get warnings tracked in the SolutionInvalidityOutput
-  usingCombinedWarningSolutionWarnings;
-
 private:
   /**
    * Method for adding a single relationship manager

framework/include/base/MooseBase.h

@@ -15,6 +15,7 @@
 #include "MooseError.h"
 #include "MooseObjectName.h"
 #include "MooseObjectParameterName.h"
+#include "MooseVerbosityHelper.h"
 
 class MooseApp;
 
@@ -46,7 +47,7 @@ class Node;
  * - MooseObject for an object created within a system
  * - Action for a class performing a setup task, like creating objects
  */
-class MooseBase : public ConsoleStreamInterface
+class MooseBase : public ConsoleStreamInterface, public MooseVerbosityHelper
 {
 public:
   /// The name of the parameter that contains the object type
@@ -130,11 +131,6 @@ class MooseBase : public ConsoleStreamInterface
    */
   const InputParameters & parameters() const { return _pars; }
 
-  /**
-   * @returns The block-level hit node for this object, if any
-   */
-  const hit::Node * getHitNode() const { return getHitNode(_pars); }
-
   /**
    * @returns Whether or not this object has a registered base (set via
    * InputParameters::registerBase())
@@ -220,138 +216,6 @@ class MooseBase : public ConsoleStreamInterface
                                  const std::string & object_name,
                                  const std::string & object_parameter) const;
 
-  /**
-   * Emits an error prefixed with the file and line number of the given param (from the input
-   * file) along with the full parameter path+name followed by the given args as the message.
-   * If this object's parameters were not created directly by the Parser, then this function falls
-   * back to the normal behavior of mooseError - only printing a message using the given args.
-   */
-  template <typename... Args>
-  [[noreturn]] void paramError(const std::string & param, Args... args) const;
-
-  /**
-   * Emits a warning prefixed with the file and line number of the given param (from the input
-   * file) along with the full parameter path+name followed by the given args as the message.
-   * If this object's parameters were not created directly by the Parser, then this function falls
-   * back to the normal behavior of mooseWarning - only printing a message using the given args.
-   */
-  template <typename... Args>
-  void paramWarning(const std::string & param, Args... args) const;
-
-  /**
-   * Emits an informational message prefixed with the file and line number of the given param
-   * (from the input file) along with the full parameter path+name followed by the given args as
-   * the message.  If this object's parameters were not created directly by the Parser, then this
-   * function falls back to the normal behavior of mooseInfo - only printing a message using
-   * the given args.
-   */
-  template <typename... Args>
-  void paramInfo(const std::string & param, Args... args) const;
-
-  /**
-   * @returns A prefix to be used in messages that contain the input
-   * file location associated with this object (if any) and the
-   * name and type of the object.
-   */
-  std::string messagePrefix(const bool hit_prefix = true) const
-  {
-    return messagePrefix(_pars, hit_prefix);
-  }
-
-  /**
-   * Deprecated message prefix; the error type is no longer used
-   */
-  std::string errorPrefix(const std::string &) const { return messagePrefix(); }
-
-  /**
-   * Emits an error prefixed with object name and type and optionally a file path
-   * to the top-level block parameter if available.
-   */
-  template <typename... Args>
-  [[noreturn]] void mooseError(Args &&... args) const
-  {
-    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
-  }
-
-  template <typename... Args>
-  [[noreturn]] void mooseDocumentedError(const std::string & repo_name,
-                                         const unsigned int issue_num,
-                                         Args &&... args) const
-  {
-    callMooseError(moose::internal::formatMooseDocumentedError(
-                       repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
-                   /* with_prefix = */ true);
-  }
-
-  /**
-   * Emits an error without the prefixing included in mooseError().
-   */
-  template <typename... Args>
-  [[noreturn]] void mooseErrorNonPrefixed(Args &&... args) const
-  {
-    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
-  }
-
-  /**
-   * Emits a warning prefixed with object name and type.
-   */
-  template <typename... Args>
-  void mooseWarning(Args &&... args) const
-  {
-    moose::internal::mooseWarningStream(_console, messagePrefix(true), std::forward<Args>(args)...);
-  }
-
-  /**
-   * Emits a warning without the prefixing included in mooseWarning().
-   */
-  template <typename... Args>
-  void mooseWarningNonPrefixed(Args &&... args) const
-  {
-    moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
-  }
-
-  template <typename... Args>
-  void mooseDeprecated(Args &&... args) const
-  {
-    moose::internal::mooseDeprecatedStream(
-        _console, false, true, messagePrefix(true), std::forward<Args>(args)...);
-  }
-
-  template <typename... Args>
-  void mooseInfo(Args &&... args) const
-  {
-    moose::internal::mooseInfoStream(_console, messagePrefix(true), std::forward<Args>(args)...);
-  }
-
-  /**
-   * External method for calling moose error with added object context.
-   * @param msg The message
-   * @param with_prefix If true, add the prefix from messagePrefix(), which is the object
-   * information (type, name, etc)
-   * @param node Optional hit node to add file path context as a prefix
-   */
-  [[noreturn]] void
-  callMooseError(std::string msg, const bool with_prefix, const hit::Node * node = nullptr) const;
-
-  /**
-   * External method for calling moose error with added object context.
-   *
-   * Needed so that objects without the MooseBase context (InputParameters)
-   * can call errors with context
-   *
-   * @param app The app pointer (if available); adds multiapp context and clears the console
-   * @param params The parameters, needed to obtain object information
-   * @param msg The message
-   * @param with_prefix If true, add the prefix from messagePrefix(), which is the object
-   * information (type, name, etc)
-   * @param node Optional hit node to add file path context as a prefix
-   */
-  [[noreturn]] static void callMooseError(MooseApp * const app,
-                                          const InputParameters & params,
-                                          std::string msg,
-                                          const bool with_prefix,
-                                          const hit::Node * node);
-
 protected:
   /// The MOOSE application this is associated with
   MooseApp & _app;
@@ -364,23 +228,6 @@ class MooseBase : public ConsoleStreamInterface
 
   /// The object's parameters
   const InputParameters & _pars;
-
-private:
-  /**
-   * Internal method for getting the message prefix for an object (object type, name, etc).
-   *
-   * Needs to be static so that we can call it externally from InputParameters for
-   * errors that do not have context of the MooseBase
-   */
-  static std::string messagePrefix(const InputParameters & params, const bool hit_prefix);
-
-  /**
-   * Internal method for getting a hit node (if available) given a set of parameters
-   *
-   * Needs to be static so that we can call it externally from InputParameters for
-   * errors that do not have context of the MooseBase
-   */
-  static const hit::Node * getHitNode(const InputParameters & params);
 };
 
 template <typename T>
@@ -434,23 +281,89 @@ MooseBase::getCheckedPointerParam(const std::string & name, const std::string &
   return _pars.getCheckedPointerParam<T>(name, error_string);
 }
 
+// These templates for routines in MooseVerbosityHelper need to be defined here because they require
+// the declaration of a MooseBase to be known at compile time.
+template <typename... Args>
+void
+MooseVerbosityHelper::untrackedMooseWarning(Args &&... args) const
+{
+  moose::internal::mooseWarningStream(
+      _moose_base._console, messagePrefix(true), std::forward<Args>(args)...);
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::untrackedMooseWarningNonPrefixed(Args &&... args) const
+{
+  moose::internal::mooseWarningStream(_moose_base._console, std::forward<Args>(args)...);
+}
+
 template <typename... Args>
 [[noreturn]] void
-MooseBase::paramError(const std::string & param, Args... args) const
+MooseVerbosityHelper::paramError(const std::string & param, Args... args) const
+{
+  _moose_base.parameters().paramError(param, std::forward<Args>(args)...);
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::untrackedParamWarning(const std::string & param, Args... args) const
+{
+  mooseWarning(_moose_base.parameters().paramMessage(param, std::forward<Args>(args)...));
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::paramInfo(const std::string & param, Args... args) const
+{
+  mooseInfo(_moose_base.parameters().paramMessage(param, std::forward<Args>(args)...));
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::untrackedMooseDeprecated(Args &&... args) const
+{
+  moose::internal::mooseDeprecatedStream(
+      _moose_base._console, false, true, messagePrefix(true), std::forward<Args>(args)...);
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::mooseWarning(Args &&... args) const
+{
+  untrackedMooseWarning(std::forward<Args>(args)...);
+  flagSolutionWarningMultipleRegistration(_moose_base.name() + ": warning");
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::mooseWarningNonPrefixed(Args &&... args) const
+{
+  untrackedMooseWarningNonPrefixed(std::forward<Args>(args)...);
+  flagSolutionWarningMultipleRegistration(_moose_base.name() + ": warning");
+}
+
+template <typename... Args>
+void
+MooseVerbosityHelper::mooseDeprecated(Args &&... args) const
 {
-  _pars.paramError(param, std::forward<Args>(args)...);
+  untrackedMooseDeprecated(std::forward<Args>(args)...);
+  flagSolutionWarningMultipleRegistration(_moose_base.name() + ": deprecation");
 }
 
 template <typename... Args>
 void
-MooseBase::paramWarning(const std::string & param, Args... args) const
+MooseVerbosityHelper::mooseInfo(Args &&... args) const
 {
-  mooseWarning(_pars.paramMessage(param, std::forward<Args>(args)...));
+  moose::internal::mooseInfoStream(
+      _moose_base._console, messagePrefix(true), std::forward<Args>(args)...);
 }
 
 template <typename... Args>
 void
-MooseBase::paramInfo(const std::string & param, Args... args) const
+MooseVerbosityHelper::paramWarning(const std::string & param, Args... args) const
 {
-  mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
+  untrackedParamWarning(param, std::forward<Args>(args)...);
+  flagSolutionWarningMultipleRegistration(_moose_base.name() + ": warning for parameter '" + param +
+                                          "'");
 }

framework/include/base/MooseObject.h

@@ -16,7 +16,7 @@
 #include "ConsoleStreamInterface.h"
 #include "Registry.h"
 #include "MooseObjectParameterName.h"
-#include "SolutionInvalidInterface.h"
+#include "MooseVerbosityHelper.h"
 
 #define usingMooseObjectMembers                                                                    \
   usingMooseBaseMembers;                                                                           \
@@ -25,9 +25,7 @@
 /**
  * Every object that can be built by the factory should be derived from this class.
  */
-class MooseObject : public ParallelParamObject,
-                    public SolutionInvalidInterface,
-                    public std::enable_shared_from_this<MooseObject>
+class MooseObject : public ParallelParamObject, public std::enable_shared_from_this<MooseObject>
 {
 public:
   static InputParameters validParams();
@@ -65,9 +63,6 @@ class MooseObject : public ParallelParamObject,
   bool isKokkosObject() const { return parameters().isParamValid(MooseBase::kokkos_object_param); }
 #endif
 
-  // To get warnings tracked in the SolutionInvalidityOutput
-  usingCombinedWarningSolutionWarnings;
-
 protected:
   /// Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects
   const bool & _enabled;