FunctorInterface Class Reference

An interface for accessing Moose::Functors. More...

#include <FunctorInterface.h>

Inheritance diagram for FunctorInterface:

Public Member Functions
	FunctorInterface (const MooseObject *moose_object)

Static Public Member Functions
static InputParameters	validParams ()
static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)
	Helper to look up a functor name through the input parameter keys. More...

Protected Member Functions
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name)
	Retrieves a functor from the subproblem. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)
	Retrieves a functor from the subproblem. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)
	Retrieves a functor from the passed-in subproblem. More...
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem. More...
bool	isFunctor (const std::string &name) const
	Checks the subproblem for the given functor. More...
bool	isFunctor (const std::string &name, const SubProblem &subproblem) const
	Checks the passed-in subproblem for the given functor. More...
std::string	deduceFunctorName (const std::string &name) const
	Small helper to look up a functor name through the input parameter keys. More...
Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
	Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections. More...
template<typename T >
void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
	Throws error if the functor does not support the requested side integration. More...

Private Member Functions
template<typename T >
const Moose::Functor< T > &	getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem. More...
virtual bool	isADObject () const =0
	Whether this interface is for an AD object. More...
template<typename T >
const Moose::Functor< T > *	defaultFunctor (const std::string &name)
	Helper function to parse default functor values. More...
template<>
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
template<>
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)

Private Attributes
const InputParameters &	_fi_params
	Parameters of the object with this interface. More...
const std::string	_fi_name
	The name of the object that this interface belongs to. More...
SubProblem *const	_fi_subproblem
	Pointer to subproblem if the subproblem pointer parameter was set. More...
const THREAD_ID	_fi_tid
	Current threaded it. More...
std::vector< std::unique_ptr< Moose::Functor< Real > > >	_default_real_functors
	Storage vector for Moose::Functor<Real> default objects. More...
std::vector< std::unique_ptr< Moose::Functor< ADReal > > >	_default_ad_real_functors
	Storage vector for Moose::Functor<ADReal> default objects. More...

Detailed Description

An interface for accessing Moose::Functors.

Definition at line 28 of file FunctorInterface.h.

Constructor & Destructor Documentation

FunctorInterface()

FunctorInterface::FunctorInterface

(

const MooseObject *

moose_object

)

Definition at line 19 of file FunctorInterface.C.

  : _fi_params(moose_object->parameters()),
    _fi_name(_fi_params.get<std::string>("_object_name")),
    _fi_subproblem(_fi_params.get<SubProblem *>("_subproblem")),
    _fi_tid(_fi_params.get<THREAD_ID>("_tid"))
{
}

Member Function Documentation

checkFunctorSupportsSideIntegration()

template<typename T >

void FunctorInterface::checkFunctorSupportsSideIntegration ( const std::string &  name, bool  qp_integration  )

protected

Throws error if the functor does not support the requested side integration.

Parameters

[in]	name	Name of functor or functor parameter
[in]	qp_integration	True if performing qp integration, false if face info

Definition at line 236 of file FunctorInterface.h.

{
  const std::string functor_name = deduceFunctorName(name);
  const auto & functor = getFunctor<T>(name);
  if (qp_integration)
  {
    if (!functor.supportsElemSideQpArg())
      mooseError("Quadrature point integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
  else
  {
    if (!functor.supportsFaceArg())
      mooseError("Face info integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
}

deduceFunctorName() [1/2]

std::string FunctorInterface::deduceFunctorName ( const std::string &  name, const InputParameters &  params  )

static

Helper to look up a functor name through the input parameter keys.

Parameters

name	The input parameter name that we are trying to deduce the functor name for
params	The input parameters object that we will be checking for parameters named name

Returns

The functor name

Definition at line 28 of file FunctorInterface.C.

Referenced by checkFunctorSupportsSideIntegration(), deduceFunctorName(), getFunctor(), and isFunctor().

{
  if (params.isParamValid(name))
  {
    if (params.have_parameter<MooseFunctorName>(name))
      return params.get<MooseFunctorName>(name);
    // variables, functor material properties, functions, and post-processors are also functors
    else if (params.have_parameter<MaterialPropertyName>(name))
      return params.get<MaterialPropertyName>(name);
    else if (params.have_parameter<VariableName>(name))
      return params.get<VariableName>(name);
    else if (params.have_parameter<std::vector<VariableName>>(name))
    {
      const auto & var_names = params.get<std::vector<VariableName>>(name);
      if (var_names.size() != 1)
        mooseError("We only support a single variable name for retrieving a functor");
      return var_names[0];
    }
    else if (params.have_parameter<NonlinearVariableName>(name))
      return params.get<NonlinearVariableName>(name);
    else if (params.have_parameter<FunctionName>(name))
      return params.get<FunctionName>(name);
    else if (params.have_parameter<PostprocessorName>(name))
      return params.get<PostprocessorName>(name);
    else
      mooseError("Invalid parameter type for retrieving a functor");
  }
  else
    return name;
}

deduceFunctorName() [2/2]

std::string FunctorInterface::deduceFunctorName ( const std::string &  name ) const

protected

Small helper to look up a functor name through the input parameter keys.

Definition at line 60 of file FunctorInterface.C.

{
  return deduceFunctorName(name, _fi_params);
}

defaultFunctor() [1/3]

template<typename T >

const Moose::Functor< T > * FunctorInterface::defaultFunctor ( const std::string &  name )

private

Helper function to parse default functor values.

This is implemented as a specialization for supported types and returns NULL in all other cases.

Definition at line 229 of file FunctorInterface.h.

{
  return nullptr;
}

defaultFunctor() [2/3]

const Moose::Functor< Real > * FunctorInterface::defaultFunctor ( const std::string &  name )

private

Definition at line 67 of file FunctorInterface.C.

{
  std::istringstream ss(name);
  Real real_value;

  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_real_functors.emplace_back(std::make_unique<Moose::Functor<Real>>(
        std::make_unique<Moose::ConstantFunctor<Real>>(real_value)));
    auto & default_property = _default_real_functors.back();
    return default_property.get();
  }

  return nullptr;
}

defaultFunctor() [3/3]

const Moose::Functor< ADReal > * FunctorInterface::defaultFunctor ( const std::string &  name )

private

Definition at line 86 of file FunctorInterface.C.

{
  std::istringstream ss(name);
  Real real_value;

  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_ad_real_functors.emplace_back(std::make_unique<Moose::Functor<ADReal>>(
        std::make_unique<Moose::ConstantFunctor<ADReal>>(real_value)));
    auto & default_property = _default_ad_real_functors.back();
    return default_property.get();
  }

  return nullptr;
}

getFunctor() [1/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name )

protected

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file

Returns

The functor

Definition at line 200 of file FunctorInterface.h.

Referenced by MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl().

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, _fi_tid);
}

