FunctorMaterial.h

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

#pragma once

#include "Material.h"

class FunctorMaterial : public Material
{
public:
  static InputParameters validParams();

  FunctorMaterial(const InputParameters & parameters);
  void computeProperties() override final {}

  const std::set<std::string> & getSuppliedFunctors() const { return _supplied_functor_props; }

protected:
  void computeQpProperties() override final {}

  template <typename T, typename PolymorphicLambda>
  const Moose::FunctorBase<T> &
  addFunctorProperty(const std::string & name,
                     PolymorphicLambda my_lammy,
                     const std::set<ExecFlagType> & clearance_schedule = {EXEC_ALWAYS});

  template <typename T, typename PolymorphicLambda>
  const Moose::FunctorBase<T> &
  addFunctorPropertyByBlocks(const std::string & name,
                             PolymorphicLambda my_lammy,
                             const std::set<SubdomainID> & sub_ids,
                             const std::set<ExecFlagType> & clearance_schedule = {EXEC_ALWAYS});

private:
  std::set<std::string> _supplied_functor_props;
};

template <typename T, typename PolymorphicLambda>
const Moose::FunctorBase<T> &
FunctorMaterial::addFunctorProperty(const std::string & name,
                                    PolymorphicLambda my_lammy,
                                    const std::set<ExecFlagType> & clearance_schedule)
{
  return addFunctorPropertyByBlocks<T>(name, my_lammy, blockIDs(), clearance_schedule);
}

template <typename T, typename PolymorphicLambda>
const Moose::FunctorBase<T> &
FunctorMaterial::addFunctorPropertyByBlocks(const std::string & name,
                                            PolymorphicLambda my_lammy,
                                            const std::set<SubdomainID> & sub_ids,
                                            const std::set<ExecFlagType> & clearance_schedule)
{
  // Check if the supplied parameter is a valid input parameter key
  std::string prop_name = name;
  if (_pars.isParamValid(name))
  {
    if (_pars.have_parameter<MaterialPropertyName>(name))
      prop_name = _pars.get<MaterialPropertyName>(name);
    if (_pars.have_parameter<MooseFunctorName>(name))
      prop_name = _pars.get<MooseFunctorName>(name);
  }

  _supplied_functor_props.insert(name + (_declare_suffix.empty() ? "" : ("_" + _declare_suffix)));
  return _subproblem.addPiecewiseByBlockLambdaFunctor<T>(
      prop_name + (_declare_suffix.empty() ? "" : ("_" + _declare_suffix)),
      my_lammy,
      clearance_schedule,
      _mesh,
      sub_ids,
      _tid);
}