ExecutorInterface Class Reference

Interface class for classes which interact with Postprocessors. More...

#include <ExecutorInterface.h>

Inheritance diagram for ExecutorInterface:

Public Member Functions
	ExecutorInterface (const MooseObject *moose_object)
Executor &	getExecutor (const std::string &param_name) const
	Get an Executor based on a parameter name. More...
Executor &	getExecutorByName (const ExecutorName &executor_name) const
	Get an Executor based on its actual name. More...

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
const MooseObject *	_ei_moose_object
MooseApp &	_ei_app

Detailed Description

Interface class for classes which interact with Postprocessors.

Provides the getPostprocessorValueXYZ() and related interfaces.

Definition at line 30 of file ExecutorInterface.h.

Constructor & Destructor Documentation

ExecutorInterface()

ExecutorInterface::ExecutorInterface

(

const MooseObject *

moose_object

)

Definition at line 24 of file ExecutorInterface.C.

  : _ei_moose_object(moose_object), _ei_app(moose_object->getMooseApp())
{
}

Member Function Documentation

getExecutor()

Executor & ExecutorInterface::getExecutor

(

const std::string &

param_name

)

const

Get an Executor based on a parameter name.

Parameters

param_name

The name of the parameter

Definition at line 30 of file ExecutorInterface.C.

{
  auto & params = _ei_moose_object->parameters();

  if (!params.isParamValid(param_name))
    return *_ei_app.getNullExecutor();

  return _ei_app.getExecutor(_ei_moose_object->getParam<ExecutorName>(param_name));
}

getExecutorByName()

Executor & ExecutorInterface::getExecutorByName

(

const ExecutorName &

executor_name

)

const

Get an Executor based on its actual name.

Parameters

executor_name

the actual name of the Executor

Definition at line 41 of file ExecutorInterface.C.

{
  return _ei_app.getExecutor(executor_name);
}

validParams()

InputParameters ExecutorInterface::validParams ( )

static

Definition at line 19 of file ExecutorInterface.C.

{
  return emptyInputParameters();
}

Member Data Documentation

_ei_app

MooseApp& ExecutorInterface::_ei_app

private

Definition at line 54 of file ExecutorInterface.h.

Referenced by getExecutor(), and getExecutorByName().

_ei_moose_object

const MooseObject* ExecutorInterface::_ei_moose_object

private

Definition at line 52 of file ExecutorInterface.h.

Referenced by getExecutor().

---

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

• include/executors/ExecutorInterface.h
• src/executors/ExecutorInterface.C