GeometricSearchInterface Class Reference

#include <GeometricSearchInterface.h>

Inheritance diagram for GeometricSearchInterface:

Public Member Functions
	GeometricSearchInterface (const MooseObject *moose_object)
	GeometricSearchInterface (const GeometricSearchInterface &object, const Moose::Kokkos::FunctorCopy &key)
	Special constructor used for Kokkos functor copy during parallel dispatch. More...
PenetrationLocator &	getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the PenetrationLocator associated with the two sides. More...
PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the Quadrature PenetrationLocator associated with the two sides. More...
NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve the PenetrationLocator associated with the two sides. More...
NearestNodeLocator &	getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve a Quadrature NearestNodeLocator associated with the two sides. More...
bool	requiresGeometricSearch () const
	Whether any of this interface's methods have been called, e.g. More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
GeometricSearchData &	_geometric_search_data
bool	_requires_geometric_search
	Whether any of this interface's methods have been called, e.g. More...

Detailed Description

Definition at line 23 of file GeometricSearchInterface.h.

Constructor & Destructor Documentation

GeometricSearchInterface() [1/2]

GeometricSearchInterface::GeometricSearchInterface

(

const MooseObject *

moose_object

)

Definition at line 47 of file GeometricSearchInterface.C.

  : _geometric_search_data(moose_object->parameters()
                               .getCheckedPointerParam<SubProblem *>("_subproblem")
                               ->geomSearchData()),
    _requires_geometric_search(false)
{
  if (moose_object->getParam<MooseEnum>("search_method") == "all_proximate_sides")
    _geometric_search_data.setSearchUsingPointLocator(true);
}

GeometricSearchInterface() [2/2]

GeometricSearchInterface::GeometricSearchInterface	(	const GeometricSearchInterface &	object,
		const Moose::Kokkos::FunctorCopy &	key
	)

Special constructor used for Kokkos functor copy during parallel dispatch.

Definition at line 58 of file GeometricSearchInterface.C.

  : _geometric_search_data(object._geometric_search_data),
    _requires_geometric_search(object._requires_geometric_search)
{
}

Member Function Documentation

getNearestNodeLocator()

NearestNodeLocator & GeometricSearchInterface::getNearestNodeLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary
	)

Retrieve the PenetrationLocator associated with the two sides.

Definition at line 85 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getNearestNodeLocator(primary, secondary);
}

getPenetrationLocator()

PenetrationLocator & GeometricSearchInterface::getPenetrationLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary,
		Order	order
	)

Retrieve the PenetrationLocator associated with the two sides.

Definition at line 67 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getPenetrationLocator(primary, secondary, order);
}

getQuadratureNearestNodeLocator()

NearestNodeLocator & GeometricSearchInterface::getQuadratureNearestNodeLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary
	)

Retrieve a Quadrature NearestNodeLocator associated with the two sides.

A "Quadrature" version means that it's going to find the nearest nodes to each quadrature point on this boundary

Definition at line 93 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getQuadratureNearestNodeLocator(primary, secondary);
}

getQuadraturePenetrationLocator()

PenetrationLocator & GeometricSearchInterface::getQuadraturePenetrationLocator	(	const BoundaryName &	primary,
		const BoundaryName &	secondary,
		Order	order
	)

Retrieve the Quadrature PenetrationLocator associated with the two sides.

A "Quadrature" version means that it's going to find the penetration of each quadrature point on this boundary

Definition at line 76 of file GeometricSearchInterface.C.

{
  _requires_geometric_search = true;
  return _geometric_search_data.getQuadraturePenetrationLocator(primary, secondary, order);
}

requiresGeometricSearch()

bool GeometricSearchInterface::requiresGeometricSearch ( ) const

inline

Whether any of this interface's methods have been called, e.g.

whether the object that this interface is for requires geometric search data

Definition at line 73 of file GeometricSearchInterface.h.

{ return _requires_geometric_search; }

validParams()

InputParameters GeometricSearchInterface::validParams ( )

static

Definition at line 21 of file GeometricSearchInterface.C.

Referenced by Constraint::validParams(), KernelBase::validParams(), DiracKernelBase::validParams(), BoundaryCondition::validParams(), NodalKernelBase::validParams(), AuxKernelBase::validParams(), LinearFVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), FVBoundaryCondition::validParams(), and MaterialBase::validParams().

{
  InputParameters params = emptyInputParameters();

  MooseEnum search_methods("nearest_node_connected_sides all_proximate_sides",
                           "nearest_node_connected_sides");

  params.addParam<MooseEnum>(
      "search_method",
      search_methods,
      "Choice of search algorithm.  All options begin by finding the nearest node in the "
      "primary boundary to a query point in the secondary boundary.  In the default "
      "nearest_node_connected_sides algorithm, primary boundary elements are searched iff "
      "that nearest node is one of their nodes.  This is fast to determine via a "
      "pregenerated node-to-elem map and is robust on conforming meshes.  In the optional "
      "all_proximate_sides algorithm, primary boundary elements are searched iff they touch "
      "that nearest node, even if they are not topologically connected to it.  This is "
      "more CPU-intensive but is necessary for robustness on any boundary surfaces which "
      "has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes "
      "in adaptively h-refined meshes).");

  params.addParamNamesToGroup("search_method", "Advanced");

  return params;
}

Member Data Documentation

_geometric_search_data

GeometricSearchData& GeometricSearchInterface::_geometric_search_data

protected

Definition at line 76 of file GeometricSearchInterface.h.

Referenced by GeometricSearchInterface(), getNearestNodeLocator(), getPenetrationLocator(), getQuadratureNearestNodeLocator(), and getQuadraturePenetrationLocator().

_requires_geometric_search

bool GeometricSearchInterface::_requires_geometric_search

protected

Whether any of this interface's methods have been called, e.g.

whether the object that this interface is for requires geometric search data

Definition at line 80 of file GeometricSearchInterface.h.

Referenced by getNearestNodeLocator(), getPenetrationLocator(), getQuadratureNearestNodeLocator(), getQuadraturePenetrationLocator(), and requiresGeometricSearch().

---

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

• include/geomsearch/GeometricSearchInterface.h
• src/geomsearch/GeometricSearchInterface.C