AntitrappingCurrent Class Reference

This calculates a modified coupled time derivative that multiplies the time derivative of a coupled variable by a function of the variables and interface normal. More...

#include <AntitrappingCurrent.h>

Inheritance diagram for AntitrappingCurrent:

Public Member Functions
	AntitrappingCurrent (const InputParameters &parameters)
virtual void	initialSetup ()

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

Protected Attributes
const VariableGradient &	_grad_v
const MaterialProperty< Real > &	_F
	The function multiplied by the coupled time derivative. More...
const MaterialProperty< Real > &	_dFdu
	function derivative w.r.t. the kernel variable More...
std::vector< const MaterialProperty< Real > * >	_dFdarg
	function derivatives w.r.t. coupled variables More...

Detailed Description

This calculates a modified coupled time derivative that multiplies the time derivative of a coupled variable by a function of the variables and interface normal.

Definition at line 24 of file AntitrappingCurrent.h.

Constructor & Destructor Documentation

AntitrappingCurrent()

AntitrappingCurrent::AntitrappingCurrent

(

const InputParameters &

parameters

)

Definition at line 24 of file AntitrappingCurrent.C.

  : CoupledSusceptibilityTimeDerivative(parameters), _grad_v(coupledGradient("v"))
{
}

Member Function Documentation

computeQpJacobian()

Real AntitrappingCurrent::computeQpJacobian ( )

protectedvirtual

Reimplemented from CoupledSusceptibilityTimeDerivative.

Definition at line 40 of file AntitrappingCurrent.C.

{
  const Real norm_sq = _grad_v[_qp].norm_sq();
  if (norm_sq < libMesh::TOLERANCE)
    return 0.0;
 
  return _dFdu[_qp] * _v_dot[_qp] * _grad_v[_qp] * _grad_test[_i][_qp] * _phi[_j][_qp] /
         std::sqrt(norm_sq);
}

computeQpOffDiagJacobian()

Real AntitrappingCurrent::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from CoupledSusceptibilityTimeDerivative.

Definition at line 51 of file AntitrappingCurrent.C.

{
  const Real norm_sq = _grad_v[_qp].norm_sq();
  if (norm_sq < libMesh::TOLERANCE)
    return 0.0;
 
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  if (jvar == _v_var)
    return (_F[_qp] * _dv_dot[_qp] * _grad_v[_qp] * _grad_test[_i][_qp] * _phi[_j][_qp] +
            _F[_qp] * _v_dot[_qp] * _grad_test[_i][_qp] * _grad_phi[_j][_qp] -
            _F[_qp] * _v_dot[_qp] * _grad_v[_qp] * _grad_test[_i][_qp] * _grad_v[_qp] *
                _grad_phi[_j][_qp] / norm_sq +
            _v_dot[_qp] * _grad_v[_qp] * _grad_test[_i][_qp] * _phi[_j][_qp] *
                (*_dFdarg[cvar])[_qp]) /
           std::sqrt(norm_sq);
 
  return _v_dot[_qp] * _grad_v[_qp] * _grad_test[_i][_qp] * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp] /
         std::sqrt(norm_sq);
}

computeQpResidual()

Real AntitrappingCurrent::computeQpResidual ( )

protectedvirtual

Reimplemented from CoupledSusceptibilityTimeDerivative.

Definition at line 30 of file AntitrappingCurrent.C.

{
  const Real norm_sq = _grad_v[_qp].norm_sq();
  if (norm_sq < libMesh::TOLERANCE)
    return 0.0;
 
  return _F[_qp] * _v_dot[_qp] * _grad_v[_qp] * _grad_test[_i][_qp] / std::sqrt(norm_sq);
}

initialSetup()

void CoupledSusceptibilityTimeDerivative::initialSetup ( )

virtualinherited

Definition at line 40 of file CoupledSusceptibilityTimeDerivative.C.

{
  validateNonlinearCoupling<Real>("f_name");
}

Member Data Documentation

_dFdarg

std::vector<const MaterialProperty<Real> *> CoupledSusceptibilityTimeDerivative::_dFdarg

protectedinherited

function derivatives w.r.t. coupled variables

Definition at line 44 of file CoupledSusceptibilityTimeDerivative.h.

Referenced by computeQpOffDiagJacobian(), CoupledSusceptibilityTimeDerivative::computeQpOffDiagJacobian(), and CoupledSusceptibilityTimeDerivative::CoupledSusceptibilityTimeDerivative().

_dFdu

const MaterialProperty<Real>& CoupledSusceptibilityTimeDerivative::_dFdu

protectedinherited

function derivative w.r.t. the kernel variable

Definition at line 41 of file CoupledSusceptibilityTimeDerivative.h.

Referenced by computeQpJacobian(), and CoupledSusceptibilityTimeDerivative::computeQpJacobian().

_F

const MaterialProperty<Real>& CoupledSusceptibilityTimeDerivative::_F

protectedinherited

The function multiplied by the coupled time derivative.

Definition at line 38 of file CoupledSusceptibilityTimeDerivative.h.

Referenced by computeQpOffDiagJacobian(), CoupledSusceptibilityTimeDerivative::computeQpOffDiagJacobian(), computeQpResidual(), and CoupledSusceptibilityTimeDerivative::computeQpResidual().

_grad_v

const VariableGradient& AntitrappingCurrent::_grad_v

protected

Definition at line 34 of file AntitrappingCurrent.h.

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

---

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

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