https://mooseframework.inl.gov
SolutionInvalidityReporter.h
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 #pragma once
11 
12 #include "GeneralReporter.h"
13 
14 class SolutionInvalidity;
15 
20 {
21 public:
23 
25 
26  void initialize() override {}
27  void finalize() override {}
28  void execute() override {}
29 };
30 
31 // Store solution invalid warnings to a json file
32 void to_json(nlohmann::json & json, const SolutionInvalidity * const & solution_invalidity);
33 
42 void
44 dataStore(std::ostream &, const SolutionInvalidity *&, void *)
45 {
46 }
47 void
48 dataLoad(std::istream &, const SolutionInvalidity *&, void *)
49 {
50 }
Reporter object that has a single execution of the "execute" method for for each execute flag...
void dataLoad(std::istream &, const SolutionInvalidity *&, void *)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void execute() override
Execute method.
void initialize() override
Called before execute() is ever called so that data can be cleared.
The SolutionInvalidity will contain all the information about the occurrence(s) of solution invalidit...
void finalize() override
Finalize.
void to_json(nlohmann::json &json, const SolutionInvalidity *const &solution_invalidity)
Reports the summary table of solution invalid warnings.
const InputParameters & parameters() const
Get the parameters of the object.
SolutionInvalidityReporter(const InputParameters &parameters)
void dataStore(std::ostream &, const SolutionInvalidity *&, void *)
Store and load methods for const SolutionInvalidity *, used in the SolutionInvalidityReporter, which does nothing.
static InputParameters validParams()