Multi phase free energy material that combines an arbitrary number of phase free energies to a global free energy. More...

#include <DerivativeMultiPhaseMaterial.h>

Inheritance diagram for DerivativeMultiPhaseMaterial:

[legend]

Public Member Functions
	DerivativeMultiPhaseMaterial (const InputParameters &parameters)

virtual void	initialSetup ()

Protected Member Functions
virtual Real	computeDF (unsigned int i_var)

virtual Real	computeD2F (unsigned int i_var, unsigned int j_var)

virtual Real	computeD3F (unsigned int i_var, unsigned int j_var, unsigned int k_var)

virtual Real	computeF ()

Protected Attributes
std::vector< const MaterialProperty< Real > * >	_dhi
	Function value of the i phase. More...

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

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

std::vector< int >	_eta_index
	If the variable a non-conserved OP this array holds the index into the etas parameter vector for a given arg index, otherwise it holds -1. More...

std::vector< VariableValue * >	_etas
	Phase parameter (0=A-phase, 1=B-phase) More...

unsigned int	_num_etas
	name of the order parameter variable More...

std::vector< VariableName >	_eta_names

std::vector< unsigned int >	_eta_vars

std::vector< MaterialPropertyName >	_fi_names
	phase derivative material names More...

unsigned int	_num_fi

std::vector< const MaterialProperty< Real > * >	_prop_Fi
	Function value of the i phase. More...

std::vector< std::vector< const MaterialProperty< Real > * > >	_prop_dFi
	Derivatives of Fi w.r.t. arg[i]. More...

std::vector< std::vector< std::vector< const MaterialProperty< Real > * > > >	_prop_d2Fi
	Second derivatives of Fi. More...

std::vector< std::vector< std::vector< std::vector< const MaterialProperty< Real > * > > > >	_prop_d3Fi
	Third derivatives of Fi. More...

std::vector< MaterialPropertyName >	_hi_names
	phase switching function names More...

unsigned int	_num_hi

std::vector< const MaterialProperty< Real > * >	_hi
	Switching functions. More...

MaterialPropertyName	_g_name
	Barrier function name. More...

const MaterialProperty< Real > &	_g
	Barrier function \( g(\eta_0, \eta_1, \dots, \eta_{n-1}) \). More...

std::vector< const MaterialProperty< Real > * >	_dg
	Barrier function derivatives. More...

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

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

Real	_W
	Phase transformation energy barrier. More...

Detailed Description

Multi phase free energy material that combines an arbitrary number of phase free energies to a global free energy.

All switching functions are assumed to depend only on their respective order parameter.

Definition at line 24 of file DerivativeMultiPhaseMaterial.h.

Constructor & Destructor Documentation

◆ DerivativeMultiPhaseMaterial()

DerivativeMultiPhaseMaterial::DerivativeMultiPhaseMaterial ( const InputParameters & parameters )

Definition at line 26 of file DerivativeMultiPhaseMaterial.C.

   : DerivativeMultiPhaseBase(parameters), _dhi(_num_etas), _d2hi(_num_etas), _d3hi(_num_etas)
 {
   // verify that the user supplied one less eta than the number of phases
   if (_num_hi != _num_etas)
     paramError("hi_names", "The number of hi_names must be equal to the number of coupled etas");
  
   for (unsigned int i = 0; i < _num_etas; ++i)
   {
     _dhi[i] = &getMaterialPropertyDerivative<Real>(_hi_names[i], _eta_names[i]);
     _d2hi[i] = &getMaterialPropertyDerivative<Real>(_hi_names[i], _eta_names[i], _eta_names[i]);
  
     if (_third_derivatives)
       _d3hi[i] = &getMaterialPropertyDerivative<Real>(
           _hi_names[i], _eta_names[i], _eta_names[i], _eta_names[i]);
   }
 }

Member Function Documentation

◆ computeD2F()

Real DerivativeMultiPhaseMaterial::computeD2F	(	unsigned int	i_var,
		unsigned int	j_var
	)

protectedvirtual

