UserObjectInterface Class Reference

Interface for objects that need to use UserObjects. More...

#include <UserObjectInterface.h>

Inheritance diagram for UserObjectInterface:

Public Member Functions
	UserObjectInterface (const MooseObject *moose_object)
	UserObjectInterface (const UserObjectInterface &object, const Moose::Kokkos::FunctorCopy &key)
	Special constructor used for Kokkos functor copy during parallel dispatch. More...
UserObjectName	getUserObjectName (const std::string &param_name) const
template<class T >
const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter param_name. More...
template<class T >
const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
	Get an user object with the name object_name. More...
const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter param_name. More...
const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
	Get an user object with the name object_name. More...
bool	hasUserObject (const std::string &param_name) const
template<class T >
bool	hasUserObject (const std::string &param_name) const
bool	hasUserObjectByName (const UserObjectName &object_name) const
template<class T >
bool	hasUserObjectByName (const UserObjectName &object_name) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	addUserObjectDependencyHelper (const UserObject &) const
	Helper for deriving classes to override to add dependencies when a UserObject is requested. More...

Private Member Functions
const UserObject &	getUserObjectFromFEProblem (const UserObjectName &object_name) const
	Go directly to the FEProblem for the requested UserObject. More...
template<class T >
const T &	castUserObject (const UserObject &uo_base, const std::string &param_name="") const
	Internal helper that casts the UserObject uo_base to the requested type. More...
void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const
	emit an error for the given parameter More...
const std::string &	userObjectType (const UserObject &uo) const
	Gets a UserObject's type; avoids including UserObject.h in the UserObjectInterface. More...
const std::string &	userObjectName (const UserObject &uo) const
	Gets a UserObject's name; avoids including UserObject.h in the UserObjectInterface. More...

Private Attributes
const MooseObject &	_uoi_moose_object
	Moose object using the interface. More...
const FEProblemBase &	_uoi_feproblem
	Reference to the FEProblemBase instance. More...
const THREAD_ID	_uoi_tid
	Thread ID. More...

Detailed Description

Interface for objects that need to use UserObjects.

Definition at line 24 of file UserObjectInterface.h.

Constructor & Destructor Documentation

UserObjectInterface() [1/2]

UserObjectInterface::UserObjectInterface

(

const MooseObject *

moose_object

)

Definition at line 24 of file UserObjectInterface.C.

  : _uoi_moose_object(*moose_object),
    _uoi_feproblem(*_uoi_moose_object.parameters().getCheckedPointerParam<FEProblemBase *>(
        "_fe_problem_base")),
    _uoi_tid(_uoi_moose_object.parameters().have_parameter<THREAD_ID>("_tid")
                 ? _uoi_moose_object.parameters().get<THREAD_ID>("_tid")
                 : 0)
{
}

UserObjectInterface() [2/2]

UserObjectInterface::UserObjectInterface	(	const UserObjectInterface &	object,
		const Moose::Kokkos::FunctorCopy &	key
	)

Special constructor used for Kokkos functor copy during parallel dispatch.

Definition at line 35 of file UserObjectInterface.C.

  : _uoi_moose_object(object._uoi_moose_object),
    _uoi_feproblem(object._uoi_feproblem),
    _uoi_tid(object._uoi_tid)
{
}

Member Function Documentation

addUserObjectDependencyHelper()

virtual void UserObjectInterface::addUserObjectDependencyHelper ( const UserObject &  ) const

inlineprotectedvirtual

Helper for deriving classes to override to add dependencies when a UserObject is requested.

Reimplemented in UserObject, AuxKernelBase, and InitialConditionBase.

Definition at line 111 of file UserObjectInterface.h.

Referenced by getUserObjectBaseByName().

{}

castUserObject()

template<class T >

const T & UserObjectInterface::castUserObject ( const UserObject &  uo_base, const std::string &  param_name = ""  ) const

private

Internal helper that casts the UserObject uo_base to the requested type.

Exits with a useful error if the casting failed. If the parameter param_name is provided and is valid, a paramError() will be used instead.

