StickyBC Class Reference

Sticky-type boundary condition, where if the old variable value exceeds the bounds provided u is fixed (ala Dirichlet) to the old value. More...

#include <StickyBC.h>

Inheritance diagram for StickyBC:

Public Member Functions
	StickyBC (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual bool	shouldApply () override
virtual Real	computeQpResidual () override

Protected Attributes
const VariableValue &	_u_old
const Real	_min_value
	The minimum bound. More...
const Real	_max_value
	The maximum bound. More...

Detailed Description

Sticky-type boundary condition, where if the old variable value exceeds the bounds provided u is fixed (ala Dirichlet) to the old value.

Definition at line 24 of file StickyBC.h.

Constructor & Destructor Documentation

StickyBC()

StickyBC::StickyBC

(

const InputParameters &

parameters

)

Definition at line 34 of file StickyBC.C.

  : NodalBC(parameters),
    _u_old(_var.dofValuesOld()),
    _min_value(getParam<Real>("min_value")),
    _max_value(getParam<Real>("max_value"))
{
  if (_min_value > _max_value)
    mooseError("StickyBC: min_value must not be greater than max_value");
}

Member Function Documentation

computeQpResidual()

Real StickyBC::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 52 of file StickyBC.C.

{
  return _u[_qp] - _u_old[_qp];
}

shouldApply()

bool StickyBC::shouldApply ( )

overrideprotectedvirtual

Definition at line 45 of file StickyBC.C.

{
  const unsigned qp = 0; // this is a NodalBC: all qp = 0
  return (_u_old[qp] <= _min_value || _u_old[qp] >= _max_value);
}

validParams()

InputParameters StickyBC::validParams ( )

static

Definition at line 18 of file StickyBC.C.

{
  InputParameters params = NodalBC::validParams();
  params.addParam<Real>(
      "min_value",
      std::numeric_limits<Real>::lowest(),
      "If the old variable value <= min_value, the variable is fixed at its old value");
  params.addParam<Real>(
      "max_value",
      std::numeric_limits<Real>::max(),
      "If the old variable value >= max_value, the variable is fixed at its old value");
  params.addClassDescription(
      "Imposes the boundary condition $u = u_{old}$ if $u_{old}$ exceeds the bounds provided");
  return params;
}

Member Data Documentation

_max_value

const Real StickyBC::_max_value

protected

The maximum bound.

Definition at line 40 of file StickyBC.h.

Referenced by shouldApply(), and StickyBC().

_min_value

const Real StickyBC::_min_value

protected

The minimum bound.

Definition at line 38 of file StickyBC.h.

Referenced by shouldApply(), and StickyBC().

_u_old

const VariableValue& StickyBC::_u_old

protected

Definition at line 36 of file StickyBC.h.

Referenced by computeQpResidual(), and shouldApply().

---

The documentation for this class was generated from the following files:

• tensor_mechanics/include/bcs/StickyBC.h
• tensor_mechanics/src/bcs/StickyBC.C