MultiBarrierFunctionMaterial.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "MultiBarrierFunctionMaterial.h"

registerMooseObject("PhaseFieldApp", MultiBarrierFunctionMaterial);

InputParameters
MultiBarrierFunctionMaterial::validParams()
{
  InputParameters params = Material::validParams();
  params.addClassDescription("Double well phase transformation barrier free energy contribution.");
  params.addParam<std::string>("function_name", "g", "actual name for g(eta_i)");
  MooseEnum h_order("SIMPLE=0", "SIMPLE");
  params.addParam<MooseEnum>(
      "g_order", h_order, "Polynomial order of the switching function h(eta)");
  params.addParam<bool>("well_only",
                        false,
                        "Make the g zero in [0:1] so it only contributes to "
                        "enforcing the eta range and not to the phase "
                        "transformation barrier.");
  params.addRequiredCoupledVar("etas", "eta_i order parameters, one for each h");
  return params;
}

MultiBarrierFunctionMaterial::MultiBarrierFunctionMaterial(const InputParameters & parameters)
  : DerivativeMaterialInterface<Material>(parameters),
    _function_name(getParam<std::string>("function_name")),
    _g_order(getParam<MooseEnum>("g_order")),
    _well_only(getParam<bool>("well_only")),
    _num_eta(coupledComponents("etas")),
    _eta(coupledValues("etas")),
    _prop_g(declareProperty<Real>(_function_name)),
    _prop_dg(_num_eta),
    _prop_d2g(_num_eta)
{
  // declare derivative properties, fetch eta values
  for (unsigned int i = 0; i < _num_eta; ++i)
  {
    const VariableName & eta_name = coupledName("etas", i);
    if (!isCoupledConstant(eta_name))
    {
      _prop_dg[i] = &declarePropertyDerivative<Real>(_function_name, eta_name);
      _prop_d2g[i] = &declarePropertyDerivative<Real>(_function_name, eta_name, eta_name);
    }
  }
}

void
MultiBarrierFunctionMaterial::computeQpProperties()
{
  Real g = 0.0;

  for (unsigned int i = 0; i < _num_eta; ++i)
  {
    const Real n = (*_eta[i])[_qp];

    if (_well_only && n >= 0.0 && n <= 1.0 && _prop_dg[i])
    {
      (*_prop_dg[i])[_qp] = 0.0;
      (*_prop_d2g[i])[_qp] = 0.0;
      continue;
    }

    switch (_g_order)
    {
      case 0: // SIMPLE
        g += n * n * (1.0 - n) * (1.0 - n);
        if (_prop_dg[i])
        {
          (*_prop_dg[i])[_qp] = 2.0 * n * (n - 1.0) * (2.0 * n - 1.0);
          (*_prop_d2g[i])[_qp] = 12.0 * (n * n - n) + 2.0;
        }
        break;
    }
  }

  _prop_g[_qp] = g;
}