ParsedFunctorMaterial.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "ParsedFunctorMaterial.h"

registerMooseObject("MooseApp", ParsedFunctorMaterial);
registerMooseObject("MooseApp", ADParsedFunctorMaterial);

template <bool is_ad>
InputParameters
ParsedFunctorMaterialTempl<is_ad>::validParams()
{
  InputParameters params = FunctorMaterial::validParams();
  params += FunctionParserUtils<is_ad>::validParams();
  params.addClassDescription(
      "Computes a functor material from a parsed expression of other functors.");
  params.addRequiredCustomTypeParam<std::string>(
      "expression", "FunctionExpression", "Expression to parse for the new functor material");
  params.addParam<std::vector<std::string>>(
      "functor_names", {}, "Functors to use in the parsed expression");
  params.addParam<std::vector<std::string>>(
      "functor_symbols",
      {},
      "Symbolic name to use for each functor in 'functor_names' in the parsed expression. If not "
      "provided, then the actual functor names must be used in the parsed expression.");
  params.addRequiredParam<std::string>("property_name",
                                       "Name to give the new functor material property");

  return params;
}

template <bool is_ad>
ParsedFunctorMaterialTempl<is_ad>::ParsedFunctorMaterialTempl(const InputParameters & parameters)
  : FunctorMaterial(parameters),
    FunctionParserUtils<is_ad>(parameters),
    _expression(getParam<std::string>("expression")),
    _functor_names(getParam<std::vector<std::string>>("functor_names")),
    _n_functors(_functor_names.size()),
    _functor_symbols(getParam<std::vector<std::string>>("functor_symbols")),
    _property_name(getParam<std::string>("property_name"))
{
  // Check/modify 'functor_symbols'
  if (_functor_symbols.size() != _n_functors)
  {
    if (_functor_symbols.size() == 0)
      _functor_symbols = _functor_names;
    else
      paramError("functor_symbols",
                 "The number of entries must be equal to either zero or the number of entries in "
                 "'functor_names'.");
  }

  // Get the functors
  _functors.resize(_n_functors);
  for (const auto i : index_range(_functor_names))
    _functors[i] = &getFunctor<GenericReal<is_ad>>(_functor_names[i]);

  // Build the parsed function
  buildParsedFunction();

  // Add the functor material property
  const std::set<ExecFlagType> clearance_schedule(_execute_enum.begin(), _execute_enum.end());
  addFunctorProperty<GenericReal<is_ad>>(
      _property_name,
      [this](const auto & r, const auto & t) -> GenericReal<is_ad>
      {
        // Store the functor values
        for (const auto i : index_range(_functors))
          _func_params[i] = (*_functors[i])(r, t);

        // Store the space and time values
        const auto r_point = r.getPoint();
        for (const auto i : make_range(Moose::dim))
          _func_params[_n_functors + i] = r_point(i);
        _func_params[_n_functors + Moose::dim] = _fe_problem.getTimeFromStateArg(t);

        // Evaluate the parsed function
        return evaluate(_parsed_function, _name);
      },
      clearance_schedule);
}

template <bool is_ad>
void
ParsedFunctorMaterialTempl<is_ad>::buildParsedFunction()
{
  _parsed_function = std::make_shared<SymFunction>();

  // Collect the symbols corresponding to the _func_params values
  std::vector<std::string> symbols(_functor_symbols);
  std::string symbols_str = Moose::stringify(symbols);
  if (Moose::dim == 3)
    symbols_str += symbols_str.empty() ? "x,y,z" : ",x,y,z";
  else
    mooseError("ParsedFunctorMaterial assumes the dimension is always equal to 3.");
  symbols_str += symbols_str.empty() ? "t" : ",t";

  // Create parsed function
  this->parsedFunctionSetup(_parsed_function,
                            _expression,
                            symbols_str,
                            {"pi", "e"},
                            {std::to_string(libMesh::pi), std::to_string(std::exp(Real(1)))},
                            comm());

  // Resize the values vector
  _func_params.resize(_n_functors + Moose::dim + 1);
}

template class ParsedFunctorMaterialTempl<false>;
template class ParsedFunctorMaterialTempl<true>;