DerivativeMaterial child class to evaluate a parsed function for the free energy and automatically provide all derivatives. More...

#include <DerivativeTwoPhaseMaterial.h>

Inheritance diagram for DerivativeTwoPhaseMaterial:

[legend]

Public Member Functions
	DerivativeTwoPhaseMaterial (const InputParameters &parameters)

virtual void	initialSetup () override

Protected Member Functions
virtual Real	computeF () override

virtual Real	computeDF (unsigned int i_var) override

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

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

Protected Attributes
const VariableValue &	_eta
	Phase parameter (0=A-phase, 1=B-phase) More...

VariableName	_eta_name
	name of the order parameter variable More...

unsigned int	_eta_var
	libMesh variable number for eta More...

Real	_W
	Phase transformatuion energy barrier. More...

const MaterialProperty< Real > &	_prop_Fa
	Function value of the A and B phase. More...

const MaterialProperty< Real > &	_prop_Fb

std::vector< const MaterialProperty< Real > * >	_prop_dFa
	Derivatives of Fa and Fb with respect to arg[i]. More...

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

std::vector< std::vector< const MaterialProperty< Real > * > >	_prop_d2Fa
	Second derivatives of Fa and Fb. More...

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

std::vector< std::vector< std::vector< const MaterialProperty< Real > * > > >	_prop_d3Fa
	Third derivatives of Fa and Fb. More...

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


const MaterialProperty< Real > &	_h

const MaterialProperty< Real > &	_dh

const MaterialProperty< Real > &	_d2h

const MaterialProperty< Real > &	_d3h


const MaterialProperty< Real > &	_g

const MaterialProperty< Real > &	_dg

const MaterialProperty< Real > &	_d2g

const MaterialProperty< Real > &	_d3g

Detailed Description

DerivativeMaterial child class to evaluate a parsed function for the free energy and automatically provide all derivatives.

