AsymmetricCrossTermBarrierFunctionMaterial Class Reference

AsymmetricCrossTermBarrierFunctionMaterial adds a free energy contribution on the interfaces between arbitrary pairs of phases in an asymmetric way, allowing to tune the magnitude of the free energy density cotribution on both sides of the interface independently. More...

#include <AsymmetricCrossTermBarrierFunctionMaterial.h>

Inheritance diagram for AsymmetricCrossTermBarrierFunctionMaterial:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

Protected Attributes
std::string	_function_name
	name of the function of eta (used to generate the material property names)
unsigned int	_g_order
	polynomial order of the switching function \( g(\eta) \)
std::vector< Real >	_W_ij
	barrier function height matrix
unsigned int	_num_eta
	order parameters
const std::vector< VariableName >	_eta_names
const std::vector< const VariableValue * >	_eta
std::vector< const MaterialProperty< Real > * >	_h
	Switching functions and their drivatives.
std::vector< const MaterialProperty< Real > * >	_dh
std::vector< const MaterialProperty< Real > * >	_d2h
MaterialProperty< Real > &	_prop_g
	Barrier function and its derivatives.
std::vector< MaterialProperty< Real > * >	_prop_dg
std::vector< std::vector< MaterialProperty< Real > * > >	_prop_d2g

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

AsymmetricCrossTermBarrierFunctionMaterial adds a free energy contribution on the interfaces between arbitrary pairs of phases in an asymmetric way, allowing to tune the magnitude of the free energy density cotribution on both sides of the interface independently.

Definition at line 21 of file AsymmetricCrossTermBarrierFunctionMaterial.h.

Constructor & Destructor Documentation

AsymmetricCrossTermBarrierFunctionMaterial()

AsymmetricCrossTermBarrierFunctionMaterial::AsymmetricCrossTermBarrierFunctionMaterial

(

const InputParameters &

parameters

)

Definition at line 25 of file AsymmetricCrossTermBarrierFunctionMaterial.C.

  : CrossTermBarrierFunctionBase(parameters), _h(_num_eta), _dh(_num_eta), _d2h(_num_eta)
{
  // switching functions
  const std::vector<MaterialPropertyName> & hi_names =
      getParam<std::vector<MaterialPropertyName>>("hi_names");
  if (hi_names.size() != _num_eta)
    paramError("hi_names", "The number of hi_names must be equal to the number of coupled etas");
 
  for (unsigned int i = 0; i < _num_eta; ++i)
  {
    _h[i] = &getMaterialProperty<Real>(hi_names[i]);
    _dh[i] = &getMaterialPropertyDerivative<Real>(hi_names[i], _eta_names[i]);
    _d2h[i] = &getMaterialPropertyDerivative<Real>(hi_names[i], _eta_names[i], _eta_names[i]);
  }
}

Member Function Documentation

computeQpProperties()

void AsymmetricCrossTermBarrierFunctionMaterial::computeQpProperties ( )

protectedvirtual

Reimplemented from CrossTermBarrierFunctionBase.

Definition at line 44 of file AsymmetricCrossTermBarrierFunctionMaterial.C.

{
  // Initialize properties to zero before accumulating
  CrossTermBarrierFunctionBase::computeQpProperties();
 
  // Sum the components of our W_ij matrix to get constant used in our g function
  for (unsigned int i = 0; i < _num_eta; ++i)
    for (unsigned int j = i + 1; j < _num_eta; ++j)
    {
      // readable aliases
      const Real ni = (*_eta[i])[_qp];
      const Real nj = (*_eta[j])[_qp];
 
      const Real Wij = _W_ij[_num_eta * i + j];
      const Real Wji = _W_ij[_num_eta * j + i];
 
      const Real hi = (*_h[i])[_qp];
      const Real hj = (*_h[j])[_qp];
      const Real dhi = (*_dh[i])[_qp];
      const Real dhj = (*_dh[j])[_qp];
      const Real d2hi = (*_d2h[i])[_qp];
      const Real d2hj = (*_d2h[j])[_qp];
 
      // raw barrier term and derivatives
      Real B, dBi, dBj, d2Bii, d2Bjj, d2Bij;
      switch (_g_order)
      {
        case 0: // SIMPLE
          B = 16.0 * ni * ni * nj * nj;
          dBi = 16.0 * 2.0 * ni * nj * nj;
          dBj = 16.0 * 2.0 * ni * ni * nj;
          d2Bii = 16.0 * 2.0 * nj * nj;
          d2Bjj = 16.0 * 2.0 * ni * ni;
          d2Bij = 16.0 * 4.0 * ni * nj;
          break;
 
        case 1: // LOW
          B = 4.0 * ni * nj;
          dBi = 4.0 * nj;
          dBj = 4.0 * ni;
          d2Bii = 0.0;
          d2Bjj = 0.0;
          d2Bij = 4.0;
          break;
 
        default:
          mooseError("Internal error");
      }
 
      _prop_g[_qp] += (Wij * hi + Wji * hj) * B;
      // first derivatives
      (*_prop_dg[i])[_qp] += (Wij * hi + Wji * hj) * dBi + (Wij * dhi) * B;
      (*_prop_dg[j])[_qp] += (Wij * hi + Wji * hj) * dBj + (Wji * dhj) * B;
      // second derivatives (diagonal)
      (*_prop_d2g[i][i])[_qp] +=
          (Wij * hi + Wji * hj) * d2Bii + 2 * (Wij * dhi) * dBi + (Wij * d2hi) * B;
      (*_prop_d2g[j][j])[_qp] +=
          (Wij * hi + Wji * hj) * d2Bjj + 2 * (Wji * dhj) * dBj + (Wji * d2hj) * B;
      // second derivatives (off-diagonal)
      (*_prop_d2g[i][j])[_qp] =
          (Wij * hi + Wji * hj) * (d2Bij) + (Wji * dhj) * dBi + (Wij * dhi) * dBj;
    }
}

