https://mooseframework.inl.gov
ConstantReporter.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 "ConstantReporter.h"
11 
13 
16 {
18  params.addClassDescription("Reporter with constant values to be accessed by other objects, can "
19  "be modified using transfers.");
20 
21  params += addReporterTypeParams<int>("integer");
22  params += addReporterTypeParams<Real>("real");
23  params += addReporterTypeParams<std::string>("string");
24  params += addReporterTypeParams<dof_id_type>("dof_id_type");
25  params += addReporterTypeParams<Point>("point");
26  params += addReporterTypeParams<RealEigenVector>("eigen_vector", false, false);
27  params += addReporterTypeParams<RealEigenMatrix>("eigen_matrix", false, false);
28 
29  return params;
30 }
31 
33 {
34  declareConstantReporterValues<int>("integer");
35  declareConstantReporterValues<Real>("real");
36  declareConstantReporterValues<std::string>("string");
37  declareConstantReporterValues<dof_id_type>("dof_id_type");
38  declareConstantReporterValues<Point>("point");
39  declareConstantVectorReporterValues<int>("integer");
40  declareConstantVectorReporterValues<Real>("real");
41  declareConstantVectorReporterValues<std::string>("string");
42  declareConstantVectorReporterValues<dof_id_type>("dof_id_type");
43  declareConstantVectorVectorReporterValues<int>("integer");
44  declareConstantVectorVectorReporterValues<Real>("real");
45  declareConstantVectorVectorReporterValues<std::string>("string");
46  declareConstantVectorVectorReporterValues<dof_id_type>("dof_id_type");
47  declareConstantReporterValue<RealEigenVector>("eigen_vector");
48  declareConstantReporterValue<RealEigenMatrix>("eigen_matrix");
49 }
Reporter object that has a single execution of the "execute" method for for each execute flag...
ConstantReporter(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObject("MooseApp", ConstantReporter)
static InputParameters validParams()
static InputParameters validParams()
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...