www.mooseframework.org
CommonOutputAction.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 // MOOSE includes
13 #include "Action.h"
14 
15 #include <optional>
16 
24 class CommonOutputAction : public Action
25 {
26 public:
31 
32  CommonOutputAction(const InputParameters & params);
33 
34  virtual void act() override;
35 
36 private:
42  void create(std::string object_type,
43  const std::optional<std::string> & param_name,
44  const InputParameters * const from_params = nullptr);
45 
50  bool hasConsole();
51 
54 };
InputParameters _action_params
Parameters from the action being created (AddOutputAction)
void create(std::string object_type, const std::optional< std::string > &param_name, const InputParameters *const from_params=nullptr)
Helper method for creating the short-cut actions.
bool hasConsole()
Check if a Console object that outputs to the screen has been defined.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
CommonOutputAction(const InputParameters &params)
Base class for actions.
Definition: Action.h:38
static InputParameters validParams()
Class constructor.
virtual void act() override
Method to add objects to the simulation or perform other setup tasks.
Meta-action for creating common output object parameters This action serves two purpose, first it adds common output object parameters.