https://mooseframework.inl.gov
GhostAllPointNeighbors.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 // App includes
11 #include "GhostAllPointNeighbors.h"
12 #include "Executioner.h"
13 #include "FEProblemBase.h"
14 #include "MooseApp.h"
15 #include "GhostLowerDElems.h"
17 
18 // libMesh includes
19 #include "libmesh/elem.h"
20 #include "libmesh/mesh_base.h"
21 #include "libmesh/boundary_info.h"
22 
24 
25 using namespace libMesh;
26 
29 {
31  params.set<bool>("attach_geometric_early") = false;
32  return params;
33 }
34 
36  : RelationshipManager(params)
37 {
38 }
39 
41  : RelationshipManager(other)
42 {
43 }
44 
45 std::string
47 {
48  std::ostringstream oss;
49  oss << "GhostAllPointNeighbors";
50  return oss.str();
51 }
52 
53 void
54 GhostAllPointNeighbors::operator()(const MeshBase::const_element_iterator & range_begin,
55  const MeshBase::const_element_iterator & range_end,
56  const processor_id_type p,
57  map_type & coupled_elements)
58 {
59  mooseAssert(_moose_mesh,
60  "The MOOSE mesh must be non-null in order for this relationship manager to work.");
61  const auto & node_to_elem_map = _moose_mesh->nodeToElemMap();
62 
63  static const CouplingMatrix * const null_mat = nullptr;
64  std::unordered_set<dof_id_type> visited_nodes;
65 
66  for (const Elem * const elem : as_range(range_begin, range_end))
67  for (const auto & node : elem->node_ref_range())
68  {
69  // We want to ghost the point neighbors if the node hasn't been partitioned yet
70  // (e.g. we don't know what processes it will be) or if its processor id matches our
71  // processes's id
72  const auto node_pid = node.processor_id();
73  if (node_pid == p || node_pid == DofObject::invalid_processor_id)
74  {
75  const auto [_, inserted] = visited_nodes.insert(node.id());
76  if (!inserted)
77  // We've already considered this node
78  continue;
79 
80  const auto & elem_node_neighbors = libmesh_map_find(node_to_elem_map, node.id());
81  for (const auto elem_id : elem_node_neighbors)
82  {
83  const Elem * const elem_node_neighbor = _mesh->elem_ptr(elem_id);
84  if (elem_node_neighbor->processor_id() != p)
85  coupled_elements.emplace(elem_node_neighbor, null_mat);
86  }
87  }
88  }
89 }
90 
91 bool
93 {
94  return dynamic_cast<const GhostAllPointNeighbors *>(&other) ||
95  dynamic_cast<const GhostLowerDElems *>(&other) ||
96  dynamic_cast<const GhostHigherDLowerDPointNeighbors *>(&other);
97 }
98 
99 std::unique_ptr<GhostingFunctor>
101 {
102  return _app.getFactory().copyConstruct(*this);
103 }
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
MooseMesh * _moose_mesh
Pointer to the MooseMesh object.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::map< const Elem *, const CouplingMatrix *, CompareDofObjectsByPIDAndThenID > map_type
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
static InputParameters validParams()
Factory & getFactory()
Retrieve a writable reference to the Factory associated with this App.
Definition: MooseApp.h:406
uint8_t processor_id_type
registerMooseObject("MooseApp", GhostAllPointNeighbors)
std::string getInfo() const override
Method for returning relationship manager information (suitable for console output).
SimpleRange< IndexType > as_range(const std::pair< IndexType, IndexType > &p)
MooseApp & _app
The MOOSE application this is associated with.
Definition: MooseBase.h:385
std::unique_ptr< GhostingFunctor > clone() const override
Ghosts lower-D point neighbors of higher-D elements.
const MeshBase * _mesh
virtual const Elem * elem_ptr(const dof_id_type i) const=0
GhostAllPointNeighbors(const InputParameters &)
RelationshipManagers are used for describing what kinds of non-local resources are needed for an obje...
static InputParameters validParams()
void operator()(const MeshBase::const_element_iterator &range_begin, const MeshBase::const_element_iterator &range_end, processor_id_type p, map_type &coupled_elements) override
Ghosts all point neighbors (not including periodic neighbors) regardless of the dimensionality of the...
virtual bool operator>=(const RelationshipManager &other) const override
Whether this relationship manager provides more or the same amount and type of ghosting as the rhs...
processor_id_type processor_id() const
const std::map< dof_id_type, std::vector< dof_id_type > > & nodeToElemMap()
If not already created, creates a map from every node to all elements to which they are connected...
Definition: MooseMesh.C:1201