www.mooseframework.org
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DiracKernelInfo Class Reference

The DiracKernelInfo object is a place where all the Dirac points added by different DiracKernels are collected. More...

#include <DiracKernelInfo.h>

Public Types

typedef std::map< const Elem *, std::pair< std::vector< Point >, std::vector< unsigned int > > > MultiPointMap
 

Public Member Functions

 DiracKernelInfo ()
 
virtual ~DiracKernelInfo ()
 
void addPoint (const Elem *elem, Point p)
 Adds a point source. More...
 
void clearPoints ()
 Remove all of the current points and elements. More...
 
bool hasPoint (const Elem *elem, Point p)
 Return true if we have Point 'p' in Element 'elem'. More...
 
std::set< const Elem * > & getElements ()
 Returns a writeable reference to the _elements container. More...
 
MultiPointMapgetPoints ()
 Returns a writeable reference to the _points container. More...
 
void updatePointLocator (const MooseMesh &mesh)
 Called during FEProblemBase::meshChanged() to update the PointLocator object used by the DiracKernels. More...
 
const Elem * findPoint (Point p, const MooseMesh &mesh)
 Used by client DiracKernel classes to determine the Elem in which the Point p resides. More...
 

Protected Member Functions

bool pointsFuzzyEqual (const Point &, const Point &)
 Check if two points are equal with respect to a tolerance. More...
 

Protected Attributes

std::set< const Elem * > _elements
 The list of elements that need distributions. More...
 
MultiPointMap _points
 The list of physical xyz Points that need to be evaluated in each element. More...
 
std::unique_ptr< PointLocatorBase > _point_locator
 The DiracKernelInfo object manages a PointLocator object which is used by all DiracKernels to find Points. More...
 
const Real _point_equal_distance_sq
 threshold distance squared below which two points are considered identical More...
 

Detailed Description

The DiracKernelInfo object is a place where all the Dirac points added by different DiracKernels are collected.

It is used, for example, by the FEProblemBase class to determine if finite element data needs to be recomputed on a given element.

Definition at line 37 of file DiracKernelInfo.h.

Member Typedef Documentation

◆ MultiPointMap

typedef std::map<const Elem *, std::pair<std::vector<Point>, std::vector<unsigned int> > > DiracKernelInfo::MultiPointMap

Definition at line 67 of file DiracKernelInfo.h.

Constructor & Destructor Documentation

◆ DiracKernelInfo()

DiracKernelInfo::DiracKernelInfo ( )

Definition at line 18 of file DiracKernelInfo.C.

19  : _point_locator(), _point_equal_distance_sq(libMesh::TOLERANCE * libMesh::TOLERANCE)
20 {
21 }
std::unique_ptr< PointLocatorBase > _point_locator
The DiracKernelInfo object manages a PointLocator object which is used by all DiracKernels to find Po...
const Real _point_equal_distance_sq
threshold distance squared below which two points are considered identical

◆ ~DiracKernelInfo()

DiracKernelInfo::~DiracKernelInfo ( )
virtual

Definition at line 23 of file DiracKernelInfo.C.

23 {}

Member Function Documentation

◆ addPoint()

void DiracKernelInfo::addPoint ( const Elem *  elem,
Point  p 
)

Adds a point source.

Parameters
elemPointer to the geometric element in which the point is located
pThe (x,y,z) location of the Dirac point

Definition at line 26 of file DiracKernelInfo.C.

Referenced by DiracKernel::addPoint().

27 {
28  _elements.insert(elem);
29 
30  std::pair<std::vector<Point>, std::vector<unsigned int>> & multi_point_list = _points[elem];
31 
32  const unsigned int npoint = multi_point_list.first.size();
33  mooseAssert(npoint == multi_point_list.second.size(),
34  "Different sizes for location and multiplicity data");
35 
36  for (unsigned int i = 0; i < npoint; ++i)
37  if (pointsFuzzyEqual(multi_point_list.first[i], p))
38  {
39  // a point at the same (within a tolerance) location as p exists, increase its multiplicity
40  multi_point_list.second[i]++;
41  return;
42  }
43 
44  // no prior point found at this location, add it with a multiplicity of one
45  multi_point_list.first.push_back(p);
46  multi_point_list.second.push_back(1);
47 }
std::set< const Elem * > _elements
The list of elements that need distributions.
MultiPointMap _points
The list of physical xyz Points that need to be evaluated in each element.
bool pointsFuzzyEqual(const Point &, const Point &)
Check if two points are equal with respect to a tolerance.

