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 "libmesh/elem.h"
      13             : 
      14             : using libMesh::Elem;
      15             : 
      16             : /**
      17             :  * Abstract base class for user objects that provide an index for a given element that is
      18             :  * independent of the block id, so that behavior can be different on subsets of element blocks.
      19             :  * This is used to apply independent generalized plane constraints to subsets of element blocks.
      20             :  */
      21           4 : class SubblockIndexProvider
      22             : {
      23             : public:
      24             :   virtual ~SubblockIndexProvider(){};
      25             :   /**
      26             :    * The index of subblock this element is on.
      27             :    */
      28             :   virtual unsigned int getSubblockIndex(const Elem & /* elem */) const = 0;
      29             :   /**
      30             :    * The max index of subblock.
      31             :    */
      32             :   virtual unsigned int getMaxSubblockIndex() const = 0;
      33             : };