ForceDensityMaterial Class Reference

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 Member Functions
	ForceDensityMaterial (const InputParameters &parameters)

Protected Member Functions
virtual void	computeQpProperties ()

Private Attributes
const VariableValue &	_c
	concentration field considered to be the density of particles More...
VariableName	_c_name
Real	_ceq
	equilibrium density at the grain boundaries More...
Real	_cgb
	thresold value for identifying grain boundaries More...
Real	_k
	stiffness constant More...
unsigned int	_op_num
std::vector< const VariableValue * >	_vals
std::vector< const VariableGradient * >	_grad_vals
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 More...
MaterialProperty< std::vector< RealGradient > > &	_dF
	force density material More...
MaterialProperty< std::vector< RealGradient > > &	_dFdc
	first order derivative of force density material w.r.t c More...
std::vector< MaterialProperty< std::vector< Real > > * >	_dFdgradeta
	first order derivative of force density material w.r.t etas More...

Detailed Description

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

Definition at line 25 of file ForceDensityMaterial.h.

Constructor & Destructor Documentation

ForceDensityMaterial()

ForceDensityMaterial::ForceDensityMaterial

(

const InputParameters &

parameters

)

Definition at line 28 of file ForceDensityMaterial.C.

  : DerivativeMaterialInterface<Material>(parameters),
    _c(coupledValue("c")),
    _c_name(getVar("c", 0)->name()),
    _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(_op_num), // Size variable arrays
    _grad_vals(_op_num),
    _vals_name(_op_num),
    _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 coupled variables into the arrays
  for (unsigned int i = 0; i < _op_num; ++i)
  {
    _vals[i] = &coupledValue("etas", i);
    _grad_vals[i] = &coupledGradient("etas", i);
    _vals_name[i] = getVar("etas", i)->name();
    _dFdgradeta[i] = &declarePropertyDerivative<std::vector<Real>>("force_density", _vals_name[i]);
  }
}

Member Function Documentation

computeQpProperties()

void ForceDensityMaterial::computeQpProperties ( )

protectedvirtual

Definition at line 57 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)
  {
    (*_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 (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);
    }
  }
}

Member Data Documentation

_base_name

const std::string ForceDensityMaterial::_base_name

private

type of force density material

Definition at line 53 of file ForceDensityMaterial.h.

_c

const VariableValue& ForceDensityMaterial::_c

private

concentration field considered to be the density of particles

Definition at line 35 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

_c_name

VariableName ForceDensityMaterial::_c_name

private

Definition at line 36 of file ForceDensityMaterial.h.

_ceq

Real ForceDensityMaterial::_ceq

private

equilibrium density at the grain boundaries

Definition at line 38 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

_cgb

Real ForceDensityMaterial::_cgb

private

thresold value for identifying grain boundaries

Definition at line 40 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

_dF

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

private

force density material

Definition at line 56 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 58 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 60 of file ForceDensityMaterial.h.

Referenced by computeQpProperties(), and ForceDensityMaterial().

_grad_vals

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

private

Definition at line 46 of file ForceDensityMaterial.h.

Referenced by computeQpProperties(), and ForceDensityMaterial().

_k

Real ForceDensityMaterial::_k

private

stiffness constant

Definition at line 42 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

_op_num

unsigned int ForceDensityMaterial::_op_num

private

Definition at line 44 of file ForceDensityMaterial.h.

Referenced by computeQpProperties(), and ForceDensityMaterial().

_product_etas

std::vector<Real> ForceDensityMaterial::_product_etas

private

Definition at line 49 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

_sum_grad_etas

std::vector<RealGradient> ForceDensityMaterial::_sum_grad_etas

private

Definition at line 50 of file ForceDensityMaterial.h.

Referenced by computeQpProperties().

_vals

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

private

Definition at line 45 of file ForceDensityMaterial.h.

Referenced by computeQpProperties(), and ForceDensityMaterial().

_vals_name

std::vector<VariableName> ForceDensityMaterial::_vals_name

private

Definition at line 47 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