ClaimRays.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// Local includes
#include "ParallelStudy.h"
#include "Ray.h"

// MOOSE includes
#include "MeshChangedInterface.h"

// System includes
#include <unordered_map>

// libMesh includes
#include "libmesh/bounding_box.h"
#include "libmesh/parallel_object.h"
#include "libmesh/point_locator_base.h"

// Forward declarations
class RayTracingStudy;
class MooseMesh;

class ClaimRays : public libMesh::ParallelObject, public MeshChangedInterface
{
public:
  ClaimRays(RayTracingStudy & study,
            const std::vector<std::shared_ptr<Ray>> & rays,
            std::vector<std::shared_ptr<Ray>> & local_rays,
            const bool do_exchange);

  virtual void meshChanged() override;

  void claim();

protected:
  virtual void init();

  virtual void preClaim() {}
  virtual void postClaim() {}
  virtual void prePossiblyClaimRay(const std::shared_ptr<Ray> & /* ray */) {}
  virtual void postClaimRay(std::shared_ptr<Ray> & ray, const Elem * elem);

  virtual RayID getID(const std::shared_ptr<Ray> & ray) const { return ray->id(); }

  const libMesh::BoundingBox & inflatedBoundingBox(const processor_id_type pid) const
  {
    return _inflated_bboxes[pid];
  }

  MooseMesh & _mesh;
  const processor_id_type _pid;

  const bool _do_exchange;

  RayTracingStudy & _study;
  ParallelStudy<std::shared_ptr<Ray>, Ray> & _parallel_study;

private:
  void buildBoundingBoxes();

  void buildPointNeighbors();

  void possiblyClaim(const std::shared_ptr<Ray> & obj);

  void verifyClaiming();

  const Elem * claimPoint(const Point & point, const RayID id, const Elem * elem);

  const std::vector<std::shared_ptr<Ray>> & _rays;
  std::vector<std::shared_ptr<Ray>> & _local_rays;

  std::unique_ptr<libMesh::PointLocatorBase> _point_locator = nullptr;

  std::vector<libMesh::BoundingBox> _inflated_bboxes;

  std::unordered_map<dof_id_type, std::vector<const Elem *>> _elem_point_neighbors;

  bool _needs_init;
};