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)
template<class T >
const T &	getUserObject (const std::string &name)
	Get an user object with a given parameter name. More...
template<class T >
const T &	getUserObjectByName (const std::string &name)
	Get an user object with a given name. More...
const UserObject &	getUserObjectBase (const std::string &name)
	Get an user object with a given parameter name. More...
const UserObject &	getUserObjectBaseByName (const std::string &name)
	Get an user object with a given name. More...

Private Member Functions
bool	needThreadedCopy (const UserObject &uo) const
	Check if the threaded copy of the user object is needed. More...

Private Attributes
const InputParameters &	_uoi_params
	Parameters of the object with this interface. More...
FEProblemBase &	_uoi_feproblem
	Reference to the FEProblemBase instance. More...
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()

UserObjectInterface::UserObjectInterface

(

const MooseObject *

moose_object

)

Parameters

params

The parameters used by the object being instantiated. This class needs them so it can get the user object named in the input file, but the object calling getUserObject only needs to use the name on the left hand side of the statement "user_object = user_object_name"

Definition at line 16 of file UserObjectInterface.C.

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

Member Function Documentation

getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject

(

const std::string &

name

)

Get an user object with a given parameter name.

Parameters

name	The name of the parameter key of the user object to retrieve

Returns

The user object with name associated with the parameter 'name'

Definition at line 81 of file UserObjectInterface.h.

{
  unsigned int tid = needThreadedCopy(getUserObjectBase(name)) ? _uoi_tid : 0;
  return _uoi_feproblem.getUserObject<T>(_uoi_params.get<UserObjectName>(name), tid);
}

getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase

(

const std::string &

name

)

Get an user object with a given parameter name.

Parameters

name	The name of the parameter key of the user object to retrieve

Returns

The user object with name associated with the parameter 'name'

Definition at line 24 of file UserObjectInterface.C.

Referenced by getUserObject(), InitialConditionBase::getUserObjectBase(), and AuxKernel::getUserObjectBase().

{
  return _uoi_feproblem.getUserObjectBase(_uoi_params.get<UserObjectName>(name));
}

getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName

(

const std::string &

name

)

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns

The user object with the name

Definition at line 30 of file UserObjectInterface.C.

Referenced by getUserObjectByName().

{
  return _uoi_feproblem.getUserObjectBase(name);
}

getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName

(

const std::string &

name

)

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns

The user object with the name

Definition at line 89 of file UserObjectInterface.h.

{
  unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
  return _uoi_feproblem.getUserObject<T>(name, tid);
}

needThreadedCopy()

bool UserObjectInterface::needThreadedCopy ( const UserObject &  uo ) const

private

Check if the threaded copy of the user object is needed.

Definition at line 36 of file UserObjectInterface.C.

Referenced by getUserObject(), and getUserObjectByName().

{
  return (dynamic_cast<const DiscreteElementUserObject *>(&uo) != NULL) ||
         (dynamic_cast<const ThreadedGeneralUserObject *>(&uo) != NULL);
}

Member Data Documentation

_uoi_feproblem

FEProblemBase& UserObjectInterface::_uoi_feproblem

private

Reference to the FEProblemBase instance.

Definition at line 70 of file UserObjectInterface.h.

Referenced by getUserObject(), getUserObjectBase(), getUserObjectBaseByName(), and getUserObjectByName().

_uoi_params

const InputParameters& UserObjectInterface::_uoi_params

private

Parameters of the object with this interface.

Definition at line 67 of file UserObjectInterface.h.

Referenced by getUserObject(), and getUserObjectBase().

_uoi_tid

THREAD_ID UserObjectInterface::_uoi_tid

private

Thread ID.

Definition at line 73 of file UserObjectInterface.h.

Referenced by getUserObject(), and getUserObjectByName().

---

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

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