https://mooseframework.inl.gov
DerivativeParsedMaterial.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 
11 
14 
15 template <bool is_ad>
18 {
21  params.addClassDescription("Parsed Function Material with automatic derivatives.");
22  return params;
23 }
24 
25 template <bool is_ad>
27  const InputParameters & parameters)
28  : ParsedMaterialBase(parameters, this),
30  parameters, VariableNameMappingMode::USE_MOOSE_NAMES, _function_param)
31 {
32  // Build function, take derivatives, optimize
36  this->template getParam<std::vector<std::string>>("material_property_names"),
37  this->template getParam<std::vector<PostprocessorName>>("postprocessor_names"),
38  _tol_names,
42 }
43 
44 // explicit instantiation
std::vector< std::string > _constant_expressions
std::vector< std::string > _constant_names
constant vectors
registerMooseObject("MooseApp", DerivativeParsedMaterial)
Helper class for ParsedMaterial and DerivativeParsedMaterial to declare and read the input parameters...
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition: MooseBase.h:384
Class to evaluate a parsed function (for example a free energy) and automatically provide all derivat...
static InputParameters validParams()
const std::string _function
function expression
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Helper class to perform the auto derivative taking.
std::vector< std::string > _tol_names
tolerance vectors
std::vector< std::string > _functor_symbols
DerivativeParsedMaterialTempl(const InputParameters &parameters)
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
std::vector< MooseFunctorName > _functor_names
Functor vectors (names, count, and symbols)
void functionParse(const std::string &function_expression)
This method sets up and parses the function string given by the user.
std::vector< Real > _tol_values