www.mooseframework.org
ADSplitCHParsed.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 "ADSplitCHParsed.h"
11 
12 registerMooseObject("PhaseFieldApp", ADSplitCHParsed);
13 
16 {
18  params.addClassDescription(
19  "Split formulation Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy");
20  params.addRequiredParam<MaterialPropertyName>(
21  "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
22  params.addCoupledVar("args", "Vector of additional arguments to F");
23  params.deprecateCoupledVar("args", "coupled_variables", "02/27/2024");
24 
25  return params;
26 }
27 
29  : ADSplitCHCRes(parameters),
30  _f_name(getParam<MaterialPropertyName>("f_name")),
31  _dFdc(getADMaterialProperty<Real>(derivativePropertyNameFirst(_f_name, _var.name())))
32 {
33 }
34 
35 ADReal
37 {
38  return _dFdc[_qp];
39 }
ADSplitCHParsed(const InputParameters &parameters)
registerMooseObject("PhaseFieldApp", ADSplitCHParsed)
virtual ADReal computeDFDC()
void addRequiredParam(const std::string &name, const std::string &doc_string)
const std::string name
Definition: Setup.h:20
void deprecateCoupledVar(const std::string &old_name, const std::string &new_name, const std::string &removal_date)
The pair, ADSplitCHCRes and ADSplitCHWRes, splits the Cahn-Hilliard equation by replacing chemical po...
Definition: ADSplitCHCRes.h:18
DualReal ADReal
void addCoupledVar(const std::string &name, const std::string &doc_string)
const ADMaterialProperty< Real > & _dFdc
chemical potential property
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static InputParameters validParams()
Definition: ADSplitCHCRes.C:13
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)
ADSplitCHParsed uses the Free Energy function and derivatives provided by an ADMaterial.
unsigned int _qp