CrossTermBarrierFunctionBase is the base to a set of free energy penalties that set the phase interface barriers for arbitrary pairs of phases. More...

#include <CrossTermBarrierFunctionBase.h>

Inheritance diagram for CrossTermBarrierFunctionBase:

[legend]

Public Member Functions
	CrossTermBarrierFunctionBase (const InputParameters &parameters)

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) More...

unsigned int	_g_order
	polynomial order of the switching function \( g(\eta) \) More...

std::vector< Real >	_W_ij
	barrier function height matrix More...

unsigned int	_num_eta
	order parameters More...

std::vector< VariableName >	_eta_names

std::vector< const VariableValue * >	_eta


MaterialProperty< Real > &	_prop_g
	Barrier function and its derivatives. More...

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

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


std::vector< const MaterialProperty< Real > * >	_h
	Switching functions and their derivatives. More...

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

Detailed Description

CrossTermBarrierFunctionBase is the base to a set of free energy penalties that set the phase interface barriers for arbitrary pairs of phases.

Definition at line 25 of file CrossTermBarrierFunctionBase.h.

Constructor & Destructor Documentation

◆ CrossTermBarrierFunctionBase()

CrossTermBarrierFunctionBase::CrossTermBarrierFunctionBase ( const InputParameters & parameters )

Definition at line 28 of file CrossTermBarrierFunctionBase.C.

   : DerivativeMaterialInterface<Material>(parameters),
     _function_name(getParam<std::string>("function_name")),
     _g_order(getParam<MooseEnum>("g_order")),
     _W_ij(getParam<std::vector<Real>>("W_ij")),
     _num_eta(coupledComponents("etas")),
     _eta_names(_num_eta),
     _eta(_num_eta),
     _prop_g(declareProperty<Real>(_function_name)),
     _prop_dg(_num_eta),
     _prop_d2g(_num_eta)
 {
   // if Vector W_ij is not the correct size to fill the matrix give error
   if (_num_eta * _num_eta != _W_ij.size())
     paramError("W_ij",
                "Size of W_ij does not match (number of etas)^2. Supply W_ij of correct size.");
  
   // error out if the W_ij diagonal values are not zero
   for (unsigned int i = 0; i < _num_eta; ++i)
     if (_W_ij[_num_eta * i + i] != 0)
       paramError("W_ij", "Set on-diagonal values of W_ij to zero.");
  
   // declare g derivative properties, fetch eta values
   for (unsigned int i = 0; i < _num_eta; ++i)
   {
     _prop_d2g[i].resize(_num_eta);
     _eta_names[i] = getVar("etas", i)->name();
   }
  
   for (unsigned int i = 0; i < _num_eta; ++i)
   {
     _prop_dg[i] = &declarePropertyDerivative<Real>(_function_name, _eta_names[i]);
     _eta[i] = &coupledValue("etas", i);
     for (unsigned int j = i; j < _num_eta; ++j)
     {
       _prop_d2g[i][j] = _prop_d2g[j][i] =
           &declarePropertyDerivative<Real>(_function_name, _eta_names[i], _eta_names[j]);
     }
   }
 }

Member Function Documentation

◆ computeQpProperties()

void CrossTermBarrierFunctionBase::computeQpProperties ( )

protectedvirtual

Reimplemented in AsymmetricCrossTermBarrierFunctionMaterial, and CrossTermBarrierFunctionMaterial.

Definition at line 70 of file CrossTermBarrierFunctionBase.C.

 {
   // Initialize properties to zero before accumulating
   _prop_g[_qp] = 0.0;
   for (unsigned int i = 0; i < _num_eta; ++i)
   {
     (*_prop_dg[i])[_qp] = 0.0;
     (*_prop_d2g[i][i])[_qp] = 0.0;
   }
 }