UserObjectInterface.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

// MOOSE includes
#include "FEProblemBase.h"
#include "MooseTypes.h"

// Forward declarations
class InputParameters;
class UserObject;

#define adGetUserObject this->template getUserObject

class UserObjectInterface
{
public:
  UserObjectInterface(const MooseObject * moose_object);

  template <class T>
  const T & getUserObject(const std::string & name);

  template <class T>
  const T & getUserObjectByName(const std::string & name);

  const UserObject & getUserObjectBase(const std::string & name);

  const UserObject & getUserObjectBaseByName(const std::string & name);

private:
  const InputParameters & _uoi_params;

  FEProblemBase & _uoi_feproblem;

  THREAD_ID _uoi_tid;

  bool needThreadedCopy(const UserObject & uo) const;
};

template <class T>
const T &
UserObjectInterface::getUserObject(const std::string & name)
{
  unsigned int tid = needThreadedCopy(getUserObjectBase(name)) ? _uoi_tid : 0;
  return _uoi_feproblem.getUserObject<T>(_uoi_params.get<UserObjectName>(name), tid);
}

template <class T>
const T &
UserObjectInterface::getUserObjectByName(const std::string & name)
{
  unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
  return _uoi_feproblem.getUserObject<T>(name, tid);
}