Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
CommonOutputAction.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 // MOOSE includes
13 #include "Action.h"
14 
15 #include <optional>
16 
24 class CommonOutputAction : public Action
25 {
26 public:
28 
29  CommonOutputAction(const InputParameters & params);
30 
31  virtual void act() override;
32 
33 private:
39  void create(std::string object_type,
40  const std::optional<std::string> & param_name,
41  const InputParameters * const from_params = nullptr);
42 
47  bool hasConsole();
48 
51 };
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:33
static InputParameters validParams()
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.