validParams()

InputParameters AsymmetricCrossTermBarrierFunctionMaterial::validParams ( )

static

Definition at line 15 of file AsymmetricCrossTermBarrierFunctionMaterial.C.

{
  InputParameters params = CrossTermBarrierFunctionBase::validParams();
  params.addClassDescription(
      "Free energy contribution asymmetric across interfaces between arbitrary pairs of phases.");
  params.addParam<std::vector<MaterialPropertyName>>(
      "hi_names", "Switching Function Materials that provide h(eta_i)");
  return params;
}

Member Data Documentation

_d2h

std::vector<const MaterialProperty<Real> *> AsymmetricCrossTermBarrierFunctionMaterial::_d2h

protected

Definition at line 34 of file AsymmetricCrossTermBarrierFunctionMaterial.h.

Referenced by AsymmetricCrossTermBarrierFunctionMaterial(), and computeQpProperties().

_dh

std::vector<const MaterialProperty<Real> *> AsymmetricCrossTermBarrierFunctionMaterial::_dh

protected

Definition at line 33 of file AsymmetricCrossTermBarrierFunctionMaterial.h.

Referenced by AsymmetricCrossTermBarrierFunctionMaterial(), and computeQpProperties().

_eta

const std::vector<const VariableValue *> CrossTermBarrierFunctionBase::_eta

protectedinherited

Definition at line 43 of file CrossTermBarrierFunctionBase.h.

Referenced by computeQpProperties(), and CrossTermBarrierFunctionMaterial::computeQpProperties().

_eta_names

const std::vector<VariableName> CrossTermBarrierFunctionBase::_eta_names

protectedinherited

Definition at line 42 of file CrossTermBarrierFunctionBase.h.

Referenced by AsymmetricCrossTermBarrierFunctionMaterial(), and CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase().

_function_name

std::string CrossTermBarrierFunctionBase::_function_name

protectedinherited

name of the function of eta (used to generate the material property names)

Definition at line 32 of file CrossTermBarrierFunctionBase.h.

Referenced by CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase().

_g_order

unsigned int CrossTermBarrierFunctionBase::_g_order

protectedinherited

polynomial order of the switching function \( g(\eta) \)

Definition at line 35 of file CrossTermBarrierFunctionBase.h.

Referenced by computeQpProperties(), and CrossTermBarrierFunctionMaterial::computeQpProperties().

_h

std::vector<const MaterialProperty<Real> *> AsymmetricCrossTermBarrierFunctionMaterial::_h

protected

Switching functions and their drivatives.

Definition at line 32 of file AsymmetricCrossTermBarrierFunctionMaterial.h.

Referenced by AsymmetricCrossTermBarrierFunctionMaterial(), and computeQpProperties().

_num_eta

unsigned int CrossTermBarrierFunctionBase::_num_eta

protectedinherited

order parameters

Definition at line 41 of file CrossTermBarrierFunctionBase.h.

Referenced by AsymmetricCrossTermBarrierFunctionMaterial(), computeQpProperties(), CrossTermBarrierFunctionBase::computeQpProperties(), CrossTermBarrierFunctionMaterial::computeQpProperties(), CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase(), and CrossTermBarrierFunctionMaterial::CrossTermBarrierFunctionMaterial().

_prop_d2g

std::vector<std::vector<MaterialProperty<Real> *> > CrossTermBarrierFunctionBase::_prop_d2g

protectedinherited

Definition at line 48 of file CrossTermBarrierFunctionBase.h.

Referenced by computeQpProperties(), CrossTermBarrierFunctionBase::computeQpProperties(), CrossTermBarrierFunctionMaterial::computeQpProperties(), and CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase().

_prop_dg

std::vector<MaterialProperty<Real> *> CrossTermBarrierFunctionBase::_prop_dg

protectedinherited

Definition at line 47 of file CrossTermBarrierFunctionBase.h.

Referenced by computeQpProperties(), CrossTermBarrierFunctionBase::computeQpProperties(), CrossTermBarrierFunctionMaterial::computeQpProperties(), and CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase().

_prop_g

MaterialProperty<Real>& CrossTermBarrierFunctionBase::_prop_g

protectedinherited

Barrier function and its derivatives.

Definition at line 46 of file CrossTermBarrierFunctionBase.h.

Referenced by computeQpProperties(), CrossTermBarrierFunctionBase::computeQpProperties(), and CrossTermBarrierFunctionMaterial::computeQpProperties().

_W_ij

std::vector<Real> CrossTermBarrierFunctionBase::_W_ij

protectedinherited

barrier function height matrix

Definition at line 38 of file CrossTermBarrierFunctionBase.h.

Referenced by computeQpProperties(), CrossTermBarrierFunctionMaterial::computeQpProperties(), CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase(), and CrossTermBarrierFunctionMaterial::CrossTermBarrierFunctionMaterial().

---

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

• phase_field/include/materials/AsymmetricCrossTermBarrierFunctionMaterial.h
• phase_field/src/materials/AsymmetricCrossTermBarrierFunctionMaterial.C