Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : #include "GeneralUserObject.h"
      13             : 
      14             : // Forward Declarations
      15             : class InputParameters;
      16             : 
      17             : /**
      18             :  * User object intermediate base class that declares an interface for providing generic fields
      19             :  * by name. Note: This object is intentionally inherited from GeneralUserObject (not elemental)
      20             :  * because several cases exist where we need to perform more complex operations possibly over
      21             :  * non-local elements
      22             :  */
      23             : class ElementUOProvider : public GeneralUserObject
      24             : {
      25             : public:
      26             :   static InputParameters validParams();
      27             : 
      28             :   ElementUOProvider(const InputParameters & parameters);
      29             : 
      30           0 :   virtual unsigned long getElementalValueLong(dof_id_type /*element_id*/,
      31             :                                               const std::string & /*field_name*/) const
      32             :   {
      33           0 :     mooseError(name(), " does not satisfy the getElementalValueLong interface");
      34             :   }
      35             : 
      36           0 :   virtual Real getElementalValueReal(dof_id_type /*element_id*/,
      37             :                                      const std::string & /*field_name*/) const
      38             :   {
      39           0 :     mooseError(name(), " does not satisfy the getElementalValueReal interface");
      40             :   }
      41             : };