StressBasedChemicalPotential computes chemical potential based on stress and a direction tensor Forest et. More...

#include <StressBasedChemicalPotential.h>

Inheritance diagram for StressBasedChemicalPotential:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	StressBasedChemicalPotential (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 void	initQpStatefulProperties ()

virtual void	computeQpProperties ()

Protected Attributes
MaterialProperty< Real > &	_chemical_potential

MaterialProperty< Real > *	_dchemical_potential

const MaterialProperty< RankTwoTensor > &	_stress_old
	The old stress tensor.

const MaterialProperty< RealTensorValue > &	_direction_tensor

const MaterialProperty< Real > &	_prefactor

const MaterialProperty< Real > *	_dprefactor_dc

bool	_has_coupled_c

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
FEProblemBase &	_dmi_fe_problem

Detailed Description

StressBasedChemicalPotential computes chemical potential based on stress and a direction tensor Forest et.

al. MSMSE 2015

Definition at line 21 of file StressBasedChemicalPotential.h.

Constructor & Destructor Documentation

◆ StressBasedChemicalPotential()

StressBasedChemicalPotential::StressBasedChemicalPotential ( const InputParameters & parameters )

Definition at line 29 of file StressBasedChemicalPotential.C.

  : DerivativeMaterialInterface<Material>(parameters),
    _chemical_potential(declareProperty<Real>(getParam<MaterialPropertyName>("property_name"))),
    _stress_old(getMaterialPropertyOld<RankTwoTensor>("stress_name")),
    _direction_tensor(getMaterialProperty<RealTensorValue>("direction_tensor_name")),
    _prefactor(getMaterialProperty<Real>("prefactor_name")),
    _has_coupled_c(isCoupled("c") && !isCoupledConstant("c"))
{
  if (_has_coupled_c)
  {
    _dchemical_potential = &declarePropertyDerivative<Real>(
        getParam<MaterialPropertyName>("property_name"), coupledName("c", 0));
    _dprefactor_dc = &getMaterialPropertyDerivative<Real>("prefactor_name", coupledName("c", 0));
  }
}

Member Function Documentation

◆ computeQpProperties()

void StressBasedChemicalPotential::computeQpProperties ( )

protectedvirtual

Definition at line 55 of file StressBasedChemicalPotential.C.

{
  RankTwoTensor direction_tensor_rank_two = _direction_tensor[_qp];
  _chemical_potential[_qp] =
      -_stress_old[_qp].doubleContraction(direction_tensor_rank_two) * _prefactor[_qp];
 
  if (_has_coupled_c)
    (*_dchemical_potential)[_qp] =
        -_stress_old[_qp].doubleContraction(direction_tensor_rank_two) * (*_dprefactor_dc)[_qp];
}

◆ initQpStatefulProperties()

void StressBasedChemicalPotential::initQpStatefulProperties ( )

protectedvirtual

Definition at line 46 of file StressBasedChemicalPotential.C.

{
  _chemical_potential[_qp] = 0.0;
 
  if (_has_coupled_c)
    (*_dchemical_potential)[_qp] = 0.0;
}

◆ validParams()

InputParameters StressBasedChemicalPotential::validParams ( )

static

Definition at line 15 of file StressBasedChemicalPotential.C.

{
  InputParameters params = Material::validParams();
  params.addClassDescription("Chemical potential from stress");
  params.addRequiredParam<MaterialPropertyName>("property_name",
                                                "Name of stress based chemical potential");
  params.addRequiredParam<MaterialPropertyName>("stress_name", "Name of stress property variable");
  params.addRequiredParam<MaterialPropertyName>("direction_tensor_name",
                                                "Name of direction tensor variable");
  params.addRequiredParam<MaterialPropertyName>("prefactor_name", "Name of prefactor variable");
  params.addCoupledVar("c", "Concentration variable");
  return params;
}