https://mooseframework.inl.gov
BoundaryRestrictableRequired.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 
11 #include "InputParameters.h"
12 
15 {
16  // Create instance of InputParameters
18 
19  // Create user-facing 'boundary' input for restricting inheriting object to boundaries
20  params.addRequiredParam<std::vector<BoundaryName>>(
21  "boundary", "The list of boundary IDs from the mesh where this object applies");
22 
23  // A parameter for disabling error message for objects restrictable by boundary and block,
24  // if the parameter is valid it was already set so don't do anything
25  if (!params.isParamValid("_dual_restrictable"))
26  params.addPrivateParam<bool>("_dual_restrictable", false);
27 
28  return params;
29 }
30 
32  bool nodal)
33  : BoundaryRestrictable(moose_object, nodal)
34 {
35 }
36 
37 #ifdef MOOSE_KOKKOS_ENABLED
39  const BoundaryRestrictableRequired & object, const Moose::Kokkos::FunctorCopy & key)
40  : BoundaryRestrictable(object, key)
41 {
42 }
43 #endif
A class for requiring an object to be boundary restricted.
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
/class BoundaryRestrictable /brief Provides functionality for limiting the object to certain boundary...
BoundaryRestrictableRequired(const MooseObject *moose_object, bool nodal)
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters emptyInputParameters()
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:27
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.