https://mooseframework.inl.gov
ReferenceResidualInterface.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 #include "MooseTypes.h"
13 #include "InputParameters.h"
14 
15 class InputParameters;
16 class MooseObject;
17 
22 {
23 public:
25 
26  ReferenceResidualInterface(const MooseObject * moose_object);
27 
35  template <typename T>
36  void addGroupVariables(const std::set<T> & group_vars);
37 
38 protected:
40  std::vector<std::vector<NonlinearVariableName>> _group_variables;
41 
44 };
45 
46 template <typename T>
47 void
48 ReferenceResidualInterface::addGroupVariables(const std::set<T> & group_vars)
49 {
50  _group_variables.push_back(
51  std::vector<NonlinearVariableName>(group_vars.begin(), group_vars.end()));
52  _use_group_variables = true;
53 }
void addGroupVariables(const std::set< T > &group_vars)
Add a set of variables that need to be grouped together.
Interface class shared between ReferenceResidualProblem and ReferenceResidualConvergence.
std::vector< std::vector< NonlinearVariableName > > _group_variables
Name of variables that are grouped together to check convergence.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
bool _use_group_variables
True if any variables are grouped.
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:28
ReferenceResidualInterface(const MooseObject *moose_object)