Definition at line 62 of file DerivativeMultiPhaseMaterial.C.

 {
   const unsigned int i = argIndex(i_var);
   const int i_eta = _eta_index[i];
   const unsigned int j = argIndex(j_var);
   const int j_eta = _eta_index[j];
  
   // all arguments are eta-variables
  
   if (i_eta >= 0 && j_eta >= 0)
   {
     // if the derivatives are taken w.r.t. a single eta the d2hi term for eta_i appears, otherwise
     // it drops out
     // because we assume that hi _only_ depends on eta_i
     Real d2F = (i_eta == j_eta) ? (*_d2hi[i_eta])[_qp] * (*_prop_Fi[i_eta])[_qp] : 0.0;
  
     return d2F + _W * (*_d2g[i_eta][j_eta])[_qp];
   }
  
   // one argument is an eta-variable
  
   if (i_eta >= 0)
     return (*_dhi[i_eta])[_qp] * (*_prop_dFi[i_eta][j])[_qp];
  
   if (j_eta >= 0)
     return (*_dhi[j_eta])[_qp] * (*_prop_dFi[j_eta][i])[_qp];
  
   // no arguments are eta-variables
  
   Real d2F = 0.0;
   for (unsigned n = 0; n < _num_fi; ++n)
     d2F += (*_hi[n])[_qp] * (*_prop_d2Fi[n][i][j])[_qp];
   return d2F;
 }

◆ computeD3F()

Real DerivativeMultiPhaseMaterial::computeD3F	(	unsigned int	i_var,
		unsigned int	j_var,
		unsigned int	k_var
	)

protectedvirtual

Definition at line 98 of file DerivativeMultiPhaseMaterial.C.

 {
   const unsigned int i = argIndex(i_var);
   const int i_eta = _eta_index[i];
   const unsigned int j = argIndex(j_var);
   const int j_eta = _eta_index[j];
   const unsigned int k = argIndex(k_var);
   const int k_eta = _eta_index[k];
  
   // all arguments are eta-variables
  
   if (i_eta >= 0 && j_eta >= 0 && k_eta >= 0)
   {
     // if the derivatives are taken w.r.t. a single eta the d3hi term for eta_i appears, otherwise
     // it drops out
     // because we assume that hi _only_ depends on eta_i
     Real d3F =
         (i_eta == j_eta && j_eta == k_eta) ? (*_d3hi[i_eta])[_qp] * (*_prop_Fi[i_eta])[_qp] : 0.0;
  
     return d3F + _W * (*_d3g[i_eta][j_eta][k_eta])[_qp];
   }
  
   // two arguments are eta-variables
  
   if (i_eta >= 0 && j_eta >= 0)
     return (i_eta == j_eta) ? (*_d2hi[i_eta])[_qp] * (*_prop_dFi[i_eta][k])[_qp] : 0.0;
  
   if (j_eta >= 0 && k_eta >= 0)
     return (j_eta == k_eta) ? (*_d2hi[j_eta])[_qp] * (*_prop_dFi[j_eta][i])[_qp] : 0.0;
  
   if (k_eta >= 0 && i_eta >= 0)
     return (k_eta == i_eta) ? (*_d2hi[k_eta])[_qp] * (*_prop_dFi[k_eta][j])[_qp] : 0.0;
  
   // one argument is an eta-variable
  
   if (i_eta >= 0)
     return (*_dhi[i_eta])[_qp] * (*_prop_d2Fi[i_eta][j][k])[_qp];
  
   if (j_eta >= 0)
     return (*_dhi[j_eta])[_qp] * (*_prop_d2Fi[j_eta][i][k])[_qp];
  
   if (k_eta >= 0)
     return (*_dhi[k_eta])[_qp] * (*_prop_d2Fi[k_eta][i][j])[_qp];
  
   // no arguments are eta-variables
  
   Real d3F = 0.0;
   for (unsigned n = 0; n < _num_fi; ++n)
     d3F += (*_hi[n])[_qp] * (*_prop_d3Fi[n][i][j][k])[_qp];
   return d3F;
 }

◆ computeDF()

