periodic_boundary.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_H
#define LIBMESH_PERIODIC_BOUNDARY_H

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

#ifdef LIBMESH_ENABLE_PERIODIC

// Local Includes
#include "libmesh/periodic_boundary_base.h"
#include "libmesh/vector_value.h" // RealVectorValue

namespace libMesh
{

// Forward Declarations
class Elem;
class MeshBase;

class PeriodicBoundary : public PeriodicBoundaryBase
{
public:
  PeriodicBoundary();

  virtual ~PeriodicBoundary() = default;

  PeriodicBoundary(const PeriodicBoundary & o, TransformationType t = FORWARD);

  PeriodicBoundary(const RealVectorValue & vector);

  virtual Point get_corresponding_pos(const Point & pt) const override;

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

protected:

  // The vector which is added to points in myboundary
  // to produce corresponding points in pairedboundary
  RealVectorValue translation_vector;
};

} // namespace libmesh

#endif // LIBMESH_ENABLE_PERIODIC

#endif // LIBMESH_PERIODIC_BOUNDARY_H