getFunctor() [2/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, THREAD_ID  tid  )

protected

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
tid	The thread ID used to retrieve the functor from this interface's subproblem

Returns

The functor

Definition at line 192 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, tid);
}

getFunctor() [3/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, SubProblem &  subproblem  )

protected

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns

The functor

Definition at line 185 of file FunctorInterface.h.

{
  return getFunctor<T>(name, subproblem, _fi_tid);
}

getFunctor() [4/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, SubProblem &  subproblem, THREAD_ID  tid  )

protected

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the subproblem

Returns

The functor

Definition at line 176 of file FunctorInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);
  return getFunctorByName<T>(functor_name, subproblem, tid);
}

getFunctorByName()

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctorByName ( const std::string &  name, SubProblem &  subproblem, THREAD_ID  tid  )

private

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The actual name of the functor to retrieve instead of the parameter name
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the subproblem

Returns

The functor

Definition at line 208 of file FunctorInterface.h.

{
  // Check if it's just a constant
  const auto * const default_functor = defaultFunctor<T>(name);
  if (default_functor)
    return *default_functor;

  return subproblem.getFunctor<T>(name, tid, _fi_name, isADObject());
}

isADObject()

virtual bool FunctorInterface::isADObject ( ) const

privatepure virtual

Whether this interface is for an AD object.

Implemented in ADFunctorInterface, and NonADFunctorInterface.

Referenced by getFunctorByName().

isFunctor() [1/2]

bool FunctorInterface::isFunctor ( const std::string &  name ) const

protected

Checks the subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file

Returns

Whether the subproblem has the specified functor

Definition at line 113 of file FunctorInterface.C.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return isFunctor(name, *_fi_subproblem);
}

isFunctor() [2/2]

bool FunctorInterface::isFunctor ( const std::string &  name, const SubProblem &  subproblem  ) const

protected

Checks the passed-in subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns

Whether the subproblem has the specified functor

Definition at line 104 of file FunctorInterface.C.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);

  return subproblem.hasFunctor(functor_name, _fi_tid);
}

makeElemArg()

Moose::ElemArg FunctorInterface::makeElemArg ( const Elem *  elem, bool  correct_skewnewss = false  ) const

protected

Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.

Definition at line 120 of file FunctorInterface.C.

Referenced by LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVReaction::computeMatrixContribution(), LinearFVTimeDerivative::computeMatrixContribution(), FVFunctorTimeKernel::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), LinearFVSource::computeRightHandSideContribution(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), FunctorAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), FunctorTimes::initialize(), and LinearFVTimeDerivative::setCurrentElemInfo().

{
  return {elem, correct_skewness};
}

validParams()

InputParameters FunctorInterface::validParams ( )

static

Definition at line 14 of file FunctorInterface.C.

Referenced by ADFunctorInterface::validParams(), NonADFunctorInterface::validParams(), and AuxKernelTempl< Real >::validParams().

{
  return emptyInputParameters();
}

Member Data Documentation

_default_ad_real_functors

std::vector<std::unique_ptr<Moose::Functor<ADReal> > > FunctorInterface::_default_ad_real_functors

private

Storage vector for Moose::Functor<ADReal> default objects.

Definition at line 171 of file FunctorInterface.h.

Referenced by defaultFunctor().

_default_real_functors

std::vector<std::unique_ptr<Moose::Functor<Real> > > FunctorInterface::_default_real_functors

private

Storage vector for Moose::Functor<Real> default objects.

Definition at line 168 of file FunctorInterface.h.

Referenced by defaultFunctor().

_fi_name

const std::string FunctorInterface::_fi_name

private

The name of the object that this interface belongs to.

Definition at line 159 of file FunctorInterface.h.

Referenced by getFunctorByName().

_fi_params

const InputParameters& FunctorInterface::_fi_params

private

Parameters of the object with this interface.

Definition at line 156 of file FunctorInterface.h.

Referenced by deduceFunctorName().

_fi_subproblem

SubProblem* const FunctorInterface::_fi_subproblem

private

Pointer to subproblem if the subproblem pointer parameter was set.

Definition at line 162 of file FunctorInterface.h.

Referenced by getFunctor(), and isFunctor().

_fi_tid

const THREAD_ID FunctorInterface::_fi_tid

private

Current threaded it.

Definition at line 165 of file FunctorInterface.h.

Referenced by getFunctor(), and isFunctor().

---

The documentation for this class was generated from the following files:

• include/interfaces/FunctorInterface.h
• src/interfaces/FunctorInterface.C