mesh_smoother_vsmoother.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_MESH_SMOOTHER_VSMOOTHER_H
#define LIBMESH_MESH_SMOOTHER_VSMOOTHER_H

#include "libmesh/libmesh_config.h"
#if defined(LIBMESH_ENABLE_VSMOOTHER)

// Local Includes
#include "libmesh/libmesh_common.h"
#include "libmesh/mesh_smoother.h"
#include "libmesh/variational_smoother_system.h"
#include "libmesh/variational_smoother_constraint.h"
#include "petsc_diff_solver.h"
#include "libmesh/distributed_mesh.h"
#include "libmesh/equation_systems.h"

// C++ Includes
#include <cstddef>
#include <vector>
#include <map>
#include <fstream>

namespace libMesh
{

// Forward declarations
class UnstructuredMesh;

class VariationalMeshSmoother : public MeshSmoother
{
public:
  VariationalMeshSmoother(UnstructuredMesh & mesh,
                          Real dilation_weight = 0.5,
                          const bool preserve_subdomain_boundaries = true,
                          const double relative_residual_tolerance = TOLERANCE * TOLERANCE,
                          const double absolute_residual_tolerance = TOLERANCE * TOLERANCE,
                          const bool solver_quiet = true,
                          const bool solver_verbose = false);

  virtual ~VariationalMeshSmoother() = default;

  virtual void setup();

  virtual void smooth() override {this->smooth(1); }

  void smooth(unsigned int n_iterations);

  const MeshQualityInfo & get_mesh_info() const;

private:

  const Real _dilation_weight;

  const bool _preserve_subdomain_boundaries;

  // These must be declared in reverse dependency order to avoid corrupting the
  // heap during destruction

  // independent of _equations_systems and _constraint
  std::unique_ptr<DistributedMesh> _mesh_copy;

  // uses _mesh_copy, owns the system
  std::unique_ptr<EquationSystems> _equation_systems;


  // Now it's safe to store non-owning pointers to the above

  /*
   * System used to smooth the mesh.
   */
  // Owned by _equation_systems
  VariationalSmootherSystem * _system;

  VariationalSmootherSystem * system() const
  {
    libmesh_assert(_system);
    return _system;
  }

  // uses system, which is owned by _equations_systems
  std::unique_ptr<VariationalSmootherConstraint> _constraint;

  bool _setup_called;

  double _relative_residual_tolerance;

  double _absolute_residual_tolerance;

  bool _solver_quiet;

  bool _solver_verbose;
};

} // namespace libMesh

#endif // defined(LIBMESH_ENABLE_VSMOOTHER)

#endif // LIBMESH_MESH_SMOOTHER_VSMOOTHER_H