https://mooseframework.inl.gov
ElementDamper.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 
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  mooseAssert(_var.count() == 1,
50  "ElementDamper only supports scalar variables. Variable '" + _var.name() +
51  "' has multiple components.");
52 }
53 
54 Real
56 {
57  Real damping = 1.0;
58  Real cur_damping = 1.0;
59 
60  for (_qp = 0; _qp < _qrule->n_points(); _qp++)
61  {
62  cur_damping = computeQpDamping();
63  if (cur_damping < damping)
64  damping = cur_damping;
65  }
66 
67  return damping;
68 }
69 
70 bool
72 {
73  return _var.hasBlocks(elem->subdomain_id());
74 }
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:77
unsigned int count() const
Get the number of components Note: For standard and vector variables, the number is one...
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...
const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:103
unsigned int n_points() const
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const std::set< SubdomainID > EMPTY_BLOCK_IDS
Definition: MooseTypes.h:732
An interface for accessing Materials.
bool hasBlocks(const SubdomainID id) const override
Returns whether the functor is defined on this block.
const std::set< BoundaryID > EMPTY_BOUNDARY_IDS
Definition: MooseTypes.h:733
virtual Real computeQpDamping()=0
This MUST be overridden by a child damper.
MooseVariable & _var
Non-linear variable this damper works on.
Definition: ElementDamper.h:71
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...
const libMesh::QBase *const & _qrule
Quadrature rule.
Definition: ElementDamper.h:81
Real computeDamping()
Computes this Damper&#39;s damping for one element.
Definition: ElementDamper.C:55
const Elem & get(const ElemType type_in)
unsigned int THREAD_ID
Definition: MooseTypes.h:237
bool variableDefinedOnElement(const Elem *elem) const
Check whether this damper&#39;s variable has DOFs/components on the given element.
Definition: ElementDamper.C:71