DistributionInterface.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 "InputParameters.h"
#include "ParallelUniqueId.h"
#include "MooseObject.h"
 
// Forward declarations
class Distribution;
class FEProblemBase;
 
class DistributionInterface
{
public:
  static InputParameters validParams();
 
  DistributionInterface(const MooseObject * moose_object);
 
#ifdef MOOSE_KOKKOS_ENABLED
  DistributionInterface(const DistributionInterface & object,
                        const Moose::Kokkos::FunctorCopy & key);
#endif
 
 
  const Distribution & getDistribution(const std::string & name) const;
 
  template <typename T>
  const T & getDistribution(const std::string & name) const;
 
 
  const Distribution & getDistributionByName(const DistributionName & name) const;
 
  template <typename T>
  const T & getDistributionByName(const std::string & name) const;
 
private:
  const InputParameters & _dni_params;
 
  FEProblemBase & _dni_feproblem;
 
  const MooseObject * const _dni_moose_object_ptr;
};
 
template <typename T>
const T &
DistributionInterface::getDistribution(const std::string & name) const
{
  try
  {
    const T & dist = dynamic_cast<const T &>(getDistribution(name));
    return dist;
  }
  catch (std::bad_cast & exception)
  {
    DistributionName dist_name = _dni_params.get<DistributionName>(name);
    mooseError("The '",
               _dni_moose_object_ptr->name(),
               "' object failed to retrieve '",
               dist_name,
               "' distribution with the desired type.");
  }
}
 
template <typename T>
const T &
DistributionInterface::getDistributionByName(const std::string & name) const
{
  try
  {
    const T & dist = dynamic_cast<const T &>(getDistribution(name));
    return dist;
  }
  catch (std::bad_cast & exception)
  {
    mooseError("The '",
               _dni_moose_object_ptr->name(),
               "' object failed to retrieve '",
               name,
               "' distribution with the desired type.");
  }
}