This requires the autodiff patch (https://github.com/libMesh/libmesh/pull/238) to Function Parser in libmesh.

Definition at line 26 of file DerivativeTwoPhaseMaterial.h.

Constructor & Destructor Documentation

◆ DerivativeTwoPhaseMaterial()

DerivativeTwoPhaseMaterial::DerivativeTwoPhaseMaterial ( const InputParameters & parameters )

Definition at line 45 of file DerivativeTwoPhaseMaterial.C.

   : DerivativeFunctionMaterialBase(parameters),
     _eta(coupledValue("eta")),
     _eta_name(getVar("eta", 0)->name()),
     _eta_var(coupled("eta")),
     _h(getMaterialProperty<Real>("h")),
     _dh(getMaterialPropertyDerivative<Real>("h", _eta_name)),
     _d2h(getMaterialPropertyDerivative<Real>("h", _eta_name, _eta_name)),
     _d3h(getMaterialPropertyDerivative<Real>("h", _eta_name, _eta_name, _eta_name)),
     _g(getMaterialProperty<Real>("g")),
     _dg(getMaterialPropertyDerivative<Real>("g", _eta_name)),
     _d2g(getMaterialPropertyDerivative<Real>("g", _eta_name, _eta_name)),
     _d3g(getMaterialPropertyDerivative<Real>("g", _eta_name, _eta_name, _eta_name)),
     _W(getParam<Real>("W")),
     _prop_Fa(getMaterialProperty<Real>("fa_name")),
     _prop_Fb(getMaterialProperty<Real>("fb_name"))
 {
   // reserve space for phase A and B material properties
   _prop_dFa.resize(_nargs);
   _prop_d2Fa.resize(_nargs);
   _prop_d3Fa.resize(_nargs);
   _prop_dFb.resize(_nargs);
   _prop_d2Fb.resize(_nargs);
   _prop_d3Fb.resize(_nargs);
   for (unsigned int i = 0; i < _nargs; ++i)
   {
     _prop_dFa[i] = &getMaterialPropertyDerivative<Real>("fa_name", _arg_names[i]);
     _prop_dFb[i] = &getMaterialPropertyDerivative<Real>("fb_name", _arg_names[i]);
  
     _prop_d2Fa[i].resize(_nargs);
     _prop_d2Fb[i].resize(_nargs);
  
     // TODO: maybe we should reserve and initialize to NULL...
     if (_third_derivatives)
     {
       _prop_d3Fa[i].resize(_nargs);
       _prop_d3Fb[i].resize(_nargs);
     }
  
     for (unsigned int j = 0; j < _nargs; ++j)
     {
       _prop_d2Fa[i][j] =
           &getMaterialPropertyDerivative<Real>("fa_name", _arg_names[i], _arg_names[j]);
       _prop_d2Fb[i][j] =
           &getMaterialPropertyDerivative<Real>("fb_name", _arg_names[i], _arg_names[j]);
  
       if (_third_derivatives)
       {
         _prop_d3Fa[i][j].resize(_nargs);
         _prop_d3Fb[i][j].resize(_nargs);
  
         for (unsigned int k = 0; k < _nargs; ++k)
         {
           _prop_d3Fa[i][j][k] = &getMaterialPropertyDerivative<Real>(
               "fa_name", _arg_names[i], _arg_names[j], _arg_names[k]);
           _prop_d3Fb[i][j][k] = &getMaterialPropertyDerivative<Real>(
               "fb_name", _arg_names[i], _arg_names[j], _arg_names[k]);
         }
       }
     }
   }
 }

Member Function Documentation

◆ computeD2F()

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

overrideprotectedvirtual

Definition at line 134 of file DerivativeTwoPhaseMaterial.C.

 {
   if (i_var == _eta_var && j_var == _eta_var)
     return _d2h[_qp] * (_prop_Fb[_qp] - _prop_Fa[_qp]) + _W * _d2g[_qp];
  
   unsigned int i = argIndex(i_var);
   unsigned int j = argIndex(j_var);
  
   if (i_var == _eta_var)
     return _dh[_qp] * ((*_prop_dFb[j])[_qp] - (*_prop_dFa[j])[_qp]);
   if (j_var == _eta_var)
     return _dh[_qp] * ((*_prop_dFb[i])[_qp] - (*_prop_dFa[i])[_qp]);
  
   return _h[_qp] * (*_prop_d2Fb[i][j])[_qp] + (1.0 - _h[_qp]) * (*_prop_d2Fa[i][j])[_qp];
 }

◆ computeD3F()

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

overrideprotectedvirtual

Definition at line 151 of file DerivativeTwoPhaseMaterial.C.

 {
   if (i_var == _eta_var && j_var == _eta_var && k_var == _eta_var)
     return _d3h[_qp] * (_prop_Fb[_qp] - _prop_Fa[_qp]) + _W * _d3g[_qp];
  
   unsigned int i = argIndex(i_var);
   unsigned int j = argIndex(j_var);
   unsigned int k = argIndex(k_var);
  
   if (j_var == _eta_var && k_var == _eta_var)
     return _d2h[_qp] * ((*_prop_dFb[i])[_qp] - (*_prop_dFa[i])[_qp]);
   if (i_var == _eta_var && k_var == _eta_var)
     return _d2h[_qp] * ((*_prop_dFb[j])[_qp] - (*_prop_dFa[j])[_qp]);
   if (i_var == _eta_var && j_var == _eta_var)
     return _d2h[_qp] * ((*_prop_dFb[k])[_qp] - (*_prop_dFa[k])[_qp]);
  
   if (i_var == _eta_var)
     return _dh[_qp] * (*_prop_d2Fb[j][k])[_qp] + (1.0 - _dh[_qp]) * (*_prop_d2Fa[j][k])[_qp];
   if (j_var == _eta_var)
     return _dh[_qp] * (*_prop_d2Fb[i][k])[_qp] + (1.0 - _dh[_qp]) * (*_prop_d2Fa[i][k])[_qp];
   if (k_var == _eta_var)
     return _dh[_qp] * (*_prop_d2Fb[i][j])[_qp] + (1.0 - _dh[_qp]) * (*_prop_d2Fa[i][j])[_qp];
  
   return _h[_qp] * (*_prop_d3Fb[i][j][k])[_qp] + (1.0 - _h[_qp]) * (*_prop_d3Fa[i][j][k])[_qp];
 }

◆ computeDF()

Real DerivativeTwoPhaseMaterial::computeDF ( unsigned int i_var )

overrideprotectedvirtual

Definition at line 122 of file DerivativeTwoPhaseMaterial.C.

 {
   if (i_var == _eta_var)
     return _dh[_qp] * (_prop_Fb[_qp] - _prop_Fa[_qp]) + _W * _dg[_qp];
   else
   {
     unsigned int i = argIndex(i_var);
     return _h[_qp] * (*_prop_dFb[i])[_qp] + (1.0 - _h[_qp]) * (*_prop_dFa[i])[_qp];
   }
 }

◆ computeF()

Real DerivativeTwoPhaseMaterial::computeF ( )

overrideprotectedvirtual

Definition at line 116 of file DerivativeTwoPhaseMaterial.C.

 {
   return _h[_qp] * _prop_Fb[_qp] + (1.0 - _h[_qp]) * _prop_Fa[_qp] + _W * _g[_qp];
 }

◆ initialSetup()

void DerivativeTwoPhaseMaterial::initialSetup ( )

overridevirtual

Definition at line 109 of file DerivativeTwoPhaseMaterial.C.

 {
   validateCoupling<Real>("fa_name");
   validateCoupling<Real>("fb_name");
 }

Member Data Documentation

◆ _d2g

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_d2g

protected

Definition at line 60 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeD2F().

◆ _d2h

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_d2h

protected

Definition at line 52 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeD2F(), and computeD3F().

◆ _d3g

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_d3g

protected

Definition at line 61 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeD3F().

◆ _d3h

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_d3h

protected

Definition at line 53 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeD3F().

◆ _dg

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_dg

protected

Definition at line 59 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeDF().

◆ _dh

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_dh

protected

Definition at line 51 of file DerivativeTwoPhaseMaterial.h.

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

◆ _eta

const VariableValue& DerivativeTwoPhaseMaterial::_eta

protected

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

Definition at line 40 of file DerivativeTwoPhaseMaterial.h.

◆ _eta_name

VariableName DerivativeTwoPhaseMaterial::_eta_name

protected

name of the order parameter variable

Definition at line 43 of file DerivativeTwoPhaseMaterial.h.

◆ _eta_var

unsigned int DerivativeTwoPhaseMaterial::_eta_var

protected

libMesh variable number for eta

Definition at line 46 of file DerivativeTwoPhaseMaterial.h.

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

◆ _g

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_g

protected

g(eta) switching function

Definition at line 58 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeF().

◆ _h

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_h

protected

h(eta) switching function

Definition at line 50 of file DerivativeTwoPhaseMaterial.h.

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

◆ _prop_d2Fa

std::vector<std::vector<const MaterialProperty<Real> *> > DerivativeTwoPhaseMaterial::_prop_d2Fa

protected

Second derivatives of Fa and Fb.

Definition at line 74 of file DerivativeTwoPhaseMaterial.h.

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

◆ _prop_d2Fb

std::vector<std::vector<const MaterialProperty<Real> *> > DerivativeTwoPhaseMaterial::_prop_d2Fb

protected

Definition at line 74 of file DerivativeTwoPhaseMaterial.h.

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

◆ _prop_d3Fa

std::vector<std::vector<std::vector<const MaterialProperty<Real> *> > > DerivativeTwoPhaseMaterial::_prop_d3Fa

protected

Third derivatives of Fa and Fb.

Definition at line 77 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeD3F(), and DerivativeTwoPhaseMaterial().

◆ _prop_d3Fb

std::vector<std::vector<std::vector<const MaterialProperty<Real> *> > > DerivativeTwoPhaseMaterial::_prop_d3Fb

protected

Definition at line 77 of file DerivativeTwoPhaseMaterial.h.

Referenced by computeD3F(), and DerivativeTwoPhaseMaterial().

◆ _prop_dFa

std::vector<const MaterialProperty<Real> *> DerivativeTwoPhaseMaterial::_prop_dFa

protected

Derivatives of Fa and Fb with respect to arg[i].

Definition at line 71 of file DerivativeTwoPhaseMaterial.h.

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

◆ _prop_dFb

std::vector<const MaterialProperty<Real> *> DerivativeTwoPhaseMaterial::_prop_dFb

protected

Definition at line 71 of file DerivativeTwoPhaseMaterial.h.

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

◆ _prop_Fa

const MaterialProperty<Real>& DerivativeTwoPhaseMaterial::_prop_Fa

protected

Function value of the A and B phase.

Definition at line 68 of file DerivativeTwoPhaseMaterial.h.

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

◆ _prop_Fb

const MaterialProperty<Real> & DerivativeTwoPhaseMaterial::_prop_Fb

protected

Definition at line 68 of file DerivativeTwoPhaseMaterial.h.

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

◆ _W

Real DerivativeTwoPhaseMaterial::_W

protected

Phase transformatuion energy barrier.

Definition at line 65 of file DerivativeTwoPhaseMaterial.h.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DerivativeTwoPhaseMaterial()

Member Function Documentation

◆ computeD2F()

◆ computeD3F()

◆ computeDF()

◆ computeF()

◆ initialSetup()

Member Data Documentation

◆ _d2g

◆ _d2h

◆ _d3g

◆ _d3h

◆ _dg

◆ _dh

◆ _eta

◆ _eta_name

◆ _eta_var

◆ _g

◆ _h

◆ _prop_d2Fa

◆ _prop_d2Fb

◆ _prop_d3Fa

◆ _prop_d3Fb

◆ _prop_dFa

◆ _prop_dFb

◆ _prop_Fa

◆ _prop_Fb

◆ _W