https://mooseframework.inl.gov
Loading...
Searching...
No Matches
NullExecutor.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 "NullExecutor.h"
11
13
16{
19 "Dummy executor that does nothing. Useful for testing among other things.");
20 return params;
21}
22
23NullExecutor::NullExecutor(const InputParameters & parameters) : Executor(parameters) {}
24
27{
28 Result & result = newResult();
29 return result;
30}
registerMooseObject("MooseApp", NullExecutor)
The Executor class directs the execution flow of simulations.
Definition Executor.h:27
Result & newResult()
Executors need to return a Result object describing how execution went - rather than constructing Res...
Definition Executor.h:146
static InputParameters validParams()
Definition Executor.C:17
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.
virtual Result run() override
This function contains the primary execution implementation for a executor.
static InputParameters validParams()
NullExecutor(const InputParameters &parameters)
This object tracks the success/failure state of the executor system as execution proceeds in a simula...
Definition Executor.h:36