SamplerInterface.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 "ParallelUniqueId.h"
#include "InputParameters.h"
#include "FEProblemBase.h"
 
// Forward declarations
class Sampler;
class SamplerInterface
{
public:
  static InputParameters validParams();
 
  SamplerInterface(const MooseObject * moose_object);
 
#ifdef MOOSE_KOKKOS_ENABLED
  SamplerInterface(const SamplerInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif
 
  template <typename T = Sampler>
  T & getSampler(const std::string & name);
 
  template <typename T = Sampler>
  T & getSamplerByName(const SamplerName & name);
 
private:
  const InputParameters & _si_params;
 
  FEProblemBase & _si_feproblem;
 
  THREAD_ID _si_tid;
};
 
template <typename T>
T &
SamplerInterface::getSampler(const std::string & name)
{
  return getSamplerByName<T>(_si_params.get<SamplerName>(name));
}
 
template <typename T>
T &
SamplerInterface::getSamplerByName(const SamplerName & name)
{
  Sampler * base_ptr = &_si_feproblem.getSampler(name, _si_tid);
  T * obj_ptr = dynamic_cast<T *>(base_ptr);
  if (!obj_ptr)
    mooseError("Failed to find a Sampler object with the name '", name, "' for the desired type.");
  return *obj_ptr;
}