Real DerivativeMultiPhaseMaterial::computeDF ( unsigned int i_var )

protectedvirtual

Definition at line 45 of file DerivativeMultiPhaseMaterial.C.

 {
   const unsigned int i = argIndex(i_var);
   const int i_eta = _eta_index[i];
  
   if (i_eta >= 0)
     return (*_dhi[i_eta])[_qp] * (*_prop_Fi[i_eta])[_qp] + _W * (*_dg[i_eta])[_qp];
   else
   {
     Real dF = 0.0;
     for (unsigned n = 0; n < _num_fi; ++n)
       dF += (*_hi[n])[_qp] * (*_prop_dFi[n][i])[_qp];
     return dF;
   }
 }

◆ computeF()

Real DerivativeMultiPhaseBase::computeF ( )

protectedvirtualinherited

Definition at line 140 of file DerivativeMultiPhaseBase.C.

 {
   Real F = 0.0;
   for (unsigned n = 0; n < _num_fi; ++n)
     F += (*_hi[n])[_qp] * (*_prop_Fi[n])[_qp];
   return F + _W * _g[_qp];
 }

◆ initialSetup()

void DerivativeMultiPhaseBase::initialSetup ( )

virtualinherited

Definition at line 133 of file DerivativeMultiPhaseBase.C.

 {
   for (unsigned int n = 0; n < _num_fi; ++n)
     validateCoupling<Real>(_fi_names[n]);
 }

Member Data Documentation

◆ _d2g

std::vector<std::vector<const MaterialProperty<Real> *> > DerivativeMultiPhaseBase::_d2g

protectedinherited

Definition at line 81 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _d2hi

std::vector<const MaterialProperty<Real> *> DerivativeMultiPhaseMaterial::_d2hi

protected

Definition at line 35 of file DerivativeMultiPhaseMaterial.h.

Referenced by computeD2F(), computeD3F(), and DerivativeMultiPhaseMaterial().

◆ _d3g

std::vector<std::vector<std::vector<const MaterialProperty<Real> *> > > DerivativeMultiPhaseBase::_d3g

protectedinherited

Definition at line 82 of file DerivativeMultiPhaseBase.h.

