www.mooseframework.org
ElementDamper.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 "ElementDamper.h"
11 
12 // MOOSE includes
13 #include "Assembly.h"
14 #include "FEProblem.h"
15 #include "MooseVariableFE.h"
16 #include "SubProblem.h"
17 #include "SystemBase.h"
18 
19 #include "libmesh/quadrature.h"
20 
23 {
26  params.addRequiredParam<NonlinearVariableName>(
27  "variable", "The name of the variable that this damper operates on");
28  return params;
29 }
30 
32  : Damper(parameters),
34  _tid(parameters.get<THREAD_ID>("_tid")),
35  _assembly(_subproblem.assembly(_tid, _sys.number())),
36  _coord_sys(_assembly.coordSystem()),
37  _var(_sys.getFieldVariable<Real>(_tid, parameters.get<NonlinearVariableName>("variable"))),
38 
39  _current_elem(_var.currentElem()),
40  _q_point(_assembly.qPoints()),
41  _qrule(_assembly.qRule()),
42  _JxW(_assembly.JxW()),
43 
44  _u_increment(_var.increment()),
45 
46  _u(_var.sln()),
47  _grad_u(_var.gradSln())
48 {
49 }
50 
51 Real
53 {
54  Real damping = 1.0;
55  Real cur_damping = 1.0;
56 
57  for (_qp = 0; _qp < _qrule->n_points(); _qp++)
58  {
59  cur_damping = computeQpDamping();
60  if (cur_damping < damping)
61  damping = cur_damping;
62  }
63 
64  return damping;
65 }
const QBase *const & _qrule
Quadrature rule.
Definition: ElementDamper.h:71
static InputParameters validParams()
Definition: ElementDamper.C:22
constexpr auto increment(std::index_sequence< first, tail... >)
Increment the first number in an index sequence, but roll over into the next number if it reaches Nma...
ElementDamper(const InputParameters &parameters)
Definition: ElementDamper.C:31
static InputParameters validParams()
Definition: Damper.C:16
unsigned int _qp
Quadrature point index.
Definition: ElementDamper.h:67
T * get(const std::unique_ptr< T > &u)
The MooseUtils::get() specializations are used to support making forwards-compatible code changes fro...
Definition: MooseUtils.h:1147
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
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...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const std::set< SubdomainID > EMPTY_BLOCK_IDS
Definition: MooseTypes.h:596
An interface for accessing Materials.
const std::set< BoundaryID > EMPTY_BOUNDARY_IDS
Definition: MooseTypes.h:597
virtual Real computeQpDamping()=0
This MUST be overridden by a child damper.
Base class for deriving dampers.
Definition: Damper.h:24
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
Real computeDamping()
Computes this Damper&#39;s damping for one element.
Definition: ElementDamper.C:52
unsigned int THREAD_ID
Definition: MooseTypes.h:198