CHSplitFlux computes flux as non-linear variable via residual = flux + mobility * gradient(chemical potential) Kernel is associated with a component (direction) that needs to be specified in the input file. More...

#include <CHSplitFlux.h>

Inheritance diagram for CHSplitFlux:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	CHSplitFlux (const InputParameters &parameters)

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)

Protected Attributes
const unsigned int	_component

const unsigned int	_mu_var

const VariableGradient &	_grad_mu

const MaterialProperty< RealTensorValue > &	_mobility

const bool	_has_coupled_c

const unsigned int	_c_var

const MaterialProperty< RealTensorValue > *const	_dmobility_dc

Detailed Description

CHSplitFlux computes flux as non-linear variable via residual = flux + mobility * gradient(chemical potential) Kernel is associated with a component (direction) that needs to be specified in the input file.

Definition at line 21 of file CHSplitFlux.h.

Constructor & Destructor Documentation

◆ CHSplitFlux()

CHSplitFlux::CHSplitFlux ( const InputParameters & parameters )

Definition at line 26 of file CHSplitFlux.C.

   : DerivativeMaterialInterface<Kernel>(parameters),
     _component(getParam<unsigned int>("component")),
     _mu_var(coupled("mu")),
     _grad_mu(coupledGradient("mu")),
     _mobility(getMaterialProperty<RealTensorValue>("mobility_name")),
     _has_coupled_c(isCoupled("c")),
     _c_var(_has_coupled_c ? coupled("c") : 0),
     _dmobility_dc(_has_coupled_c ? &getMaterialPropertyDerivative<RealTensorValue>(
                                        "mobility_name", coupledName("c", 0))
                                  : NULL)
 {
 }

Member Function Documentation

◆ computeQpJacobian()

Real CHSplitFlux::computeQpJacobian ( )

protectedvirtual

Definition at line 47 of file CHSplitFlux.C.

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

◆ computeQpOffDiagJacobian()

Real CHSplitFlux::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 53 of file CHSplitFlux.C.

 {
   if (jvar == _mu_var)
     return _test[_i][_qp] * _mobility[_qp].row(_component) * _grad_phi[_j][_qp];
   else if (_has_coupled_c && jvar == _c_var)
     return _test[_i][_qp] * (*_dmobility_dc)[_qp].row(_component) * _grad_mu[_qp] * _phi[_j][_qp];
   else
     return 0.0;
 }

◆ computeQpResidual()

Real CHSplitFlux::computeQpResidual ( )

protectedvirtual

Definition at line 41 of file CHSplitFlux.C.

 {
   return _test[_i][_qp] * (_u[_qp] + _mobility[_qp].row(_component) * _grad_mu[_qp]);
 }

◆ validParams()

InputParameters CHSplitFlux::validParams ( )

static

Definition at line 15 of file CHSplitFlux.C.

 {
   InputParameters params = Kernel::validParams();
   params.addClassDescription("Computes flux $j$ as nodal variable $j = -M\\nabla\\mu$");
   params.addRequiredParam<unsigned int>("component", "Flux component");
   params.addRequiredParam<MaterialPropertyName>("mobility_name", "Mobility property name");
   params.addRequiredCoupledVar("mu", "Chemical Potential");
   params.addCoupledVar("c", "Concentration");
   return params;
 }

Member Data Documentation

◆ _c_var

const unsigned int CHSplitFlux::_c_var

protected

Definition at line 39 of file CHSplitFlux.h.

Referenced by computeQpOffDiagJacobian().

◆ _component

const unsigned int CHSplitFlux::_component

protected

Definition at line 33 of file CHSplitFlux.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _dmobility_dc

const MaterialProperty<RealTensorValue>* const CHSplitFlux::_dmobility_dc

protected

Definition at line 41 of file CHSplitFlux.h.

◆ _grad_mu

const VariableGradient& CHSplitFlux::_grad_mu

protected

Definition at line 35 of file CHSplitFlux.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _has_coupled_c

const bool CHSplitFlux::_has_coupled_c

protected

Definition at line 38 of file CHSplitFlux.h.

Referenced by computeQpOffDiagJacobian().

◆ _mobility

const MaterialProperty<RealTensorValue>& CHSplitFlux::_mobility

protected

Definition at line 36 of file CHSplitFlux.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _mu_var

const unsigned int CHSplitFlux::_mu_var

protected

Definition at line 34 of file CHSplitFlux.h.

Referenced by computeQpOffDiagJacobian().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CHSplitFlux()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ validParams()

Member Data Documentation

◆ _c_var

◆ _component

◆ _dmobility_dc

◆ _grad_mu

◆ _has_coupled_c

◆ _mobility

◆ _mu_var