SwitchingFunctionPenalty is a constraint kernel adds a penalty to each order parameter to enforce \( \sum_n h_i(\eta_i) \equiv 1 \). More...

#include <SwitchingFunctionPenalty.h>

Inheritance diagram for SwitchingFunctionPenalty:

[legend]

Public Member Functions
	SwitchingFunctionPenalty (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

std::vector< const MaterialProperty< Real > * >	_h
	Switching functions and their drivatives. More...

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

const MaterialProperty< Real > *	_d2h

const Real	_penalty
	Penalty pre-factor. More...

const unsigned int	_number_of_nl_variables
	number of non-linear variables in the problem More...

std::vector< int >	_j_eta
	eta index for the j_vars in the jacobian computation More...

int	_a
	Index of the eta this kernel is operating on. More...

Detailed Description

SwitchingFunctionPenalty is a constraint kernel adds a penalty to each order parameter to enforce \( \sum_n h_i(\eta_i) \equiv 1 \).

Definition at line 26 of file SwitchingFunctionPenalty.h.

Constructor & Destructor Documentation

◆ SwitchingFunctionPenalty()

SwitchingFunctionPenalty::SwitchingFunctionPenalty ( const InputParameters & parameters )

Definition at line 28 of file SwitchingFunctionPenalty.C.

   : DerivativeMaterialInterface<Kernel>(parameters),
     _h_names(getParam<std::vector<MaterialPropertyName>>("h_names")),
     _num_h(_h_names.size()),
     _h(_num_h),
     _dh(_num_h),
     _penalty(getParam<Real>("penalty")),
     _number_of_nl_variables(_fe_problem.getNonlinearSystemBase().nVariables()),
     _j_eta(_number_of_nl_variables, -1),
     _a(-1)
 {
   // parameter check. We need exactly one eta per h
   if (_num_h != coupledComponents("etas"))
     paramError("h_names", "Need to pass in as many h_names as etas");
  
   // fetch switching functions (for the residual) and h derivatives (for the Jacobian)
   for (unsigned int i = 0; i < _num_h; ++i)
   {
     _h[i] = &getMaterialPropertyByName<Real>(_h_names[i]);
     _dh[i] = &getMaterialPropertyDerivative<Real>(_h_names[i], getVar("etas", i)->name());
  
     // generate the lookup table from j_var -> eta index
     unsigned int num = coupled("etas", i);
     if (num < _number_of_nl_variables)
       _j_eta[num] = i;
  
     // figure out which variable this kernel is acting on
     if (num == _var.number())
       _a = i;
   }
  
   if (_a < 0)
     paramError("etas", "Kernel variable must be listed in etas");
  
   _d2h = &getMaterialPropertyDerivative<Real>(_h_names[_a], _var.name(), _var.name());
 }

Member Function Documentation

◆ computeQpJacobian()

Real SwitchingFunctionPenalty::computeQpJacobian ( )

protectedvirtual

Definition at line 76 of file SwitchingFunctionPenalty.C.

 {
   Real g = -1.0;
   for (unsigned int i = 0; i < _num_h; ++i)
     g += (*_h[i])[_qp];
  
   return _test[_i][_qp] * _penalty * _phi[_j][_qp] * 2.0 *
          ((*_dh[_a])[_qp] * (*_dh[_a])[_qp] + g * (*_d2h)[_qp]);
 }

◆ computeQpOffDiagJacobian()

Real SwitchingFunctionPenalty::computeQpOffDiagJacobian ( unsigned int j_var )

protectedvirtual

Definition at line 87 of file SwitchingFunctionPenalty.C.

 {
   const int eta = _j_eta[j_var];
  
   if (eta >= 0)
     return _test[_i][_qp] * _penalty * _phi[_j][_qp] * 2.0 * (*_dh[eta])[_qp] * (*_dh[_a])[_qp];
   else
     return 0.0;
 }

◆ computeQpResidual()

Real SwitchingFunctionPenalty::computeQpResidual ( )

protectedvirtual

Definition at line 66 of file SwitchingFunctionPenalty.C.

 {
   Real g = -1.0;
   for (unsigned int i = 0; i < _num_h; ++i)
     g += (*_h[i])[_qp];
  
   return _test[_i][_qp] * _penalty * 2.0 * g * (*_dh[_a])[_qp];
 }