https://mooseframework.inl.gov
ADAllenCahn.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
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 "ADAllenCahn.h"
11 
12 registerMooseObject("PhaseFieldApp", ADAllenCahn);
13 
16 {
18  params.addClassDescription("Allen-Cahn Kernel that uses a DerivativeMaterial Free Energy");
19  params.addRequiredParam<MaterialPropertyName>(
20  "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
21  return params;
22 }
23 
25  : ADAllenCahnBase<Real>(parameters),
26  _f_name(getParam<MaterialPropertyName>("f_name")),
27  _dFdEta(getADMaterialProperty<Real>(this->derivativePropertyNameFirst(_f_name, _var.name())))
28 {
29 }
30 
31 ADReal
33 {
34  return _dFdEta[_qp];
35 }
const ADMaterialProperty< Real > & _dFdEta
Definition: ADAllenCahn.h:30
virtual ADReal computeDFDOP()
Compute the derivative of the bulk free energy w.r.t the order parameter.
Definition: ADAllenCahn.C:32
ADAllenCahn(const InputParameters &parameters)
Definition: ADAllenCahn.C:24
DualNumber< Real, DNDerivativeType, true > ADReal
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
Definition: ADAllenCahn.C:15
const std::string name
Definition: Setup.h:20
registerMooseObject("PhaseFieldApp", ADAllenCahn)
This is the Allen-Cahn equation base class that implements the bulk or local energy term of the equat...
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)
ADAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to c...
Definition: ADAllenCahn.h:19