www.mooseframework.org
ADAllenCahn.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 "ADAllenCahn.h"
11 
12 registerADMooseObject("PhaseFieldApp", ADAllenCahn);
13 
17  params.addClassDescription("Allen-Cahn Kernel that uses a DerivativeMaterial Free Energy");
18  params.addRequiredParam<MaterialPropertyName>(
19  "f_name",
20  "Base name of the free energy function F defined in a DerivativeParsedMaterial"););
21 
22 template <ComputeStage compute_stage>
23 ADAllenCahn<compute_stage>::ADAllenCahn(const InputParameters & parameters)
24  : ADAllenCahnBase<compute_stage, Real>(parameters),
25  _f_name(getParam<MaterialPropertyName>("f_name")),
26  _dFdEta(getADMaterialProperty<Real>(this->derivativePropertyNameFirst(_f_name, _var.name())))
27 {
28 }
29 
30 template <ComputeStage compute_stage>
31 ADReal
33 {
34  return _dFdEta[_qp];
35 }
ADAllenCahn.h
ADAllenCahn::computeDFDOP
virtual ADReal computeDFDOP()
Compute the derivative of the bulk free energy w.r.t the order parameter.
Definition: ADAllenCahn.C:32
ADAllenCahn::ADAllenCahn
ADAllenCahn(const InputParameters &parameters)
Definition: ADAllenCahn.C:23
registerADMooseObject
registerADMooseObject("PhaseFieldApp", ADAllenCahn)
ADAllenCahnBase
This is the Allen-Cahn equation base class that implements the bulk or local energy term of the equat...
Definition: ADAllenCahnBase.h:22
ADAllenCahn
ADAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to c...
Definition: ADAllenCahn.h:16
name
const std::string name
Definition: Setup.h:21
defineADValidParams
defineADValidParams(ADAllenCahn, ADAllenCahnBase, params.addClassDescription("Allen-Cahn Kernel that uses a DerivativeMaterial Free Energy");params.addRequiredParam< MaterialPropertyName >("f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");)