PenaltyEqualValueConstraintTempl< is_ad > Class Template Reference

Constrain the value of a variable to be the same on both sides of an interface using a generalized force stemming from a penalty-based enforcement. More...

#include <PenaltyEqualValueConstraint.h>

Inheritance diagram for PenaltyEqualValueConstraintTempl< is_ad >:

Public Member Functions
	PenaltyEqualValueConstraintTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
GenericReal< is_ad >	computeQpResidual (Moose::MortarType mortar_type) final
GenericReal< is_ad >	computeQpJacobian (Moose::ConstraintJacobianType jacobian_type, unsigned int jvar)
template<>
ADReal	computeQpJacobian (Moose::ConstraintJacobianType, unsigned int)
template<>
Real	computeQpJacobian (Moose::ConstraintJacobianType jacobian_type, unsigned int jvar)

Protected Attributes
const Real	_penalty_value
	Penalty value used to enforce the constraint. More...

Detailed Description

template<bool is_ad>
class PenaltyEqualValueConstraintTempl< is_ad >

Constrain the value of a variable to be the same on both sides of an interface using a generalized force stemming from a penalty-based enforcement.

Definition at line 25 of file PenaltyEqualValueConstraint.h.

Constructor & Destructor Documentation

PenaltyEqualValueConstraintTempl()

template<bool is_ad>

PenaltyEqualValueConstraintTempl< is_ad >::PenaltyEqualValueConstraintTempl

(

const InputParameters &

parameters

)

Definition at line 32 of file PenaltyEqualValueConstraint.C.

  : MortarConstraintTempl<is_ad>(parameters),
    _penalty_value(this->template getParam<Real>("penalty_value"))
{
}

Member Function Documentation

computeQpJacobian() [1/3]

template<bool is_ad>

GenericReal<is_ad> PenaltyEqualValueConstraintTempl< is_ad >::computeQpJacobian ( Moose::ConstraintJacobianType  jacobian_type, unsigned int  jvar  )

protected

computeQpJacobian() [2/3]

template<>

ADReal PenaltyEqualValueConstraintTempl< true >::computeQpJacobian ( Moose::ConstraintJacobianType  , unsigned  int  )

protected

Definition at line 68 of file PenaltyEqualValueConstraint.C.

{
  mooseError("ADPenaltyEqualValueConstraint does not implement manual Jacobian calculation.");
}

computeQpJacobian() [3/3]

template<>

Real PenaltyEqualValueConstraintTempl< false >::computeQpJacobian ( Moose::ConstraintJacobianType  jacobian_type, unsigned int  jvar  )

protected

Definition at line 76 of file PenaltyEqualValueConstraint.C.

{
  typedef Moose::ConstraintJacobianType JType;

  switch (jacobian_type)
  {
    case JType::SecondarySecondary:
      if (jvar == _secondary_var.number())
        return (*_phi)[_j][_qp] * _penalty_value * _test_secondary[_i][_qp];
      break;

    case JType::SecondaryPrimary:
      if (jvar == _primary_var.number())
        return -(*_phi)[_j][_qp] * _penalty_value * _test_secondary[_i][_qp];
      break;

    case JType::PrimarySecondary:
      if (jvar == _secondary_var.number())
        return -(*_phi)[_j][_qp] * _penalty_value * _test_primary[_i][_qp];
      break;

    case JType::PrimaryPrimary:
      if (jvar == _primary_var.number())
        return (*_phi)[_j][_qp] * _penalty_value * _test_primary[_i][_qp];
      break;

    default:
      return 0;
  }

  return 0;
}

computeQpResidual()

template<bool is_ad>

GenericReal< is_ad > PenaltyEqualValueConstraintTempl< is_ad >::computeQpResidual ( Moose::MortarType  mortar_type )

finalprotected

Definition at line 41 of file PenaltyEqualValueConstraint.C.

{
  switch (mortar_type)
  {
    case Moose::MortarType::Secondary:
    {
      auto residual =
          -(_u_primary[_qp] - _u_secondary[_qp]) * _penalty_value * _test_secondary[_i][_qp];

      return residual;
    }

    case Moose::MortarType::Primary:
    {
      auto residual =
          (_u_primary[_qp] - _u_secondary[_qp]) * _penalty_value * _test_primary[_i][_qp];

      return residual;
    }

    default:
      return 0;
  }
}

validParams()

template<bool is_ad>

InputParameters PenaltyEqualValueConstraintTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PenaltyEqualValueConstraint.C.

{
  InputParameters params = MortarConstraintTempl<is_ad>::validParams();
  params.addClassDescription(
      "PenaltyEqualValueConstraint enforces solution continuity between secondary and "
      "primary sides of a mortar interface using a penalty approach (no Lagrange multipliers "
      "needed)");
  params.addRequiredRangeCheckedParam<Real>(
      "penalty_value",
      "penalty_value>0",
      "Penalty value used to impose a generalized force capturing the mortar constraint equation");
  return params;
}

Member Data Documentation

_penalty_value

template<bool is_ad>

const Real PenaltyEqualValueConstraintTempl< is_ad >::_penalty_value

protected

Penalty value used to enforce the constraint.

Definition at line 38 of file PenaltyEqualValueConstraint.h.

---

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

• include/constraints/PenaltyEqualValueConstraint.h
• src/constraints/PenaltyEqualValueConstraint.C