SolutionInvalidInterface Class Reference

An interface that allows the marking of invalid solutions during a solve. More...

#include <SolutionInvalidInterface.h>

Inheritance diagram for SolutionInvalidInterface:

Public Member Functions
	SolutionInvalidInterface (MooseObject *const moose_object)

Protected Member Functions
template<bool warning>
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
	Set solution invalid mark for the given solution ID. More...
InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Private Attributes
MooseObject &	_si_moose_object
	The MooseObject that owns this interface. More...
FEProblemBase &	_si_problem
	A reference to FEProblem base. More...

Detailed Description

An interface that allows the marking of invalid solutions during a solve.

Definition at line 37 of file SolutionInvalidInterface.h.

Constructor & Destructor Documentation

SolutionInvalidInterface()

SolutionInvalidInterface::SolutionInvalidInterface

(

MooseObject *const

moose_object

)

Definition at line 17 of file SolutionInvalidInterface.C.

  : _si_moose_object(*moose_object),
    _si_problem(
        *_si_moose_object.parameters().getCheckedPointerParam<FEProblemBase *>("_fe_problem_base"))
{
}

Member Function Documentation

flagInvalidSolutionInternal()

template<bool warning>

template void SolutionInvalidInterface::flagInvalidSolutionInternal< false > ( const InvalidSolutionID  invalid_solution_id ) const

protected

Set solution invalid mark for the given solution ID.

Definition at line 27 of file SolutionInvalidInterface.C.

{
  mooseAssert(
      warning == moose::internal::getSolutionInvalidityRegistry().item(invalid_solution_id).warning,
      "Inconsistent warning flag");
  auto & solution_invalidity = _si_moose_object.getMooseApp().solutionInvalidity();
  if constexpr (!warning)
    if (_si_problem.immediatelyPrintInvalidSolution())
      solution_invalidity.printDebug(invalid_solution_id);
  return solution_invalidity.flagInvalidSolutionInternal(invalid_solution_id);
}

registerInvalidSolutionInternal()

InvalidSolutionID SolutionInvalidInterface::registerInvalidSolutionInternal ( const std::string &  message, const bool  warning  ) const

protected

Definition at line 41 of file SolutionInvalidInterface.C.

{
  return moose::internal::getSolutionInvalidityRegistry().registerInvalidity(
      _si_moose_object.type(), message, warning);
}

Member Data Documentation

_si_moose_object

MooseObject& SolutionInvalidInterface::_si_moose_object

private

The MooseObject that owns this interface.

Definition at line 52 of file SolutionInvalidInterface.h.

Referenced by flagInvalidSolutionInternal(), and registerInvalidSolutionInternal().

_si_problem

FEProblemBase& SolutionInvalidInterface::_si_problem

private

A reference to FEProblem base.

Definition at line 55 of file SolutionInvalidInterface.h.

Referenced by flagInvalidSolutionInternal().

---

The documentation for this class was generated from the following files:

• include/interfaces/SolutionInvalidInterface.h
• src/interfaces/SolutionInvalidInterface.C