SwitchingFunctionConstraintLagrange Class Reference

SwitchingFunctionConstraintLagrange is a constraint kernel that acts on the lambda lagrange multiplier non-linear variables to enforce \( \sum_n h_i(\eta_i) - \epsilon\lambda \equiv 1 \). More...

#include <SwitchingFunctionConstraintLagrange.h>

Inheritance diagram for SwitchingFunctionConstraintLagrange:

Public Member Functions
	SwitchingFunctionConstraintLagrange (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int)

Protected Attributes
std::vector< MaterialPropertyName >	_h_names
	Switching function names. More...
unsigned int	_num_h
	number of switching functions More...
std::vector< const MaterialProperty< Real > * >	_h
	Switching functions. More...
std::vector< std::vector< const MaterialProperty< Real > * > >	_dh
	Switching function derivatives. More...
const JvarMap &	_eta_map
	map for getting the "etas" index from jvar More...
Real	_epsilon
	shift factor More...

Detailed Description

SwitchingFunctionConstraintLagrange is a constraint kernel that acts on the lambda lagrange multiplier non-linear variables to enforce \( \sum_n h_i(\eta_i) - \epsilon\lambda \equiv 1 \).

Definition at line 28 of file SwitchingFunctionConstraintLagrange.h.

Constructor & Destructor Documentation

SwitchingFunctionConstraintLagrange()

SwitchingFunctionConstraintLagrange::SwitchingFunctionConstraintLagrange

(

const InputParameters &

parameters

)

Definition at line 28 of file SwitchingFunctionConstraintLagrange.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _h_names(getParam<std::vector<MaterialPropertyName>>("h_names")),
    _num_h(_h_names.size()),
    _h(_num_h),
    _dh(_num_h),
    _eta_map(getParameterJvarMap("etas")),
    _epsilon(getParam<Real>("epsilon"))
{
  // parameter check. We need exactly one eta per h
  if (_num_h != coupledComponents("etas"))
    paramError("etas", "Need to pass in as many etas as h_names");
 
  // fetch switching functions (for the residual) and h derivatives (for the Jacobian)
  for (std::size_t i = 0; i < _num_h; ++i)
  {
    _h[i] = &getMaterialPropertyByName<Real>(_h_names[i]);
 
    _dh[i].resize(_num_h);
    for (std::size_t j = 0; j < _num_h; ++j)
      _dh[i][j] = &getMaterialPropertyDerivative<Real>(_h_names[i], getVar("etas", j)->name());
  }
}

Member Function Documentation

computeQpJacobian()

Real SwitchingFunctionConstraintLagrange::computeQpJacobian ( )

protectedvirtual

Definition at line 64 of file SwitchingFunctionConstraintLagrange.C.

{
  return _test[_i][_qp] * -_epsilon * _phi[_j][_qp];
}

computeQpOffDiagJacobian()

Real SwitchingFunctionConstraintLagrange::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 70 of file SwitchingFunctionConstraintLagrange.C.

{
  auto eta = mapJvarToCvar(jvar, _eta_map);
  if (eta >= 0)
  {
    Real g = 0.0;
    for (std::size_t i = 0; i < _num_h; ++i)
      g += (*_dh[i][eta])[_qp] * _phi[_j][_qp];
    return g * _test[_i][_qp];
  }
 
  return 0.0;
}

computeQpResidual()

Real SwitchingFunctionConstraintLagrange::computeQpResidual ( )

protectedvirtual

Definition at line 54 of file SwitchingFunctionConstraintLagrange.C.

{
  Real g = -_epsilon * _u[_qp] - 1.0;
  for (std::size_t i = 0; i < _num_h; ++i)
    g += (*_h[i])[_qp];
 
  return _test[_i][_qp] * g;
}

Member Data Documentation

_dh

std::vector<std::vector<const MaterialProperty<Real> *> > SwitchingFunctionConstraintLagrange::_dh

protected

Switching function derivatives.

Definition at line 49 of file SwitchingFunctionConstraintLagrange.h.

Referenced by computeQpOffDiagJacobian(), and SwitchingFunctionConstraintLagrange().

_epsilon

Real SwitchingFunctionConstraintLagrange::_epsilon

protected

shift factor

Definition at line 55 of file SwitchingFunctionConstraintLagrange.h.

Referenced by computeQpJacobian(), and computeQpResidual().

_eta_map

const JvarMap& SwitchingFunctionConstraintLagrange::_eta_map

protected

map for getting the "etas" index from jvar

Definition at line 52 of file SwitchingFunctionConstraintLagrange.h.

Referenced by computeQpOffDiagJacobian().

_h

std::vector<const MaterialProperty<Real> *> SwitchingFunctionConstraintLagrange::_h

protected

Switching functions.

Definition at line 46 of file SwitchingFunctionConstraintLagrange.h.

Referenced by computeQpResidual(), and SwitchingFunctionConstraintLagrange().

_h_names

std::vector<MaterialPropertyName> SwitchingFunctionConstraintLagrange::_h_names

protected

Switching function names.

Definition at line 40 of file SwitchingFunctionConstraintLagrange.h.

Referenced by SwitchingFunctionConstraintLagrange().

_num_h

unsigned int SwitchingFunctionConstraintLagrange::_num_h

protected

number of switching functions

Definition at line 43 of file SwitchingFunctionConstraintLagrange.h.

Referenced by computeQpOffDiagJacobian(), computeQpResidual(), and SwitchingFunctionConstraintLagrange().

---

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

• phase_field/include/kernels/SwitchingFunctionConstraintLagrange.h
• phase_field/src/kernels/SwitchingFunctionConstraintLagrange.C