www.mooseframework.org
SplitCHParsed.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "SplitCHParsed.h"
11 
12 registerMooseObject("PhaseFieldApp", SplitCHParsed);
13 
14 template <>
15 InputParameters
17 {
18  InputParameters params = validParams<SplitCHCRes>();
19  params.addClassDescription(
20  "Split formulation Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy");
21  params.addRequiredParam<MaterialPropertyName>(
22  "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
23  params.addCoupledVar("args", "Vector of additional arguments to F");
24  return params;
25 }
26 
27 SplitCHParsed::SplitCHParsed(const InputParameters & parameters)
28  : DerivativeMaterialInterface<JvarMapKernelInterface<SplitCHCRes>>(parameters),
29  _nvar(_coupled_moose_vars.size()),
30  _dFdc(getMaterialPropertyDerivative<Real>("f_name", _var.name())),
31  _d2Fdc2(getMaterialPropertyDerivative<Real>("f_name", _var.name(), _var.name()))
32 {
33  // reserve space for derivatives
34  _d2Fdcdarg.resize(_nvar);
35 
36  // Iterate over all coupled variables
37  for (unsigned int i = 0; i < _nvar; ++i)
38  _d2Fdcdarg[i] =
39  &getMaterialPropertyDerivative<Real>("f_name", _var.name(), _coupled_moose_vars[i]->name());
40 }
41 
42 void
44 {
50  validateNonlinearCoupling<Real>("f_name", _var.name());
51  validateDerivativeMaterialPropertyBase<Real>("f_name");
52 }
53 
54 Real
55 SplitCHParsed::computeDFDC(PFFunctionType type)
56 {
57  switch (type)
58  {
59  case Residual:
60  return _dFdc[_qp];
61 
62  case Jacobian:
63  return _d2Fdc2[_qp] * _phi[_j][_qp];
64  }
65 
66  mooseError("Internal error");
67 }
68 
69 Real
71 {
72  if (jvar == _w_var)
74 
75  // get the coupled variable jvar is referring to
76  const unsigned int cvar = mapJvarToCvar(jvar);
77 
78  return (*_d2Fdcdarg[cvar])[_qp] * _phi[_j][_qp] * _test[_i][_qp];
79 }
registerMooseObject
registerMooseObject("PhaseFieldApp", SplitCHParsed)
SplitCHParsed::_d2Fdcdarg
std::vector< const MaterialProperty< Real > * > _d2Fdcdarg
Definition: SplitCHParsed.h:44
validParams< SplitCHParsed >
InputParameters validParams< SplitCHParsed >()
Definition: SplitCHParsed.C:16
SplitCHParsed
CHParsed uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial.
Definition: SplitCHParsed.h:28
SplitCHParsed::_nvar
const unsigned int _nvar
Definition: SplitCHParsed.h:40
SplitCHParsed::SplitCHParsed
SplitCHParsed(const InputParameters &parameters)
Definition: SplitCHParsed.C:27
SplitCHCRes
The couple, SplitCHCRes and SplitCHWRes, splits the CH equation by replacing chemical potential with ...
Definition: SplitCHCRes.h:21
name
const std::string name
Definition: Setup.h:21
SplitCHParsed::initialSetup
virtual void initialSetup()
Definition: SplitCHParsed.C:43
SplitCHParsed::_d2Fdc2
const MaterialProperty< Real > & _d2Fdc2
Definition: SplitCHParsed.h:42
SplitCHParsed::_dFdc
const MaterialProperty< Real > & _dFdc
Definition: SplitCHParsed.h:41
validParams< SplitCHCRes >
InputParameters validParams< SplitCHCRes >()
Definition: SplitCHCRes.C:14
SplitCHCRes::computeQpOffDiagJacobian
virtual Real computeQpOffDiagJacobian(unsigned int jvar)
Definition: SplitCHCRes.C:71
SplitCHParsed::computeDFDC
virtual Real computeDFDC(PFFunctionType type)
Definition: SplitCHParsed.C:55
SplitCHParsed::computeQpOffDiagJacobian
virtual Real computeQpOffDiagJacobian(unsigned int jvar)
Definition: SplitCHParsed.C:70
SplitCHParsed.h