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_MESH_SMOOTHER_H
      21             : #define LIBMESH_MESH_SMOOTHER_H
      22             : 
      23             : namespace libMesh
      24             : {
      25             : 
      26             : // forward declarations
      27             : class UnstructuredMesh;
      28             : 
      29             : 
      30             : /**
      31             :  * This class provides the necessary interface for
      32             :  * mesh smoothing.  Concrete mesh smoothers will be
      33             :  * derived from this abstract base class.
      34             :  *
      35             :  * \author John W. Peterson
      36             :  * \date 2002-2007
      37             :  */
      38             : class MeshSmoother
      39             : {
      40             : public:
      41             :   /**
      42             :    * Constructor.  Sets the mesh reference
      43             :    * in the protected data section of the class.
      44             :    */
      45             :   explicit
      46        1788 :   MeshSmoother(UnstructuredMesh & mesh) : _mesh(mesh) {}
      47             : 
      48             :   /**
      49             :    * Destructor.
      50             :    */
      51           2 :   virtual ~MeshSmoother() = default;
      52             : 
      53             :   /**
      54             :    * Function which actually performs the smoothing operations.
      55             :    * In this abstract base class, this function does nothing.
      56             :    */
      57             :   virtual void smooth() = 0;
      58             : 
      59             : protected:
      60             : 
      61             :   UnstructuredMesh & _mesh;
      62             : };
      63             : 
      64             : } // namespace libMesh
      65             : 
      66             : 
      67             : #endif // LIBMESH_MESH_SMOOTHER_H