DiagnosticsInterface.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/base/NEML2Object.h"
 
namespace neml2
{
// Forward decl
class DiagnosticsInterface;
class VariableBase;
 
class Diagnosis : public NEMLException
{
public:
  using NEMLException::NEMLException;
};
 
void diagnose(const DiagnosticsInterface &);
 
class DiagnosticsInterface
{
public:
  DiagnosticsInterface() = delete;
  DiagnosticsInterface(NEML2Object * object);
 
  DiagnosticsInterface(DiagnosticsInterface &&) = delete;
  DiagnosticsInterface(const DiagnosticsInterface &) = delete;
  DiagnosticsInterface & operator=(const DiagnosticsInterface &) = delete;
  DiagnosticsInterface & operator=(DiagnosticsInterface &&) = delete;
  virtual ~DiagnosticsInterface() = default;
 
  virtual void diagnose(std::vector<Diagnosis> & diagnoses) const = 0;
 
  template <typename... Args>
  void diagnostic_assert(std::vector<Diagnosis> & diagnoses, bool assertion, Args &&... args) const;
 
  void diagnostic_assert_state(std::vector<Diagnosis> & diagnoses, const VariableBase & v) const;
  void diagnostic_assert_old_state(std::vector<Diagnosis> & diagnoses,
                                   const VariableBase & v) const;
  void diagnostic_assert_force(std::vector<Diagnosis> & diagnoses, const VariableBase & v) const;
  void diagnostic_assert_old_force(std::vector<Diagnosis> & diagnoses,
                                   const VariableBase & v) const;
  void diagnostic_assert_residual(std::vector<Diagnosis> & diagnoses, const VariableBase & v) const;
  void diagnostic_check_input_variable(std::vector<Diagnosis> & diagnoses,
                                       const VariableBase & v) const;
  void diagnostic_check_output_variable(std::vector<Diagnosis> & diagnoses,
                                        const VariableBase & v) const;
 
private:
  NEML2Object * _object;
};
 
template <typename... Args>
void
DiagnosticsInterface::diagnostic_assert(std::vector<Diagnosis> & diagnoses,
                                        bool assertion,
                                        Args &&... args) const
{
  if (assertion)
    return;
 
  std::ostringstream oss;
  internal::stream_all(oss,
                       "In object '",
                       _object->name(),
                       "' of type ",
                       _object->type(),
                       ": ",
                       std::forward<Args>(args)...);
  diagnoses.emplace_back(Diagnosis(oss.str()));
}
}