libMesh::PeriodicBoundaries Class Reference

Maps between boundary ids and PeriodicBoundaryBase objects. 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 ()
	~PeriodicBoundaries ()
const Elem *	neighbor (boundary_id_type boundary_id, const PointLocatorBase &point_locator, const Elem *e, unsigned int side) const

Detailed Description

Maps between boundary ids and PeriodicBoundaryBase objects.

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

Note

std::map has no virtual destructor, so downcasting here would be dangerous.

Author

Roy Stogner

Date

2010

Definition at line 51 of file periodic_boundaries.h.

Constructor & Destructor Documentation

PeriodicBoundaries()

libMesh::PeriodicBoundaries::PeriodicBoundaries ( )

inline

Definition at line 58 of file periodic_boundaries.h.

{}

~PeriodicBoundaries()

libMesh::PeriodicBoundaries::~PeriodicBoundaries

(

)

Definition at line 32 of file periodic_boundaries.C.

{
  for (auto & pr : *this)
    delete pr.second;
}

Member Function Documentation

boundary() [1/2]

PeriodicBoundaryBase * libMesh::PeriodicBoundaries::boundary

(

boundary_id_type

id

)

Definition at line 40 of file periodic_boundaries.C.

References end.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::FEAbstract::compute_periodic_node_constraints(), neighbor(), and libMesh::Elem::topological_neighbor().

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

boundary() [2/2]

const PeriodicBoundaryBase * libMesh::PeriodicBoundaries::boundary

(

boundary_id_type

id

)

const

Definition at line 50 of file periodic_boundaries.C.

References end.

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

neighbor()

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

Definition at line 61 of file periodic_boundaries.C.

References boundary(), libMesh::Elem::build_side_ptr(), libMesh::PeriodicBoundaryBase::get_corresponding_pos(), libMesh::PointLocatorBase::get_mesh(), libMesh::invalid_uint, mesh, libMesh::PeriodicBoundaryBase::pairedboundary, and side.

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

{
  // Find a point on that side (and only that side)

  Point p = e->build_side_ptr(side)->centroid();

  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)
    {
      unsigned int s_neigh =
        mesh.get_boundary_info().side_with_boundary_id(elem_it, b->pairedboundary);

      // If s_neigh is not invalid then we have found an element that contains
      // boundary_id, so return this element
      if(s_neigh != libMesh::invalid_uint)
        {
          return elem_it;
        }
    }

  libmesh_error_msg("Periodic boundary neighbor not found");
  return nullptr;
}

---

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

• periodic_boundaries.h
• periodic_boundaries.C