Referenced by computeD3F(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _d3hi

std::vector<const MaterialProperty<Real> *> DerivativeMultiPhaseMaterial::_d3hi

protected

Definition at line 35 of file DerivativeMultiPhaseMaterial.h.

Referenced by computeD3F(), and DerivativeMultiPhaseMaterial().

◆ _dg

std::vector<const MaterialProperty<Real> *> DerivativeMultiPhaseBase::_dg

protectedinherited

Barrier function derivatives.

Definition at line 80 of file DerivativeMultiPhaseBase.h.

Referenced by computeDF(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _dhi

std::vector<const MaterialProperty<Real> *> DerivativeMultiPhaseMaterial::_dhi

protected

Function value of the i phase.

Definition at line 35 of file DerivativeMultiPhaseMaterial.h.

Referenced by computeD2F(), computeD3F(), computeDF(), and DerivativeMultiPhaseMaterial().

◆ _eta_index

std::vector<int> DerivativeMultiPhaseBase::_eta_index

protectedinherited

If the variable a non-conserved OP this array holds the index into the etas parameter vector for a given arg index, otherwise it holds -1.

Definition at line 40 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), computeDF(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _eta_names

std::vector<VariableName> DerivativeMultiPhaseBase::_eta_names

protectedinherited

Definition at line 47 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::DerivativeMultiPhaseBase(), and DerivativeMultiPhaseMaterial().

◆ _eta_vars

std::vector<unsigned int> DerivativeMultiPhaseBase::_eta_vars

protectedinherited

Definition at line 48 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _etas

std::vector<VariableValue *> DerivativeMultiPhaseBase::_etas

protectedinherited

Phase parameter (0=A-phase, 1=B-phase)

Definition at line 43 of file DerivativeMultiPhaseBase.h.

◆ _fi_names

std::vector<MaterialPropertyName> DerivativeMultiPhaseBase::_fi_names

protectedinherited

phase derivative material names

Definition at line 51 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::DerivativeMultiPhaseBase(), and DerivativeMultiPhaseBase::initialSetup().

◆ _g

const MaterialProperty<Real>& DerivativeMultiPhaseBase::_g

protectedinherited

Barrier function \( g(\eta_0, \eta_1, \dots, \eta_{n-1}) \).

Definition at line 77 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::computeF().

◆ _g_name

MaterialPropertyName DerivativeMultiPhaseBase::_g_name

protectedinherited

Barrier function name.

Definition at line 74 of file DerivativeMultiPhaseBase.h.

◆ _hi

std::vector<const MaterialProperty<Real> *> DerivativeMultiPhaseBase::_hi

protectedinherited

Switching functions.

Definition at line 71 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), computeDF(), DerivativeMultiPhaseBase::computeF(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _hi_names

std::vector<MaterialPropertyName> DerivativeMultiPhaseBase::_hi_names

protectedinherited

phase switching function names

Definition at line 67 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::DerivativeMultiPhaseBase(), and DerivativeMultiPhaseMaterial().

◆ _num_etas

unsigned int DerivativeMultiPhaseBase::_num_etas

protectedinherited

name of the order parameter variable

Definition at line 46 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::DerivativeMultiPhaseBase(), and DerivativeMultiPhaseMaterial().

◆ _num_fi

unsigned int DerivativeMultiPhaseBase::_num_fi

protectedinherited

Definition at line 52 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), computeDF(), DerivativeMultiPhaseBase::computeF(), DerivativeMultiPhaseBase::DerivativeMultiPhaseBase(), and DerivativeMultiPhaseBase::initialSetup().

◆ _num_hi

unsigned int DerivativeMultiPhaseBase::_num_hi

protectedinherited

Definition at line 68 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase::DerivativeMultiPhaseBase(), and DerivativeMultiPhaseMaterial().

◆ _prop_d2Fi

std::vector<std::vector<std::vector<const MaterialProperty<Real> *> > > DerivativeMultiPhaseBase::_prop_d2Fi

protectedinherited

Second derivatives of Fi.

Definition at line 61 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _prop_d3Fi

std::vector<std::vector<std::vector<std::vector<const MaterialProperty<Real> *> > > > DerivativeMultiPhaseBase::_prop_d3Fi

protectedinherited

Third derivatives of Fi.

Definition at line 64 of file DerivativeMultiPhaseBase.h.

Referenced by computeD3F(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _prop_dFi

std::vector<std::vector<const MaterialProperty<Real> *> > DerivativeMultiPhaseBase::_prop_dFi

protectedinherited

Derivatives of Fi w.r.t. arg[i].

Definition at line 58 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), computeDF(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _prop_Fi

std::vector<const MaterialProperty<Real> *> DerivativeMultiPhaseBase::_prop_Fi

protectedinherited

Function value of the i phase.

Definition at line 55 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), computeDF(), DerivativeMultiPhaseBase::computeF(), and DerivativeMultiPhaseBase::DerivativeMultiPhaseBase().

◆ _W

Real DerivativeMultiPhaseBase::_W

protectedinherited

Phase transformation energy barrier.

Definition at line 85 of file DerivativeMultiPhaseBase.h.

Referenced by computeD2F(), computeD3F(), computeDF(), and DerivativeMultiPhaseBase::computeF().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DerivativeMultiPhaseMaterial()

Member Function Documentation

◆ computeD2F()

◆ computeD3F()

◆ computeDF()

◆ computeF()

◆ initialSetup()

Member Data Documentation

◆ _d2g

◆ _d2hi

◆ _d3g

◆ _d3hi

◆ _dg

◆ _dhi

◆ _eta_index

◆ _eta_names

◆ _eta_vars

◆ _etas

◆ _fi_names

◆ _g

◆ _g_name

◆ _hi

◆ _hi_names

◆ _num_etas

◆ _num_fi

◆ _num_hi

◆ _prop_d2Fi

◆ _prop_d3Fi

◆ _prop_dFi

◆ _prop_Fi

◆ _W