www.mooseframework.org
PressureAction.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 "PressureAction.h"
11 #include "Factory.h"
12 #include "FEProblem.h"
13 #include "Conversion.h"
14 
15 registerMooseAction("TensorMechanicsApp", PressureAction, "add_bc");
16 
18 
19 InputParameters
21 {
22  InputParameters params = Action::validParams();
23  params.addClassDescription("Set up Pressure boundary conditions");
24 
25  params.addRequiredParam<std::vector<BoundaryName>>(
26  "boundary", "The list of boundary IDs from the mesh where the pressure will be applied");
27 
28  params.addParam<VariableName>("disp_x", "The x displacement");
29  params.addParam<VariableName>("disp_y", "The y displacement");
30  params.addParam<VariableName>("disp_z", "The z displacement");
31 
32  params.addParam<std::vector<VariableName>>(
33  "displacements",
34  "The displacements appropriate for the simulation geometry and coordinate system");
35 
36  params.addParam<std::vector<AuxVariableName>>("save_in_disp_x",
37  "The save_in variables for x displacement");
38  params.addParam<std::vector<AuxVariableName>>("save_in_disp_y",
39  "The save_in variables for y displacement");
40  params.addParam<std::vector<AuxVariableName>>("save_in_disp_z",
41  "The save_in variables for z displacement");
42 
43  params.addParam<Real>("factor", 1.0, "The factor to use in computing the pressure");
44  params.addParam<Real>("alpha", 0.0, "alpha parameter for HHT time integration");
45  params.addParam<FunctionName>("function", "The function that describes the pressure");
46  params.addParam<bool>("use_automatic_differentiation",
47  false,
48  "Flag to use automatic differentiation (AD) objects when possible");
49  return params;
50 }
51 
52 PressureAction::PressureAction(const InputParameters & params)
53  : Action(params), _use_ad(getParam<bool>("use_automatic_differentiation"))
54 {
55  _save_in_vars.push_back(getParam<std::vector<AuxVariableName>>("save_in_disp_x"));
56  _save_in_vars.push_back(getParam<std::vector<AuxVariableName>>("save_in_disp_y"));
57  _save_in_vars.push_back(getParam<std::vector<AuxVariableName>>("save_in_disp_z"));
58 
59  _has_save_in_vars.push_back(params.isParamValid("save_in_disp_x"));
60  _has_save_in_vars.push_back(params.isParamValid("save_in_disp_y"));
61  _has_save_in_vars.push_back(params.isParamValid("save_in_disp_z"));
62 }
63 
64 void
66 {
67  std::string ad_append = "";
68  std::string ad_prepend = "";
69  if (_use_ad)
70  {
71  ad_append = "<RESIDUAL>";
72  ad_prepend = "AD";
73  }
74 
75  std::string kernel_name = ad_prepend + "Pressure";
76 
77  std::vector<VariableName> displacements;
78  if (isParamValid("displacements"))
79  displacements = getParam<std::vector<VariableName>>("displacements");
80  else
81  {
82  // Legacy parameter scheme for displacements
83  if (!isParamValid("disp_x"))
84  mooseError("Specify displacement variables using the `displacements` parameter.");
85  displacements.push_back(getParam<VariableName>("disp_x"));
86 
87  if (isParamValid("disp_y"))
88  {
89  displacements.push_back(getParam<VariableName>("disp_y"));
90  if (isParamValid("disp_z"))
91  displacements.push_back(getParam<VariableName>("disp_z"));
92  }
93  }
94 
95  // Create pressure BCs
96  for (unsigned int i = 0; i < displacements.size(); ++i)
97  {
98  // Create unique kernel name for each of the components
99  std::string unique_kernel_name = kernel_name + "_" + _name + "_" + Moose::stringify(i);
100 
101  InputParameters params = _factory.getValidParams(kernel_name + ad_append);
102  params.applyParameters(parameters(), {"factor"});
103  params.set<bool>("use_displaced_mesh") = true;
104  params.set<unsigned int>("component") = i;
105  params.set<NonlinearVariableName>("variable") = displacements[i];
106 
107  if (_has_save_in_vars[i])
108  params.set<std::vector<AuxVariableName>>("save_in") = _save_in_vars[i];
109 
110  if (_use_ad)
111  {
112  params.set<Real>("constant") = getParam<Real>("factor");
113  _problem->addBoundaryCondition(
114  kernel_name + ad_append, unique_kernel_name + "_residual", params);
115  _problem->addBoundaryCondition(
116  kernel_name + "<JACOBIAN>", unique_kernel_name + "_jacobian", params);
117  _problem->haveADObjects(true);
118  }
119  else
120  {
121  params.set<Real>("factor") = getParam<Real>("factor");
122  _problem->addBoundaryCondition(kernel_name, unique_kernel_name, params);
123  }
124  }
125 }
PressureAction::validParams
static InputParameters validParams()
Definition: PressureAction.C:20
PressureAction::_save_in_vars
std::vector< std::vector< AuxVariableName > > _save_in_vars
Definition: PressureAction.h:27
PressureAction
Definition: PressureAction.h:14
registerMooseAction
registerMooseAction("TensorMechanicsApp", PressureAction, "add_bc")
PressureAction::PressureAction
PressureAction(const InputParameters &params)
Definition: PressureAction.C:52
validParams
InputParameters validParams()
PressureAction.h
defineLegacyParams
defineLegacyParams(PressureAction)
PressureAction::_has_save_in_vars
std::vector< bool > _has_save_in_vars
Definition: PressureAction.h:28
PressureAction::act
virtual void act() override
Definition: PressureAction.C:65
PressureAction::_use_ad
const bool _use_ad
Flag to use automatic differentiation.
Definition: PressureAction.h:25