https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PolycrystalMatDiffusionBase< T > Class Template Reference

#include <PolycrystalMatDiffusionBase.h>

Inheritance diagram for PolycrystalMatDiffusionBase< T >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 
typedef std::vector< intJvarMap
 

Public Member Functions

 PolycrystalMatDiffusionBase (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)
 
virtual void computeOffDiagJacobian (unsigned int jvar) override
 
unsigned int mapJvarToCvar (unsigned int jvar)
 
int mapJvarToCvar (unsigned int jvar, const JvarMap &jvar_map)
 
bool mapJvarToCvar (unsigned int jvar, unsigned int &cvar)
 
const JvarMapgetJvarMap ()
 
const JvarMapgetParameterJvarMap (std::string parameter_name)
 
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 computeQpOffDiagJacobian (unsigned int jvar) override
 
virtual void initialSetup () override
 
virtual RealGradient precomputeQpJacobian () override
 
virtual RealGradient precomputeQpCJacobian ()
 
virtual GenericRealVectorValue< is_ad > precomputeQpResidual () override
 

Protected Attributes

const unsigned int _op_num
 Number of grain order parameters for cases where there is dependence on grain OP gradients. More...
 
const MaterialProperty< typename GradientType< T >::type > & _dDdgradc
 diffusion coefficient derivatives w.r.t. variables that have explicit dependence on gradients More...
 
std::vector< const MaterialProperty< typename GradientType< T >::type > * > _dDdgradeta
 
unsigned int _surface_op_var
 For solid-pore systems, mame of the order parameter identifies the solid-pore surface. More...
 
const bool _add_grain_op_gradients
 Variable to allow user to control whether grain OP gradient contributions are added to Jacobian. More...
 
const MaterialProperty< T > & _ddiffusivity_dc
 
std::vector< const MaterialProperty< T > * > _ddiffusivity_darg
 
const bool _is_coupled
 
unsigned int _v_var
 
const GenericMaterialProperty< T, is_ad > & _diffusivity
 
const GenericVariableGradient< is_ad > & _grad_v
 
 usingGenericKernelGradMembers
 
const unsigned int _n_args
 

Detailed Description

template<typename T>
class PolycrystalMatDiffusionBase< T >

Definition at line 36 of file PolycrystalMatDiffusionBase.h.

Constructor & Destructor Documentation

◆ PolycrystalMatDiffusionBase()

template<typename T >
PolycrystalMatDiffusionBase< T >::PolycrystalMatDiffusionBase ( const InputParameters parameters)

Definition at line 78 of file PolycrystalMatDiffusionBase.h.

