libMesh::PeriodicBoundaries Class Reference

We're using a class instead of a typedef to allow forward declarations and future flexibility. More...

#include <periodic_boundaries.h>

Inheritance diagram for libMesh::PeriodicBoundaries:

Public Member Functions
PeriodicBoundaryBase *	boundary (boundary_id_type id)
const PeriodicBoundaryBase *	boundary (boundary_id_type id) const
	PeriodicBoundaries ()=default
	~PeriodicBoundaries ()
const Elem *	neighbor (boundary_id_type boundary_id, const PointLocatorBase &point_locator, const Elem *e, unsigned int side, unsigned int *neigh_side=nullptr) const

Detailed Description

We're using a class instead of a typedef to allow forward declarations and future flexibility.

Author

Roy Stogner

Date

2010

Maps between boundary ids and PeriodicBoundaryBase objects.

Definition at line 49 of file periodic_boundaries.h.

Constructor & Destructor Documentation

PeriodicBoundaries()

libMesh::PeriodicBoundaries::PeriodicBoundaries ( )

default

~PeriodicBoundaries()

libMesh::PeriodicBoundaries::~PeriodicBoundaries ( )

default

Member Function Documentation

boundary() [1/2]

PeriodicBoundaryBase * libMesh::PeriodicBoundaries::boundary

(

boundary_id_type

id

)

Definition at line 38 of file periodic_boundaries.C.

{
  iterator i = this->find(id);
  if (i == this->end())
    return nullptr;
  return i->second.get();
}

Referenced by libMesh::FEGenericBase< OutputType >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), neighbor(), libMesh::UnstructuredMesh::stitching_helper(), libMesh::Elem::topological_neighbor(), and libMesh::Elem::topological_neighbor().

boundary() [2/2]

const PeriodicBoundaryBase * libMesh::PeriodicBoundaries::boundary

(

boundary_id_type

id

)

const

Definition at line 48 of file periodic_boundaries.C.

{
  const_iterator i = this->find(id);
  if (i == this->end())
    return nullptr;
  return i->second.get();
}

neighbor()

const Elem * libMesh::PeriodicBoundaries::neighbor	(	boundary_id_type	boundary_id,
		const PointLocatorBase &	point_locator,
		const Elem *	e,
		unsigned int	side,
		unsigned int *	neigh_side = nullptr
	)		const

Definition at line 59 of file periodic_boundaries.C.

{
  std::unique_ptr<const Elem> neigh_side_proxy;
 
  // Find a point on that side (and only that side)
  Point p = e->build_side_ptr(side)->vertex_average();
 
  const PeriodicBoundaryBase * b = this->boundary(boundary_id);
  libmesh_assert (b);
  p = b->get_corresponding_pos(p);
 
  std::set<const Elem *> candidate_elements;
  point_locator.operator()(p, candidate_elements);
 
  // We might have found multiple elements, e.g. if two distinct periodic
  // boundaries are overlapping (see systems_of_equations_ex9, for example).
  // As a result, we need to search for the element that has boundary_id.
  const MeshBase & mesh = point_locator.get_mesh();
  for(const Elem * elem_it : candidate_elements)
    {
      std::vector<unsigned int> neigh_sides =
        mesh.get_boundary_info().sides_with_boundary_id(elem_it, b->pairedboundary);
 
      for (auto ns : neigh_sides)
        {
          if (neigh_side)
            {
              elem_it->build_side_ptr(neigh_side_proxy, ns);
              if (neigh_side_proxy->contains_point(p))
                {
                  *neigh_side = ns;
                  return elem_it;
                }
            }
          else
            // checking contains_point is too expensive if we don't
            // definitely need it to find neigh_side
            return elem_it;
        }
    }
 
  // If we should have found a periodic neighbor but didn't then
  // either we're on a ghosted element with a remote periodic neighbor
  // or we're on a mesh with an inconsistent periodic boundary.
  libmesh_error_msg_if(mesh.is_serial() ||
                       (e->processor_id() == mesh.processor_id()),
                       "Periodic boundary neighbor not found");
 
  if (neigh_side)
    *neigh_side = libMesh::invalid_uint;
  return remote_elem;
}

References b, boundary(), libMesh::Elem::build_side_ptr(), libMesh::MeshBase::get_boundary_info(), libMesh::PointLocatorBase::get_mesh(), libMesh::invalid_uint, libMesh::libmesh_assert(), mesh, libMesh::DofObject::processor_id(), libMesh::remote_elem, and libMesh::BoundaryInfo::sides_with_boundary_id().

Referenced by libMesh::FEGenericBase< OutputType >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), libMesh::Elem::topological_neighbor(), and libMesh::Elem::topological_neighbor().

---

The documentation for this class was generated from the following files:

• include/base/periodic_boundaries.h
• src/base/periodic_boundaries.C