Definition at line 149 of file UserObjectInterface.h.

{
  const T * uo = dynamic_cast<const T *>(&uo_base);

  if (!uo)
  {
    std::stringstream oss;
    oss << "The provided UserObject \"" << userObjectName(uo_base) << "\" of type "
        << userObjectType(uo_base)
        << " is not derived from the required type.\n\nThe UserObject must derive from "
        << MooseUtils::prettyCppType<T>() << ".";

    mooseObjectError(param_name, oss);
  }

  return *uo;
}

getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject	(	const std::string &	param_name,
		bool	is_dependency = true
	)		const

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns

The user object with name associated with the parameter param_name

Definition at line 170 of file UserObjectInterface.h.

{
  return castUserObject<T>(getUserObjectBase(param_name, is_dependency), param_name);
}

getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase	(	const std::string &	param_name,
		bool	is_dependency = true
	)		const

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns

The user object with name associated with the parameter param_name

Definition at line 96 of file UserObjectInterface.C.

Referenced by getUserObject().

{
  const auto object_name = getUserObjectName(param_name);
  if (!hasUserObjectByName(object_name))
    _uoi_moose_object.paramError(
        param_name, "The requested UserObject with the name \"", object_name, "\" was not found.");

  return getUserObjectBaseByName(object_name, is_dependency);
}

getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName	(	const UserObjectName &	object_name,
		bool	is_dependency = true
	)		const

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns

The user object with the name object_name

Definition at line 108 of file UserObjectInterface.C.

Referenced by AuxKernelBase::addPostprocessorDependencyHelper(), AuxKernelBase::addVectorPostprocessorDependencyHelper(), UserObject::getDependObjects(), getUserObjectBase(), and getUserObjectByName().

{
  if (!hasUserObjectByName(object_name))
    _uoi_moose_object.mooseError(
        "The requested UserObject with the name \"", object_name, "\" was not found.");

  const auto & uo_base_tid0 = _uoi_feproblem.getUserObjectBase(object_name, /* tid = */ 0);
  if (is_dependency)
    addUserObjectDependencyHelper(uo_base_tid0);

  const THREAD_ID tid = uo_base_tid0.needThreadedCopy() ? _uoi_tid : 0;
  return _uoi_feproblem.getUserObjectBase(object_name, tid);
}

getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName	(	const UserObjectName &	object_name,
		bool	is_dependency = true
	)		const

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns

The user object with the name object_name

Definition at line 177 of file UserObjectInterface.h.

{
  return castUserObject<T>(getUserObjectBaseByName(object_name, is_dependency));
}

getUserObjectFromFEProblem()

const UserObject & UserObjectInterface::getUserObjectFromFEProblem ( const UserObjectName &  object_name ) const

private

Go directly to the FEProblem for the requested UserObject.

Definition at line 90 of file UserObjectInterface.C.

Referenced by hasUserObjectByName().

{
  return _uoi_feproblem.getUserObjectBase(object_name);
}

getUserObjectName()

UserObjectName UserObjectInterface::getUserObjectName

(

const std::string &

param_name

)

const

Returns

The name of the user object associated with the parameter param_name

Definition at line 45 of file UserObjectInterface.C.

Referenced by getUserObjectBase(), and hasUserObject().

{
  const auto & params = _uoi_moose_object.parameters();

  if (!params.isParamValid(param_name))
    _uoi_moose_object.mooseError("Failed to get a parameter with the name \"",
                                 param_name,
                                 "\" when getting a UserObjectName.",
                                 "\n\nKnown parameters:\n",
                                 _uoi_moose_object.parameters());

  // Other interfaces will use this interface (PostprocessorInterface, VectorPostprocessorInterface)
  // to grab UOs with a specialized name, so we need to check them all
  UserObjectName name;
  if (params.isType<UserObjectName>(param_name))
    name = params.get<UserObjectName>(param_name);
  else if (params.isType<PostprocessorName>(param_name))
    name = params.get<PostprocessorName>(param_name);
  else if (params.isType<VectorPostprocessorName>(param_name))
    name = params.get<VectorPostprocessorName>(param_name);
  else if (params.isType<std::string>(param_name))
    name = params.get<std::string>(param_name);
  else
    _uoi_moose_object.paramError(
        param_name,
        "Parameter of type \"",
        params.type(param_name),
        "\" is not an expected type for getting the name of a UserObject.");

  return name;
}

