GenericFunctionMaterial.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 "GenericFunctionMaterial.h"
#include "Function.h"
 
registerMooseObject("MooseApp", GenericFunctionMaterial);
registerMooseObject("MooseApp", ADGenericFunctionMaterial);
 
template <bool is_ad>
InputParameters
GenericFunctionMaterialTempl<is_ad>::validParams()
{
  InputParameters params = Material::validParams();
  params.addClassDescription("Material object for declaring properties that are populated by "
                             "evaluation of Function object.");
  params.addParam<std::vector<std::string>>("prop_names",
                                            "The names of the properties this material will have");
  params.addParam<std::vector<FunctionName>>("prop_values",
                                             "The corresponding names of the "
                                             "functions that are going to provide "
                                             "the values for the variables");
  return params;
}
 
template <bool is_ad>
GenericFunctionMaterialTempl<is_ad>::GenericFunctionMaterialTempl(
    const InputParameters & parameters)
  : Material(parameters),
    _prop_names(getParam<std::vector<std::string>>("prop_names")),
    _prop_values(getParam<std::vector<FunctionName>>("prop_values"))
{
  unsigned int num_names = _prop_names.size();
  unsigned int num_values = _prop_values.size();
 
  if (num_names != num_values)
    mooseError(
        "Number of prop_names must match the number of prop_values for a GenericFunctionMaterial!");
 
  _num_props = num_names;
 
  _properties.resize(num_names);
  _functions.resize(num_names);
 
  for (unsigned int i = 0; i < _num_props; i++)
  {
    _properties[i] = &declareGenericProperty<Real, is_ad>(_prop_names[i]);
    _functions[i] = &getFunctionByName(_prop_values[i]);
  }
}
 
template <bool is_ad>
void
GenericFunctionMaterialTempl<is_ad>::initQpStatefulProperties()
{
  computeQpFunctions();
}
 
template <bool is_ad>
void
GenericFunctionMaterialTempl<is_ad>::computeQpProperties()
{
  computeQpFunctions();
}
 
template <bool is_ad>
void
GenericFunctionMaterialTempl<is_ad>::computeQpFunctions()
{
  for (unsigned int i = 0; i < _num_props; i++)
    (*_properties[i])[_qp] = (*_functions[i]).value(_t, _q_point[_qp]);
}
 
template class GenericFunctionMaterialTempl<false>;
template class GenericFunctionMaterialTempl<true>;