periodic_boundary_base.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_PERIODIC_BOUNDARY_BASE_H
#define LIBMESH_PERIODIC_BOUNDARY_BASE_H

// Local Includes
#include "libmesh/libmesh_config.h"

#ifdef LIBMESH_ENABLE_PERIODIC

// Local Includes
#include "libmesh/point.h"
#include "libmesh/dense_matrix.h"

// C++ Includes
#include <set>
#include <memory>

namespace libMesh
{

// Forward Declarations
class Elem;
class MeshBase;

class PeriodicBoundaryBase
{
public:
  enum TransformationType
    { FORWARD=0,
      INVERSE=1 };

  boundary_id_type myboundary, pairedboundary;

  PeriodicBoundaryBase();

  PeriodicBoundaryBase(const PeriodicBoundaryBase & other);

  virtual ~PeriodicBoundaryBase() = default;

  virtual Point get_corresponding_pos(const Point & pt) const = 0;

  virtual std::unique_ptr<PeriodicBoundaryBase> clone(TransformationType t = FORWARD) const = 0;

  void set_variable(unsigned int var);

  void merge(const PeriodicBoundaryBase & pb);

  bool is_my_variable(unsigned int var_num) const;

  bool has_transformation_matrix() const;

  const DenseMatrix<Real> & get_transformation_matrix() const;

  void set_transformation_matrix(const DenseMatrix<Real> & matrix);

  const std::set<unsigned int> & get_variables() const;

protected:

  std::set<unsigned int> variables;

  std::unique_ptr<DenseMatrix<Real>> _transformation_matrix;

};

} // namespace libmesh

#endif // LIBMESH_ENABLE_PERIODIC

#endif // LIBMESH_PERIODIC_BOUNDARY_BASE_H