hasUserObject() [1/2]

bool UserObjectInterface::hasUserObject

(

const std::string &

param_name

)

const

Returns

Whether or not a UserObject exists with the name given by the parameter param_name.

Definition at line 78 of file UserObjectInterface.C.

{
  return hasUserObjectByName(getUserObjectName(param_name));
}

hasUserObject() [2/2]

template<class T >

bool UserObjectInterface::hasUserObject

(

const std::string &

param_name

)

const

Definition at line 185 of file UserObjectInterface.h.

{
  return hasUserObjectByName<T>(getUserObjectName(param_name));
}

hasUserObjectByName() [1/2]

bool UserObjectInterface::hasUserObjectByName

(

const UserObjectName &

object_name

)

const

Definition at line 84 of file UserObjectInterface.C.

Referenced by getUserObjectBase(), getUserObjectBaseByName(), hasUserObject(), and hasUserObjectByName().

{
  return _uoi_feproblem.hasUserObject(object_name);
}

hasUserObjectByName() [2/2]

template<class T >

bool UserObjectInterface::hasUserObjectByName

(

const UserObjectName &

object_name

)

const

Definition at line 192 of file UserObjectInterface.h.

{
  if (!hasUserObjectByName(object_name))
    return false;
  return dynamic_cast<const T *>(&getUserObjectFromFEProblem(object_name));
}

mooseObjectError()

void UserObjectInterface::mooseObjectError ( const std::string &  param_name, std::stringstream &  oss  ) const

private

emit an error for the given parameter

Definition at line 136 of file UserObjectInterface.C.

Referenced by castUserObject().

{
  if (_uoi_moose_object.parameters().isParamValid(param_name))
    _uoi_moose_object.paramError(param_name, oss.str());
  else
    _uoi_moose_object.mooseError(oss.str());
}

userObjectName()

const std::string & UserObjectInterface::userObjectName ( const UserObject &  uo ) const

private

Gets a UserObject's name; avoids including UserObject.h in the UserObjectInterface.

Definition at line 130 of file UserObjectInterface.C.

Referenced by castUserObject().

{
  return uo.name();
}

userObjectType()

const std::string & UserObjectInterface::userObjectType ( const UserObject &  uo ) const

private

Gets a UserObject's type; avoids including UserObject.h in the UserObjectInterface.

Definition at line 124 of file UserObjectInterface.C.

Referenced by castUserObject().

{
  return uo.type();
}

validParams()

InputParameters UserObjectInterface::validParams ( )

static

Definition at line 19 of file UserObjectInterface.C.

Referenced by FVInterfaceKernel::validParams().

{
  return emptyInputParameters();
}

Member Data Documentation

_uoi_feproblem

const FEProblemBase& UserObjectInterface::_uoi_feproblem

private

Reference to the FEProblemBase instance.

Definition at line 141 of file UserObjectInterface.h.

Referenced by getUserObjectBaseByName(), getUserObjectFromFEProblem(), and hasUserObjectByName().

_uoi_moose_object

const MooseObject& UserObjectInterface::_uoi_moose_object

private

Moose object using the interface.

Definition at line 138 of file UserObjectInterface.h.

Referenced by getUserObjectBase(), getUserObjectBaseByName(), getUserObjectName(), and mooseObjectError().

_uoi_tid

const THREAD_ID UserObjectInterface::_uoi_tid

private

Thread ID.

Definition at line 144 of file UserObjectInterface.h.

Referenced by getUserObjectBaseByName().

---

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

• include/userobjects/UserObjectInterface.h
• src/userobjects/UserObjectInterface.C