www.mooseframework.org
AddFunctionAction.C
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 #include "AddFunctionAction.h"
11 #include "FEProblem.h"
12 
13 registerMooseAction("MooseApp", AddFunctionAction, "add_function");
14 
17 {
19  params.addClassDescription("Add a Function object to the simulation.");
20  return params;
21 }
22 
24 
25 void
27 {
29  std::string vars = "x,y,z,t,NaN,pi,e";
30  if (fp.Parse(_name, vars) == -1) // -1 for success
31  mooseWarning("Function name '" + _name + "' could evaluate as a ParsedFunction");
32  _problem->addFunction(_type, _name, _moose_object_pars);
33 }
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void mooseWarning(Args &&... args) const
Emits a warning prefixed with object name and type.
This class parses functions in the [Functions] block and creates them.
const std::string _name
The name of this class.
Definition: MooseBase.h:90
virtual void act() override
Method to add objects to the simulation or perform other setup tasks.
std::string _type
The Object type that is being created.
InputParameters _moose_object_pars
The parameters for the object to be created.
registerMooseAction("MooseApp", AddFunctionAction, "add_function")
AddFunctionAction(const InputParameters &params)
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...
std::shared_ptr< FEProblemBase > & _problem
Convenience reference to a problem this action works on.
Definition: Action.h:179
static InputParameters validParams()