◆ clearPoints()

void DiracKernelInfo::clearPoints ( )

Remove all of the current points and elements.

Definition at line 50 of file DiracKernelInfo.C.

Referenced by DisplacedProblem::clearDiracInfo(), FEProblemBase::clearDiracInfo(), and DiracKernel::clearPoints().

51 {
52  _elements.clear();
53  _points.clear();
54 }
std::set< const Elem * > _elements
The list of elements that need distributions.
MultiPointMap _points
The list of physical xyz Points that need to be evaluated in each element.

◆ findPoint()

const Elem * DiracKernelInfo::findPoint ( Point  p,
const MooseMesh mesh 
)

Used by client DiracKernel classes to determine the Elem in which the Point p resides.

Uses the PointLocator owned by this object.

Definition at line 110 of file DiracKernelInfo.C.

Referenced by DiracKernel::addPoint(), and DiracKernel::addPointWithValidId().

111 {
112  // If the PointLocator has never been created, do so now. NOTE - WE
113  // CAN'T DO THIS if findPoint() is only called on some processors,
114  // PointLocatorBase::build() is a 'parallel_only' method!
115  if (_point_locator.get() == NULL)
116  {
117  _point_locator = PointLocatorBase::build(TREE_LOCAL_ELEMENTS, mesh);
118  _point_locator->enable_out_of_mesh_mode();
119  }
120 
121  // Check that the PointLocator is ready to start locating points.
122  // So far I do not have any tests that trip this...
123  if (_point_locator->initialized() == false)
124  mooseError("Error, PointLocator is not initialized!");
125 
126  // Note: The PointLocator object returns NULL when the Point is not
127  // found within the Mesh. This is not considered to be an error as
128  // far as the DiracKernels are concerned: sometimes the Mesh moves
129  // out from the Dirac point entirely and in that case the Point just
130  // gets "deactivated".
131  const Elem * elem = (*_point_locator)(p);
132 
133  // The processors may not agree on which Elem the point is in. This
134  // can happen if a Dirac point lies on the processor boundary, and
135  // two or more neighboring processors think the point is in the Elem
136  // on *their* side.
137  dof_id_type elem_id = elem ? elem->id() : DofObject::invalid_id;
138 
139  // We are going to let the element with the smallest ID "win", all other
140  // procs will return NULL.
141  dof_id_type min_elem_id = elem_id;
142  mesh.comm().min(min_elem_id);
143 
144  return min_elem_id == elem_id ? elem : NULL;
145 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:208
std::unique_ptr< PointLocatorBase > _point_locator
The DiracKernelInfo object manages a PointLocator object which is used by all DiracKernels to find Po...

◆ getElements()

std::set<const Elem *>& DiracKernelInfo::getElements ( )
inline

Returns a writeable reference to the _elements container.

Definition at line 64 of file DiracKernelInfo.h.

Referenced by DisplacedProblem::getDiracElements(), FEProblemBase::getDiracElements(), and DiracKernel::hasPointsOnElem().

64 { return _elements; }
std::set< const Elem * > _elements
The list of elements that need distributions.

◆ getPoints()

MultiPointMap& DiracKernelInfo::getPoints ( )
inline

Returns a writeable reference to the _points container.

Definition at line 72 of file DiracKernelInfo.h.

Referenced by DiracKernel::computeJacobian(), DiracKernel::computeOffDiagJacobian(), DiracKernel::computeResidual(), DisplacedProblem::reinitDirac(), and FEProblemBase::reinitDirac().

72 { return _points; }
MultiPointMap _points
The list of physical xyz Points that need to be evaluated in each element.

◆ hasPoint()

bool DiracKernelInfo::hasPoint ( const Elem *  elem,
Point  p 
)

Return true if we have Point 'p' in Element 'elem'.

Definition at line 57 of file DiracKernelInfo.C.

Referenced by DiracKernel::isActiveAtPoint().

58 {
59  std::vector<Point> & point_list = _points[elem].first;
60 
61  for (const auto & pt : point_list)
62  if (pointsFuzzyEqual(pt, p))
63  return true;
64 
65  // If we haven't found it, we don't have it.
66  return false;
67 }
MultiPointMap _points
The list of physical xyz Points that need to be evaluated in each element.
bool pointsFuzzyEqual(const Point &, const Point &)
Check if two points are equal with respect to a tolerance.

◆ pointsFuzzyEqual()

bool DiracKernelInfo::pointsFuzzyEqual ( const Point &  a,
const Point &  b 
)
protected

Check if two points are equal with respect to a tolerance.

Definition at line 148 of file DiracKernelInfo.C.

Referenced by addPoint(), and hasPoint().

149 {
150  const Real dist_sq = (a - b).norm_sq();
151  return dist_sq < _point_equal_distance_sq;
152 }
const Real _point_equal_distance_sq
threshold distance squared below which two points are considered identical

◆ updatePointLocator()

void DiracKernelInfo::updatePointLocator ( const MooseMesh mesh)

Called during FEProblemBase::meshChanged() to update the PointLocator object used by the DiracKernels.

Definition at line 70 of file DiracKernelInfo.C.

Referenced by DisplacedProblem::meshChanged(), FEProblemBase::meshChangedHelper(), and DisplacedProblem::updateMesh().

71 {
72  // Note: we could update the PointLocator *every* time we call this
73  // function, but that may introduce an unacceptable overhead in
74  // problems which don't need a PointLocator at all. This issue will
75  // most likely become a moot point when we eventually add a shared
76  // "CachingPointLocator" to MOOSE.
77  // _point_locator = PointLocatorBase::build(TREE_LOCAL_ELEMENTS, mesh);
78 
79  // Construct the PointLocator object if *any* processors have Dirac
80  // points. Note: building a PointLocator object is a parallel_only()
81  // function, so this is an all-or-nothing thing.
82  unsigned pl_needs_rebuild = _elements.size();
83  mesh.comm().max(pl_needs_rebuild);
84 
85  if (pl_needs_rebuild)
86  {
87  // PointLocatorBase::build() is a parallel_only function! So we
88  // can't skip building it just becuase our local _elements is
89  // empty, it might be non-empty on some other processor!
90  _point_locator = PointLocatorBase::build(TREE_LOCAL_ELEMENTS, mesh);
91 
92  // We may be querying for points which are not in the semilocal
93  // part of a distributed mesh.
94  _point_locator->enable_out_of_mesh_mode();
95  }
96  else
97  {
98  // There are no elements with Dirac points, but we have been
99  // requested to update the PointLocator so we have to assume the
100  // old one is invalid. Therefore we reset it to NULL... however
101  // adding this line causes the code to hang because it triggers
102  // the PointLocator to be rebuilt in a non-parallel-only segment
103  // of the code later... so it's commented out for now even though
104  // it's probably the right behavior.
105  // _point_locator.reset(NULL);
106  }
107 }
std::set< const Elem * > _elements
The list of elements that need distributions.
std::unique_ptr< PointLocatorBase > _point_locator
The DiracKernelInfo object manages a PointLocator object which is used by all DiracKernels to find Po...

Member Data Documentation

◆ _elements

std::set<const Elem *> DiracKernelInfo::_elements
protected

The list of elements that need distributions.

Definition at line 93 of file DiracKernelInfo.h.

Referenced by addPoint(), clearPoints(), getElements(), and updatePointLocator().

◆ _point_equal_distance_sq

const Real DiracKernelInfo::_point_equal_distance_sq
protected

threshold distance squared below which two points are considered identical

Definition at line 105 of file DiracKernelInfo.h.

Referenced by pointsFuzzyEqual().

◆ _point_locator

std::unique_ptr<PointLocatorBase> DiracKernelInfo::_point_locator
protected

The DiracKernelInfo object manages a PointLocator object which is used by all DiracKernels to find Points.

It needs to be centrally managed and it also needs to be rebuilt in FEProblemBase::meshChanged() to work with Mesh adaptivity.

Definition at line 102 of file DiracKernelInfo.h.

Referenced by findPoint(), and updatePointLocator().

◆ _points

MultiPointMap DiracKernelInfo::_points
protected

The list of physical xyz Points that need to be evaluated in each element.

Definition at line 96 of file DiracKernelInfo.h.

Referenced by addPoint(), clearPoints(), getPoints(), and hasPoint().


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