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

#include <DerivativeMultiPhaseBase.h>

Inheritance diagram for DerivativeMultiPhaseBase:

[legend]

Public Member Functions
	DerivativeMultiPhaseBase (const InputParameters &parameters)

virtual void	initialSetup ()

Protected Member Functions
virtual Real	computeF ()

Protected Attributes
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

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 DerivativeMultiPhaseBase.h.

Constructor & Destructor Documentation

◆ DerivativeMultiPhaseBase()

DerivativeMultiPhaseBase::DerivativeMultiPhaseBase ( const InputParameters & parameters )

Definition at line 39 of file DerivativeMultiPhaseBase.C.

   : DerivativeFunctionMaterialBase(parameters),
     _eta_index(_nargs, -1),
     _num_etas(coupledComponents("etas")),
     _eta_names(_num_etas),
     _eta_vars(_num_etas),
     _fi_names(getParam<std::vector<MaterialPropertyName>>("fi_names")),
     _num_fi(_fi_names.size()),
     _prop_Fi(_num_fi),
     _prop_dFi(_num_fi),
     _prop_d2Fi(_num_fi),
     _prop_d3Fi(_num_fi),
     _hi_names(getParam<std::vector<MaterialPropertyName>>("hi_names")),
     _num_hi(_hi_names.size()),
     _hi(_num_hi),
     _g(getMaterialProperty<Real>("g")),
     _dg(_num_etas),
     _d2g(_num_etas),
     _d3g(_num_etas),
     _W(getParam<Real>("W"))
 {
   // check passed in parameter vectors
   if (_num_fi != _num_hi)
     mooseError("Need to pass in as many hi_names as fi_names in DerivativeMultiPhaseBase ", name());
  
   // get order parameter names and libmesh variable names, set barrier function derivatives
   for (unsigned int i = 0; i < _num_etas; ++i)
   {
     _eta_names[i] = getVar("etas", i)->name();
     _eta_vars[i] = coupled("etas", i);
  
     // for each coupled variable we need to know if it was coupled through "etas"
     // and - if so - which coupled component of "etas" it comes from
     _eta_index[argIndex(_eta_vars[i])] = i;
  
     // barrier function derivatives
     _dg[i] = &getMaterialPropertyDerivative<Real>("g", _eta_names[i]);
     _d2g[i].resize(_num_etas);
     if (_third_derivatives)
       _d3g[i].resize(_num_etas);
  
     for (unsigned int j = 0; j < _num_etas; ++j)
     {
       _d2g[i][j] = &getMaterialPropertyDerivative<Real>("g", _eta_names[i], _eta_names[j]);
  
       if (_third_derivatives)
       {
         _d3g[i][j].resize(_num_etas);
         for (unsigned int k = 0; k < _num_etas; ++k)
           _d3g[i][j][k] = &getMaterialPropertyDerivative<Real>(
               "g", _eta_names[i], _eta_names[j], _eta_names[k]);
       }
     }
   }
  
   // reserve space and set phase material properties
   for (unsigned int n = 0; n < _num_fi; ++n)
   {
     // get phase free energy
     _prop_Fi[n] = &getMaterialPropertyByName<Real>(_fi_names[n]);
     _prop_dFi[n].resize(_nargs);
     _prop_d2Fi[n].resize(_nargs);
     _prop_d3Fi[n].resize(_nargs);
  
     // get switching function
     _hi[n] = &getMaterialPropertyByName<Real>(_hi_names[n]);
  
     for (unsigned int i = 0; i < _nargs; ++i)
     {
       _prop_dFi[n][i] = &getMaterialPropertyDerivative<Real>(_fi_names[n], _arg_names[i]);
       _prop_d2Fi[n][i].resize(_nargs);
  
       if (_third_derivatives)
         _prop_d3Fi[n][i].resize(_nargs);
  
       for (unsigned int j = 0; j < _nargs; ++j)
       {
         _prop_d2Fi[n][i][j] =
             &getMaterialPropertyDerivative<Real>(_fi_names[n], _arg_names[i], _arg_names[j]);
  
         if (_third_derivatives)
         {
           _prop_d3Fi[n][i][j].resize(_nargs);
  
           for (unsigned int k = 0; k < _nargs; ++k)
             _prop_d3Fi[n][i][j][k] = &getMaterialPropertyDerivative<Real>(
                 _fi_names[n], _arg_names[i], _arg_names[j], _arg_names[k]);
         }
       }
     }
   }
 }

