SurrogateModelInterface.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 SurrogateModel;
class SurrogateTrainerBase;

class SurrogateModelInterface
{
public:
  static InputParameters validParams();

  SurrogateModelInterface(const MooseObject * moose_object);


  template <typename T = SurrogateModel>
  T & getSurrogateModel(const std::string & name) const;
  template <typename T = SurrogateTrainerBase>
  T & getSurrogateTrainer(const std::string & name) const;


  template <typename T = SurrogateModel>
  T & getSurrogateModelByName(const UserObjectName & name) const;
  template <typename T = SurrogateTrainerBase>
  T & getSurrogateTrainerByName(const UserObjectName & name) const;

private:
  const InputParameters & _smi_params;

  FEProblemBase & _smi_feproblem;

  const THREAD_ID _smi_tid;
};

template <typename T>
T &
SurrogateModelInterface::getSurrogateModel(const std::string & name) const
{
  return getSurrogateModelByName<T>(_smi_params.get<UserObjectName>(name));
}

template <typename T>
T &
SurrogateModelInterface::getSurrogateModelByName(const UserObjectName & name) const
{
  std::vector<T *> models;
  _smi_feproblem.theWarehouse()
      .query()
      .condition<AttribName>(name)
      .condition<AttribSystem>("SurrogateModel")
      .queryInto(models);
  if (models.empty())
    mooseError("Unable to find a SurrogateModel object of type " + std::string(typeid(T).name()) +
               " with the name '" + name + "'");
  return *(models[0]);
}

template <typename T>
T &
SurrogateModelInterface::getSurrogateTrainer(const std::string & name) const
{
  return getSurrogateTrainerByName<T>(_smi_params.get<UserObjectName>(name));
}

template <typename T>
T &
SurrogateModelInterface::getSurrogateTrainerByName(const UserObjectName & name) const
{
  SurrogateTrainerBase * base_ptr =
      &_smi_feproblem.getUserObject<SurrogateTrainerBase>(name, _smi_tid);
  T * obj_ptr = dynamic_cast<T *>(base_ptr);
  if (!obj_ptr)
    mooseError("Failed to find a SurrogateTrainer object of type " + std::string(typeid(T).name()) +
                   " with the name '",
               name,
               "' for the desired type.");
  return *obj_ptr;
}