www.mooseframework.org
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CHSplitChemicalPotential Class Reference

Solves chemical potential in a weak sense (mu-mu_prop=0) Can be coupled to Cahn-Hilliard equation to solve species diffusion Allows spatial derivative of chemical potential when coupled to material state such as stress, etc. More...

#include <CHSplitChemicalPotential.h>

Inheritance diagram for CHSplitChemicalPotential:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 CHSplitChemicalPotential (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

MaterialPropertyName _mu_prop_name
 Chemical potential property evaluated at material points. More...
 
const MaterialProperty< Real > & _chemical_potential
 
const MaterialProperty< Real > & _dchemical_potential_dc
 
const unsigned int _c_var
 

Detailed Description

Solves chemical potential in a weak sense (mu-mu_prop=0) Can be coupled to Cahn-Hilliard equation to solve species diffusion Allows spatial derivative of chemical potential when coupled to material state such as stress, etc.

Can be used to model species diffusion mediated creep

Definition at line 22 of file CHSplitChemicalPotential.h.

Constructor & Destructor Documentation

◆ CHSplitChemicalPotential()

CHSplitChemicalPotential::CHSplitChemicalPotential ( const InputParameters &  parameters)

Definition at line 26 of file CHSplitChemicalPotential.C.

27  : DerivativeMaterialInterface<Kernel>(parameters),
28  _mu_prop_name(getParam<MaterialPropertyName>("chemical_potential_prop")),
29  _chemical_potential(getMaterialProperty<Real>(_mu_prop_name)),
30  _dchemical_potential_dc(
31  getMaterialPropertyDerivative<Real>(_mu_prop_name, coupledName("c", 0))),
32  _c_var(coupled("c"))
33 {
34 }
CHSplitChemicalPotential::_dchemical_potential_dc
const MaterialProperty< Real > & _dchemical_potential_dc
Definition: CHSplitChemicalPotential.h:38
CHSplitChemicalPotential::_chemical_potential
const MaterialProperty< Real > & _chemical_potential
Definition: CHSplitChemicalPotential.h:37
CHSplitChemicalPotential::_mu_prop_name
MaterialPropertyName _mu_prop_name
Chemical potential property evaluated at material points.
Definition: CHSplitChemicalPotential.h:35

Member Function Documentation

◆ computeQpJacobian()

Real CHSplitChemicalPotential::computeQpJacobian ( )
protectedvirtual

Definition at line 43 of file CHSplitChemicalPotential.C.

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

◆ computeQpOffDiagJacobian()

Real CHSplitChemicalPotential::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Definition at line 49 of file CHSplitChemicalPotential.C.

50 {
51  if (jvar == _c_var)
52  return -_test[_i][_qp] * _dchemical_potential_dc[_qp] * _phi[_j][_qp];
53  else
54  return 0.0;
55 }
CHSplitChemicalPotential::_dchemical_potential_dc
const MaterialProperty< Real > & _dchemical_potential_dc
Definition: CHSplitChemicalPotential.h:38

◆ computeQpResidual()

Real CHSplitChemicalPotential::computeQpResidual ( )
protectedvirtual

Definition at line 37 of file CHSplitChemicalPotential.C.

38 {
39  return _test[_i][_qp] * (_u[_qp] - _chemical_potential[_qp]);
40 }
CHSplitChemicalPotential::_chemical_potential
const MaterialProperty< Real > & _chemical_potential
Definition: CHSplitChemicalPotential.h:37

◆ validParams()

InputParameters CHSplitChemicalPotential::validParams ( )
static

Definition at line 15 of file CHSplitChemicalPotential.C.

16 {
17  InputParameters params = Kernel::validParams();
18  params.addClassDescription("Chemical potential kernel in Split Cahn-Hilliard that solves "
19  "chemical potential in a weak form");
20  params.addRequiredParam<MaterialPropertyName>("chemical_potential_prop",
21  "Chemical potential property name");
22  params.addRequiredCoupledVar("c", "Concentration");
23  return params;
24 }
Kernel::validParams
static InputParameters validParams()
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addRequiredCoupledVar
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _c_var

const unsigned int CHSplitChemicalPotential::_c_var
protected

Definition at line 39 of file CHSplitChemicalPotential.h.

Referenced by computeQpOffDiagJacobian().

◆ _chemical_potential

const MaterialProperty<Real>& CHSplitChemicalPotential::_chemical_potential
protected

Definition at line 37 of file CHSplitChemicalPotential.h.

Referenced by computeQpResidual().

◆ _dchemical_potential_dc

const MaterialProperty<Real>& CHSplitChemicalPotential::_dchemical_potential_dc
protected

Definition at line 38 of file CHSplitChemicalPotential.h.

Referenced by computeQpOffDiagJacobian().

◆ _mu_prop_name

MaterialPropertyName CHSplitChemicalPotential::_mu_prop_name
protected

Chemical potential property evaluated at material points.

Definition at line 35 of file CHSplitChemicalPotential.h.

The documentation for this class was generated from the following files:
Generated on Thu Apr 18 2024 11:28:07 for www.mooseframework.org by   doxygen 1.8.14