Line data    Source code

       1             : // The libMesh Finite Element Library.
       2             : // Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
       3             : 
       4             : // This library is free software; you can redistribute it and/or
       5             : // modify it under the terms of the GNU Lesser General Public
       6             : // License as published by the Free Software Foundation; either
       7             : // version 2.1 of the License, or (at your option) any later version.
       8             : 
       9             : // This library is distributed in the hope that it will be useful,
      10             : // but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             : // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      12             : // Lesser General Public License for more details.
      13             : 
      14             : // You should have received a copy of the GNU Lesser General Public
      15             : // License along with this library; if not, write to the Free Software
      16             : // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
      17             : 
      18             : 
      19             : 
      20             : #ifndef LIBMESH_SYSTEM_SUBSET_H
      21             : #define LIBMESH_SYSTEM_SUBSET_H
      22             : 
      23             : // Local Includes
      24             : #include "libmesh/reference_counted_object.h"
      25             : 
      26             : // C++ includes
      27             : #include <vector>
      28             : 
      29             : namespace libMesh
      30             : {
      31             : 
      32             : // Forward Declarations
      33             : class System;
      34             : 
      35             : /**
      36             :  * This is a base class for classes which represent subsets of the
      37             :  * dofs of a \p System.
      38             :  *
      39             :  * \author Tim Kroeger
      40             :  * \date 2010
      41             :  */
      42          12 : class SystemSubset : public ReferenceCountedObject<SystemSubset>
      43             : {
      44             : public:
      45             : 
      46             :   /**
      47             :    * Constructor.
      48             :    */
      49             :   explicit
      50             :   SystemSubset (const System & system);
      51             : 
      52             :   /**
      53             :    * Destructor.
      54             :    */
      55             :   virtual ~SystemSubset ();
      56             : 
      57             :   /**
      58             :    * \returns The actual set of dofs that the subset consists of.
      59             :    *
      60             :    * The result must contain local dofs on each processor only and
      61             :    * must not contain duplicates.
      62             :    */
      63             :   virtual const std::vector<unsigned int> & dof_ids () const = 0;
      64             : 
      65             :   /**
      66             :    * \returns The \p System to which we belong.
      67             :    */
      68             :   const System & get_system () const;
      69             : 
      70             : protected:
      71             : 
      72             :   /**
      73             :    * A reference to the \p System we belong to.
      74             :    */
      75             :   const System & _system;
      76             : 
      77             : private:
      78             :   /**
      79             :    * This isn't a copyable object, so let's make sure nobody tries.
      80             :    *
      81             :    * We won't even bother implementing this; we'll just make sure that
      82             :    * the compiler doesn't implement a default.
      83             :    */
      84             :   SystemSubset(const SystemSubset &);
      85             : 
      86             :   /**
      87             :    * This isn't a copyable object, so let's make sure nobody tries.
      88             :    *
      89             :    * We won't even bother implementing this; we'll just make sure that
      90             :    * the compiler doesn't implement a default.
      91             :    */
      92             :   SystemSubset & operator= (const SystemSubset &);
      93             : }; // class SystemSubset
      94             : 
      95             : } // namespace libMesh
      96             : 
      97             : #endif // LIBMESH_SYSTEM_SUBSET_H