FunctionMaterialBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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

#pragma once

#include "Material.h"
#include "DerivativeMaterialInterface.h"

#define usingFunctionMaterialBaseMembers(T)                                                        \
  usingMaterialMembers;                                                                            \
  using FunctionMaterialBase<T>::_args;                                                            \
  using FunctionMaterialBase<T>::_F_name;                                                          \
  using FunctionMaterialBase<T>::_nargs;                                                           \
  using FunctionMaterialBase<T>::_arg_names;                                                       \
  using FunctionMaterialBase<T>::_arg_numbers;                                                     \
  using FunctionMaterialBase<T>::_arg_param_names;                                                 \
  using FunctionMaterialBase<T>::_arg_param_numbers;                                               \
  using FunctionMaterialBase<T>::_arg_constant_defaults;                                           \
  using FunctionMaterialBase<T>::_prop_F;                                                          \
  using FunctionMaterialBase<T>::_communicator

template <bool is_ad = false>
class FunctionMaterialBase : public DerivativeMaterialInterface<Material>
{
public:
  static InputParameters validParams();

  FunctionMaterialBase(const InputParameters & parameters);

protected:
  unsigned int argIndex(unsigned int i_var) const
  {
    const unsigned int idx = libMeshVarNumberRemap(i_var);
    mooseAssert(idx < _arg_index.size() && _arg_numbers[_arg_index[idx]] == i_var,
                "Requesting argIndex() for a derivative w.r.t. a variable not coupled to.");
    return _arg_index[idx];
  }

  std::vector<const GenericVariableValue<is_ad> *> _args;

  std::string _F_name;

  bool _mapping_is_unique;

  unsigned int _nargs;

  std::vector<std::string> _arg_names;

  std::vector<unsigned int> _arg_numbers;

  std::vector<std::string> _arg_param_names;
  std::vector<int> _arg_param_numbers;

  std::vector<std::string> _arg_constant_defaults;

  GenericMaterialProperty<Real, is_ad> * _prop_F;

private:
  unsigned int libMeshVarNumberRemap(unsigned int var) const
  {
    const int b = static_cast<int>(var);
    return b >= 0 ? b << 1 : (-b << 1) - 1;
  }

  const GenericVariableValue<is_ad> & coupledGenericValue(const std::string & var_name,
                                                          unsigned int comp = 0);

  std::vector<unsigned int> _arg_index;
};