www.mooseframework.org
BoundaryCondition.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 "BoundaryCondition.h"
11 
14 {
17 
18  params.addParam<bool>("use_displaced_mesh",
19  false,
20  "Whether or not this object should use the "
21  "displaced mesh for computation. Note that "
22  "in the case this is true but no "
23  "displacements are provided in the Mesh block "
24  "the undisplaced mesh will still be used.");
25 
26  params.addParamNamesToGroup("use_displaced_mesh", "Advanced");
27  params.addCoupledVar("displacements", "The displacements");
28  params.registerBase("BoundaryCondition");
29 
30  return params;
31 }
32 
34  : ResidualObject(parameters, nodal),
35  BoundaryRestrictableRequired(this, nodal),
38 {
39 }
A class for requiring an object to be boundary restricted.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void registerBase(const std::string &value)
This method must be called from every base "Moose System" to create linkage with the Action System...
Interface for objects that need to use distributions.
static InputParameters validParams()
void addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
This is the common base class for objects that give residual contributions.
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
static InputParameters validParams()
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...
BoundaryCondition(const InputParameters &parameters, bool nodal)
Class constructor.