Member Function Documentation

◆ computeF()

Real DerivativeMultiPhaseBase::computeF ( )

protectedvirtual

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 ( )

virtual

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

protected

Definition at line 81 of file DerivativeMultiPhaseBase.h.

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

◆ _d3g

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

protected

Definition at line 82 of file DerivativeMultiPhaseBase.h.

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

◆ _dg

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

protected

Barrier function derivatives.

Definition at line 80 of file DerivativeMultiPhaseBase.h.

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

◆ _eta_index

std::vector<int> DerivativeMultiPhaseBase::_eta_index

protected

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 DerivativeMultiPhaseMaterial::computeD2F(), DerivativeMultiPhaseMaterial::computeD3F(), DerivativeMultiPhaseMaterial::computeDF(), and DerivativeMultiPhaseBase().

◆ _eta_names

std::vector<VariableName> DerivativeMultiPhaseBase::_eta_names

protected

Definition at line 47 of file DerivativeMultiPhaseBase.h.

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

◆ _eta_vars

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

protected

Definition at line 48 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase().

◆ _etas

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

protected

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

Definition at line 43 of file DerivativeMultiPhaseBase.h.

◆ _fi_names

std::vector<MaterialPropertyName> DerivativeMultiPhaseBase::_fi_names

protected

phase derivative material names

Definition at line 51 of file DerivativeMultiPhaseBase.h.

Referenced by DerivativeMultiPhaseBase(), and initialSetup().

◆ _g

const MaterialProperty<Real>& DerivativeMultiPhaseBase::_g

protected

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

Definition at line 77 of file DerivativeMultiPhaseBase.h.

Referenced by computeF().

◆ _g_name

MaterialPropertyName DerivativeMultiPhaseBase::_g_name

protected

Barrier function name.

Definition at line 74 of file DerivativeMultiPhaseBase.h.

◆ _hi

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

protected

Switching functions.

Definition at line 71 of file DerivativeMultiPhaseBase.h.

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

◆ _hi_names

std::vector<MaterialPropertyName> DerivativeMultiPhaseBase::_hi_names

protected

phase switching function names

Definition at line 67 of file DerivativeMultiPhaseBase.h.

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

◆ _num_etas

unsigned int DerivativeMultiPhaseBase::_num_etas

protected

name of the order parameter variable

Definition at line 46 of file DerivativeMultiPhaseBase.h.

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

◆ _num_fi

unsigned int DerivativeMultiPhaseBase::_num_fi

protected

Definition at line 52 of file DerivativeMultiPhaseBase.h.

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

◆ _num_hi

unsigned int DerivativeMultiPhaseBase::_num_hi

protected

Definition at line 68 of file DerivativeMultiPhaseBase.h.

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

◆ _prop_d2Fi

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

protected

Second derivatives of Fi.

Definition at line 61 of file DerivativeMultiPhaseBase.h.

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

◆ _prop_d3Fi

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

protected

Third derivatives of Fi.

Definition at line 64 of file DerivativeMultiPhaseBase.h.

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

◆ _prop_dFi

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

protected

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

Definition at line 58 of file DerivativeMultiPhaseBase.h.

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

◆ _prop_Fi

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

protected

Function value of the i phase.

Definition at line 55 of file DerivativeMultiPhaseBase.h.

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

◆ _W

Real DerivativeMultiPhaseBase::_W

protected

Phase transformation energy barrier.

Definition at line 85 of file DerivativeMultiPhaseBase.h.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DerivativeMultiPhaseBase()

Member Function Documentation

◆ computeF()

◆ initialSetup()

Member Data Documentation

◆ _d2g

◆ _d3g

◆ _dg

◆ _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