79  : MatDiffusionBase<T>(parameters),
80  _op_num(this->coupledComponents("grain_op_vars")),
82  this->isParamValid("D_name") ? "D_name" : "diffusivity", "gradc")),
84  _surface_op_var(this->isCoupled("surface_op_var") ? this->coupled("surface_op_var")
86  _add_grain_op_gradients(this->template getParam<bool>("add_grain_op_gradients"))
87 {
89  for (unsigned int j = 0; j < _op_num; ++j)
90  _dDdgradeta[j] =
91  &this->template getMaterialPropertyDerivative<typename GradientType<T>::type>(
92  this->isParamValid("D_name") ? "D_name" : "diffusivity",
93  ("gradgr" + Moose::stringify(j)));
94 }
const unsigned int invalid_uint
unsigned int _surface_op_var
For solid-pore systems, mame of the order parameter identifies the solid-pore surface.
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative(const std::string &base, const std::vector< VariableName > &c)
const MaterialProperty< typename GradientType< T >::type > & _dDdgradc
diffusion coefficient derivatives w.r.t. variables that have explicit dependence on gradients ...
const bool _add_grain_op_gradients
Variable to allow user to control whether grain OP gradient contributions are added to Jacobian...
std::vector< const MaterialProperty< typename GradientType< T >::type > * > _dDdgradeta
std::string stringify(const T &t)
static const std::complex< double > j(0, 1)
Complex number "j" (also known as "i")
const unsigned int _op_num
Number of grain order parameters for cases where there is dependence on grain OP gradients.

Member Function Documentation

◆ computeQpOffDiagJacobian()

template<typename T >
Real PolycrystalMatDiffusionBase< T >::computeQpOffDiagJacobian ( unsigned int  jvar)
overrideprotectedvirtual

Reimplemented from MatDiffusionBase< T >.

Definition at line 98 of file PolycrystalMatDiffusionBase.h.

99 {
101  if (jvar == _surface_op_var)
102  sum += _dDdgradc[this->_qp] * this->_grad_phi[this->_j][this->_qp] * this->_grad_v[this->_qp] *
103  this->_grad_test[this->_i][this->_qp];
104 
106  {
107  for (unsigned int k = 0; k < _op_num; ++k)
108  if (jvar == this->coupled("grain_op_vars", k))
109  sum += (*_dDdgradeta[k])[this->_qp] * this->_grad_phi[this->_j][this->_qp] *
110  this->_grad_v[this->_qp] * this->_grad_test[this->_i][this->_qp];
111  }
112 
113  return sum;
114 }
unsigned int _surface_op_var
For solid-pore systems, mame of the order parameter identifies the solid-pore surface.
const MaterialProperty< typename GradientType< T >::type > & _dDdgradc
diffusion coefficient derivatives w.r.t. variables that have explicit dependence on gradients ...
virtual Real computeQpOffDiagJacobian(unsigned int jvar) override
const bool _add_grain_op_gradients
Variable to allow user to control whether grain OP gradient contributions are added to Jacobian...
std::vector< const MaterialProperty< typename GradientType< T >::type > * > _dDdgradeta
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const unsigned int _op_num
Number of grain order parameters for cases where there is dependence on grain OP gradients.
static const std::string k
Definition: NS.h:130
const GenericVariableGradient< is_ad > & _grad_v

◆ validParams()

template<typename T >
InputParameters PolycrystalMatDiffusionBase< T >::validParams ( )
static

Definition at line 61 of file PolycrystalMatDiffusionBase.h.

Referenced by PolycrystalMatAnisoDiffusion::validParams(), and PolycrystalMatDiffusion::validParams().

62 {
64  params.addCoupledVar(
65  "surface_op_var",
66  "Name of the order parameter for solid-pore surface. For use when diffusivity "
67  "depends on these OP gradients, leave this parameter un-set otherwise. ");
69  "grain_op_vars", "var_name_base", "op_num", "Array of grain order parameter variables");
70  params.addParam<bool>(
71  "add_grain_op_gradients",
72  true,
73  "Whether grain order parameter gradient contributions are added to Jacobian.");
74  return params;
75 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
static InputParameters validParams()
void addCoupledVar(const std::string &name, const std::string &doc_string)
void addCoupledVarWithAutoBuild(const std::string &name, const std::string &base_name, const std::string &num_name, const std::string &doc_string)

Member Data Documentation

◆ _add_grain_op_gradients

template<typename T>
const bool PolycrystalMatDiffusionBase< T >::_add_grain_op_gradients
protected

Variable to allow user to control whether grain OP gradient contributions are added to Jacobian.

Definition at line 56 of file PolycrystalMatDiffusionBase.h.

Referenced by PolycrystalMatDiffusionBase< Real >::PolycrystalMatDiffusionBase().

◆ _dDdgradc

template<typename T>
const MaterialProperty<typename GradientType<T>::type>& PolycrystalMatDiffusionBase< T >::_dDdgradc
protected

diffusion coefficient derivatives w.r.t. variables that have explicit dependence on gradients

Definition at line 49 of file PolycrystalMatDiffusionBase.h.

◆ _dDdgradeta

template<typename T>
std::vector<const MaterialProperty<typename GradientType<T>::type> *> PolycrystalMatDiffusionBase< T >::_dDdgradeta
protected

◆ _op_num

template<typename T>
const unsigned int PolycrystalMatDiffusionBase< T >::_op_num
protected

Number of grain order parameters for cases where there is dependence on grain OP gradients.

Definition at line 46 of file PolycrystalMatDiffusionBase.h.

Referenced by PolycrystalMatDiffusionBase< Real >::PolycrystalMatDiffusionBase().

◆ _surface_op_var

template<typename T>
unsigned int PolycrystalMatDiffusionBase< T >::_surface_op_var
protected

For solid-pore systems, mame of the order parameter identifies the solid-pore surface.

Definition at line 53 of file PolycrystalMatDiffusionBase.h.


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