This Material calculates the force density acting on a particle/grain due to interaction between particles. More...

#include <ForceDensityMaterial.h>

Inheritance diagram for ForceDensityMaterial:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ForceDensityMaterial (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	computeQpProperties ()

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 VariableValue &	_c
	concentration field considered to be the density of particles

VariableName	_c_name

Real	_ceq
	equilibrium density at the grain boundaries

Real	_cgb
	thresold value for identifying grain boundaries

Real	_k
	stiffness constant

const unsigned int	_op_num

const std::vector< const VariableValue * >	_vals

const std::vector< const VariableGradient * >	_grad_vals

const std::vector< VariableName >	_vals_name

std::vector< Real >	_product_etas

std::vector< RealGradient >	_sum_grad_etas

const std::string	_base_name
	type of force density material

MaterialProperty< std::vector< RealGradient > > &	_dF
	force density material

MaterialProperty< std::vector< RealGradient > > &	_dFdc
	first order derivative of force density material w.r.t c

std::vector< MaterialProperty< std::vector< Real > > * >	_dFdgradeta
	first order derivative of force density material w.r.t etas

FEProblemBase &	_dmi_fe_problem

Detailed Description

This Material calculates the force density acting on a particle/grain due to interaction between particles.

Definition at line 21 of file ForceDensityMaterial.h.

Constructor & Destructor Documentation

◆ ForceDensityMaterial()

ForceDensityMaterial::ForceDensityMaterial ( const InputParameters & parameters )

Definition at line 27 of file ForceDensityMaterial.C.

  : DerivativeMaterialInterface<Material>(parameters),
    _c(coupledValue("c")),
    _c_name(coupledName("c", 0)),
    _ceq(getParam<Real>("ceq")),
    _cgb(getParam<Real>("cgb")),
    _k(getParam<Real>("k")),
    _op_num(coupledComponents(
        "etas")), // determine number of grains from the number of names passed in.
    _vals(coupledValues("etas")),
    _grad_vals(coupledGradients("etas")),
    _vals_name(coupledNames("etas")),
    _product_etas(_op_num),
    _sum_grad_etas(_op_num),
    _dF(declareProperty<std::vector<RealGradient>>("force_density")),
    _dFdc(declarePropertyDerivative<std::vector<RealGradient>>("force_density", _c_name)),
    _dFdgradeta(_op_num)
{
  // Loop through grains and load derivatives
  for (unsigned int i = 0; i < _op_num; ++i)
    if (!isCoupledConstant(_vals_name[i]))
      _dFdgradeta[i] =
          &declarePropertyDerivative<std::vector<Real>>("force_density", _vals_name[i]);
}

Member Function Documentation

◆ computeQpProperties()

void ForceDensityMaterial::computeQpProperties ( )

protectedvirtual

Definition at line 53 of file ForceDensityMaterial.C.

{
  _dF[_qp].resize(_op_num);
  _dFdc[_qp].resize(_op_num);
 
  for (unsigned int i = 0; i < _op_num; ++i)
  {
    _sum_grad_etas[i] = 0.0;
    for (unsigned int j = 0; j < _op_num; ++j)
      if (j != i)
      {
        _product_etas[i] = (*_vals[i])[_qp] * (*_vals[j])[_qp] >= _cgb ? 1.0 : 0.0;
        _sum_grad_etas[i] += _product_etas[i] * ((*_grad_vals[i])[_qp] - (*_grad_vals[j])[_qp]);
      }
    _dF[_qp][i] = _k * (_c[_qp] - _ceq) * _sum_grad_etas[i];
    _dFdc[_qp][i] = _k * _sum_grad_etas[i];
  }
 
  for (unsigned int i = 0; i < _op_num; ++i)
  {
    if (_dFdgradeta[i])
      (*_dFdgradeta[i])[_qp].resize(_op_num);
    for (unsigned int j = 0; j < _op_num; ++j)
    {
      for (unsigned int k = 0; k < _op_num; ++k)
        if (k != j)
          _product_etas[j] = (*_vals[j])[_qp] * (*_vals[k])[_qp] >= _cgb ? 1.0 : 0.0;
 
      if (_dFdgradeta[i])
      {
        if (j == i)
          (*_dFdgradeta[i])[_qp][j] = _k * _product_etas[j] * (_c[_qp] - _ceq);
        else
          (*_dFdgradeta[i])[_qp][j] = -_k * _product_etas[j] * (_c[_qp] - _ceq);
      }
    }
  }
}

◆ validParams()

InputParameters ForceDensityMaterial::validParams ( )

static

Definition at line 15 of file ForceDensityMaterial.C.

{
  InputParameters params = Material::validParams();
  params.addClassDescription("Calculating the force density acting on a grain");
  params.addCoupledVar("etas", "Array of coupled order parameters");
  params.addCoupledVar("c", "Concentration field");
  params.addParam<Real>("ceq", 0.9816, "Equilibrium density");
  params.addParam<Real>("cgb", 0.25, "Threshold Concentration for GB");
  params.addParam<Real>("k", 100.0, "stiffness constant");
  return params;
}

Member Data Documentation

◆ _base_name

const std::string ForceDensityMaterial::_base_name

private

type of force density material

Definition at line 51 of file ForceDensityMaterial.h.

◆ _c

const VariableValue& ForceDensityMaterial::_c

private

concentration field considered to be the density of particles

Definition at line 33 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _c_name

VariableName ForceDensityMaterial::_c_name

private

Definition at line 34 of file ForceDensityMaterial.h.

◆ _ceq

Real ForceDensityMaterial::_ceq

private

equilibrium density at the grain boundaries

Definition at line 36 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _cgb

Real ForceDensityMaterial::_cgb

private

thresold value for identifying grain boundaries

Definition at line 38 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _dF

MaterialProperty<std::vector<RealGradient> >& ForceDensityMaterial::_dF

private

force density material

Definition at line 54 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _dFdc

MaterialProperty<std::vector<RealGradient> >& ForceDensityMaterial::_dFdc

private

first order derivative of force density material w.r.t c

Definition at line 56 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _dFdgradeta

std::vector<MaterialProperty<std::vector<Real> > *> ForceDensityMaterial::_dFdgradeta

private

first order derivative of force density material w.r.t etas

Definition at line 58 of file ForceDensityMaterial.h.

Referenced by computeQpProperties(), and ForceDensityMaterial().

◆ _grad_vals

const std::vector<const VariableGradient *> ForceDensityMaterial::_grad_vals

private

Definition at line 44 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _k

Real ForceDensityMaterial::_k

private

stiffness constant

Definition at line 40 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _op_num

const unsigned int ForceDensityMaterial::_op_num

private

Definition at line 42 of file ForceDensityMaterial.h.

Referenced by computeQpProperties(), and ForceDensityMaterial().

◆ _product_etas

std::vector<Real> ForceDensityMaterial::_product_etas

private

Definition at line 47 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _sum_grad_etas

std::vector<RealGradient> ForceDensityMaterial::_sum_grad_etas

private

Definition at line 48 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _vals

const std::vector<const VariableValue *> ForceDensityMaterial::_vals

private

Definition at line 43 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

◆ _vals_name

const std::vector<VariableName> ForceDensityMaterial::_vals_name

private

Definition at line 45 of file ForceDensityMaterial.h.

Referenced by ForceDensityMaterial().

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

phase_field/include/materials/ForceDensityMaterial.h
phase_field/src/materials/ForceDensityMaterial.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ForceDensityMaterial()

Member Function Documentation

◆ computeQpProperties()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _c

◆ _c_name

◆ _ceq

◆ _cgb

◆ _dF

◆ _dFdc

◆ _dFdgradeta

◆ _grad_vals

◆ _k

◆ _op_num

◆ _product_etas

◆ _sum_grad_etas

◆ _vals

◆ _vals_name