www.mooseframework.org
InclinedNoDisplacementBCAction.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 
11 #include "Factory.h"
12 #include "FEProblem.h"
13 #include "Conversion.h"
14 
15 registerMooseAction("SolidMechanicsApp", InclinedNoDisplacementBCAction, "add_bc");
16 
19 {
21  params.addClassDescription("Set up inclined no displacement boundary conditions");
22 
23  params.addRequiredParam<std::vector<BoundaryName>>(
24  "boundary", "The list of boundary IDs from the mesh where the pressure will be applied");
25 
26  params.addParam<std::vector<VariableName>>(
27  "displacements",
28  {},
29  "The displacements appropriate for the simulation geometry and coordinate system");
30  params.addParam<std::vector<AuxVariableName>>("save_in", {}, "The displacement residuals");
31 
32  params.addRequiredParam<Real>("penalty", "Penalty parameter");
33  params.addParam<bool>("use_automatic_differentiation",
34  false,
35  "Flag to use automatic differentiation (AD) objects when possible");
36  return params;
37 }
38 
40  : Action(params),
41  _use_ad(getParam<bool>("use_automatic_differentiation")),
42  _displacements(getParam<std::vector<VariableName>>("displacements")),
43  _ndisp(_displacements.size()),
44  _save_in(getParam<std::vector<AuxVariableName>>("save_in"))
45 {
46  if (_ndisp == 1)
47  mooseError("InclinedNoDisplacementBC is specific to 2D and 3D models.");
48 
49  if (_save_in.size() != 0 && _save_in.size() != _ndisp)
50  mooseError("Number of save_in variables should equal to the number of displacement variables ",
51  _displacements.size());
52 }
53 
54 void
56 {
57  std::string ad_prepend = "";
58  if (_use_ad)
59  ad_prepend = "AD";
60  const std::string kernel_name = ad_prepend + "PenaltyInclinedNoDisplacementBC";
61 
62  // Create pressure BCs
63  for (unsigned int i = 0; i < _ndisp; ++i)
64  {
65  // Create unique kernel name for each of the components
66  std::string unique_kernel_name = kernel_name + "_" + _name + "_" + Moose::stringify(i);
67 
68  InputParameters params = _factory.getValidParams(kernel_name);
69  params.applyParameters(parameters());
70  params.set<bool>("use_displaced_mesh") = false;
71  params.set<unsigned int>("component") = i;
72  params.set<NonlinearVariableName>("variable") = _displacements[i];
73 
74  if (_save_in.size() == _ndisp)
75  params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
76 
77  _problem->addBoundaryCondition(kernel_name, unique_kernel_name, params);
78  }
79 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
T & set(const std::string &name, bool quiet_mode=false)
const bool _use_ad
Flag to use automatic differentiation.
InputParameters getValidParams(const std::string &name) const
void applyParameters(const InputParameters &common, const std::vector< std::string > &exclude={}, const bool allow_private=false)
void addRequiredParam(const std::string &name, const std::string &doc_string)
registerMooseAction("SolidMechanicsApp", InclinedNoDisplacementBCAction, "add_bc")
Factory & _factory
static InputParameters validParams()
std::string stringify(const T &t)
std::vector< VariableName > _displacements
displacement variables
const std::string _name
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void mooseError(Args &&... args) const
void addClassDescription(const std::string &doc_string)
std::shared_ptr< FEProblemBase > & _problem
const InputParameters & parameters() const
InclinedNoDisplacementBCAction(const InputParameters &params)
unsigned int _ndisp
number of displacement variables
std::vector< AuxVariableName > _save_in
auxvariables to save residuals