#include <MatGradSquareCoupled.h>

Inheritance diagram for MatGradSquareCoupled:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	MatGradSquareCoupled (const InputParameters &parameters)

virtual void	initialSetup ()

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
const VariableGradient &	_grad_elec_potential

const unsigned int	_elec_potential_var

const MaterialProperty< Real > &	_prefactor

const MaterialProperty< Real > &	_dprefactor_dphi

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

FEProblemBase &	_dmi_fe_problem

Detailed Description

Definition at line 24 of file MatGradSquareCoupled.h.

Constructor & Destructor Documentation

◆ MatGradSquareCoupled()

MatGradSquareCoupled::MatGradSquareCoupled ( const InputParameters & parameters )

Definition at line 28 of file MatGradSquareCoupled.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _grad_elec_potential(coupledGradient("elec_potential")),
    _elec_potential_var(coupled("elec_potential")),
    _prefactor(getMaterialProperty<Real>("prefactor")),
    _dprefactor_dphi(getMaterialPropertyDerivative<Real>("prefactor", _var.name())),
    _dprefactor_darg(_n_args)
{
  for (unsigned int i = 0; i < _n_args; ++i)
    _dprefactor_darg[i] = &getMaterialPropertyDerivative<Real>("prefactor", i);
}

Member Function Documentation

◆ computeQpJacobian()

Real MatGradSquareCoupled::computeQpJacobian ( )

protectedvirtual

Definition at line 53 of file MatGradSquareCoupled.C.

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

◆ computeQpOffDiagJacobian()

Real MatGradSquareCoupled::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 60 of file MatGradSquareCoupled.C.

{
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  if (jvar == _elec_potential_var)
    return -2 * _prefactor[_qp] * _grad_elec_potential[_qp] * _grad_phi[_j][_qp] * _test[_i][_qp] -
           (*_dprefactor_darg[cvar])[_qp] * _grad_elec_potential[_qp] * _grad_elec_potential[_qp] *
               _phi[_j][_qp] * _test[_i][_qp];
 
  return -(*_dprefactor_darg[cvar])[_qp] * _grad_elec_potential[_qp] * _grad_elec_potential[_qp] *
         _phi[_j][_qp] * _test[_i][_qp];
}

◆ computeQpResidual()

Real MatGradSquareCoupled::computeQpResidual ( )

protectedvirtual

Definition at line 47 of file MatGradSquareCoupled.C.

{
  return -_prefactor[_qp] * _grad_elec_potential[_qp] * _grad_elec_potential[_qp] * _test[_i][_qp];
}

◆ initialSetup()

void MatGradSquareCoupled::initialSetup ( )

virtual

Definition at line 41 of file MatGradSquareCoupled.C.

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

◆ validParams()

InputParameters MatGradSquareCoupled::validParams ( )

static

Definition at line 15 of file MatGradSquareCoupled.C.

{
  InputParameters params = Kernel::validParams();
  params.addClassDescription("Gradient square of a coupled variable.");
  params.addCoupledVar("elec_potential", "Electric potential");
  params.addCoupledVar("coupled_variables", "Vector of variable arguments to prefactor");
  params.addParam<MaterialPropertyName>(
      "prefactor",
      "prefactor",
      "Material property providing a prefactor of electric potential contribution");
  return params;
}

Member Data Documentation

◆ _dprefactor_darg

std::vector<const MaterialProperty<Real> *> MatGradSquareCoupled::_dprefactor_darg

private

Definition at line 43 of file MatGradSquareCoupled.h.

Referenced by computeQpOffDiagJacobian(), and MatGradSquareCoupled().

◆ _dprefactor_dphi

const MaterialProperty<Real>& MatGradSquareCoupled::_dprefactor_dphi

private

Definition at line 42 of file MatGradSquareCoupled.h.

Referenced by computeQpJacobian().

◆ _elec_potential_var

const unsigned int MatGradSquareCoupled::_elec_potential_var

private

Definition at line 39 of file MatGradSquareCoupled.h.

Referenced by computeQpOffDiagJacobian().

◆ _grad_elec_potential

const VariableGradient& MatGradSquareCoupled::_grad_elec_potential

private

Definition at line 38 of file MatGradSquareCoupled.h.

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

◆ _prefactor

const MaterialProperty<Real>& MatGradSquareCoupled::_prefactor

private

Definition at line 41 of file MatGradSquareCoupled.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

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

phase_field/include/kernels/MatGradSquareCoupled.h
phase_field/src/kernels/MatGradSquareCoupled.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MatGradSquareCoupled()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _dprefactor_darg

◆ _dprefactor_dphi

◆ _elec_potential_var

◆ _grad_elec_potential

◆ _prefactor