SwitchingFunctionConstraintEta Class Reference

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

#include <SwitchingFunctionConstraintEta.h>

Inheritance diagram for SwitchingFunctionConstraintEta:

Public Member Functions
	SwitchingFunctionConstraintEta (const InputParameters &parameters)

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

Protected Attributes
VariableName	_eta_name
	Switching function name. More...
const VariableValue &	_lambda
	Lagrange multiplier. More...
unsigned int	_lambda_var
const MaterialProperty< Real > &	_dh
	Switching function drivatives. More...
const MaterialProperty< Real > &	_d2h
std::vector< const MaterialProperty< Real > * >	_d2ha
const JvarMap &	_d2ha_map

Detailed Description

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

Definition at line 27 of file SwitchingFunctionConstraintEta.h.

Constructor & Destructor Documentation

SwitchingFunctionConstraintEta()

SwitchingFunctionConstraintEta::SwitchingFunctionConstraintEta

(

const InputParameters &

parameters

)

Definition at line 29 of file SwitchingFunctionConstraintEta.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _eta_name(_var.name()),
    _dh(getMaterialPropertyDerivative<Real>("h_name", _eta_name)),
    _d2h(getMaterialPropertyDerivative<Real>("h_name", _eta_name, _eta_name)),
    _d2ha(coupledComponents("args")),
    _d2ha_map(getParameterJvarMap("args")),
    _lambda(coupledValue("lambda")),
    _lambda_var(coupled("lambda"))
{
  for (std::size_t i = 0; i < _d2ha.size(); ++i)
    _d2ha[i] = &getMaterialPropertyDerivative<Real>("h_name", _eta_name, getVar("args", i)->name());
}

Member Function Documentation

computeQpJacobian()

Real SwitchingFunctionConstraintEta::computeQpJacobian ( )

protectedvirtual

Definition at line 50 of file SwitchingFunctionConstraintEta.C.

{
  return _lambda[_qp] * _d2h[_qp] * _phi[_j][_qp] * _test[_i][_qp];
}

computeQpOffDiagJacobian()

Real SwitchingFunctionConstraintEta::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 56 of file SwitchingFunctionConstraintEta.C.

{
  if (jvar == _lambda_var)
    return _phi[_j][_qp] * _dh[_qp] * _test[_i][_qp];
 
  auto k = mapJvarToCvar(jvar, _d2ha_map);
  if (k >= 0)
    return _lambda[_qp] * (*_d2ha[k])[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 
  return 0.0;
}

computeQpResidual()

Real SwitchingFunctionConstraintEta::computeQpResidual ( )

protectedvirtual

Definition at line 44 of file SwitchingFunctionConstraintEta.C.

{
  return _lambda[_qp] * _dh[_qp] * _test[_i][_qp];
}

Member Data Documentation

_d2h

const MaterialProperty<Real>& SwitchingFunctionConstraintEta::_d2h

protected

Definition at line 43 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpJacobian().

_d2ha

std::vector<const MaterialProperty<Real> *> SwitchingFunctionConstraintEta::_d2ha

protected

Definition at line 44 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian(), and SwitchingFunctionConstraintEta().

_d2ha_map

const JvarMap& SwitchingFunctionConstraintEta::_d2ha_map

protected

Definition at line 45 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian().

_dh

const MaterialProperty<Real>& SwitchingFunctionConstraintEta::_dh

protected

Switching function drivatives.

Definition at line 42 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

_eta_name

VariableName SwitchingFunctionConstraintEta::_eta_name

protected

Switching function name.

Definition at line 39 of file SwitchingFunctionConstraintEta.h.

Referenced by SwitchingFunctionConstraintEta().

_lambda

const VariableValue& SwitchingFunctionConstraintEta::_lambda

protected

Lagrange multiplier.

Definition at line 49 of file SwitchingFunctionConstraintEta.h.

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

_lambda_var

unsigned int SwitchingFunctionConstraintEta::_lambda_var

protected

Definition at line 50 of file SwitchingFunctionConstraintEta.h.

Referenced by computeQpOffDiagJacobian().

---

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

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