CoupledSusceptibilityTimeDerivative Class Reference

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

#include <CoupledSusceptibilityTimeDerivative.h>

Inheritance diagram for CoupledSusceptibilityTimeDerivative:

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

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

Protected Attributes
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.

Definition at line 25 of file CoupledSusceptibilityTimeDerivative.h.

Constructor & Destructor Documentation

CoupledSusceptibilityTimeDerivative()

CoupledSusceptibilityTimeDerivative::CoupledSusceptibilityTimeDerivative

(

const InputParameters &

parameters

)

Definition at line 27 of file CoupledSusceptibilityTimeDerivative.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<CoupledTimeDerivative>>(parameters),
    _F(getMaterialProperty<Real>("f_name")),
    _dFdu(getMaterialPropertyDerivative<Real>("f_name", _var.name())),
    _dFdarg(_coupled_moose_vars.size())
{
  // fetch derivatives
  for (unsigned int i = 0; i < _dFdarg.size(); ++i)
    _dFdarg[i] = &getMaterialPropertyDerivative<Real>("f_name", _coupled_moose_vars[i]->name());
}

Member Function Documentation

computeQpJacobian()

Real CoupledSusceptibilityTimeDerivative::computeQpJacobian ( )

protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 52 of file CoupledSusceptibilityTimeDerivative.C.

{
  return CoupledTimeDerivative::computeQpResidual() * _dFdu[_qp] * _phi[_j][_qp];
}

computeQpOffDiagJacobian()

Real CoupledSusceptibilityTimeDerivative::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 58 of file CoupledSusceptibilityTimeDerivative.C.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  if (jvar == _v_var)
    return CoupledTimeDerivative::computeQpOffDiagJacobian(jvar) * _F[_qp] +
           CoupledTimeDerivative::computeQpResidual() * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp];
 
  return CoupledTimeDerivative::computeQpResidual() * _phi[_j][_qp] * (*_dFdarg[cvar])[_qp];
}

computeQpResidual()

Real CoupledSusceptibilityTimeDerivative::computeQpResidual ( )

protectedvirtual

Reimplemented in AntitrappingCurrent.

Definition at line 46 of file CoupledSusceptibilityTimeDerivative.C.

{
  return CoupledTimeDerivative::computeQpResidual() * _F[_qp];
}

initialSetup()

void CoupledSusceptibilityTimeDerivative::initialSetup ( )

virtual

Definition at line 40 of file CoupledSusceptibilityTimeDerivative.C.

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

Member Data Documentation

_dFdarg

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

protected

function derivatives w.r.t. coupled variables

Definition at line 44 of file CoupledSusceptibilityTimeDerivative.h.

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

_dFdu

const MaterialProperty<Real>& CoupledSusceptibilityTimeDerivative::_dFdu

protected

function derivative w.r.t. the kernel variable

Definition at line 41 of file CoupledSusceptibilityTimeDerivative.h.

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

_F

const MaterialProperty<Real>& CoupledSusceptibilityTimeDerivative::_F

protected

The function multiplied by the coupled time derivative.

Definition at line 38 of file CoupledSusceptibilityTimeDerivative.h.

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

---

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

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