GeometricSearchInterface Class Reference

#include <GeometricSearchInterface.h>

Inheritance diagram for GeometricSearchInterface:

Public Member Functions
	GeometricSearchInterface (const MooseObject *moose_object)
PenetrationLocator &	getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the PentrationLocator associated with the two sides. More...
PenetrationLocator &	getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
	Retrieve the Quadrature PentrationLocator associated with the two sides. More...
NearestNodeLocator &	getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
	Retrieve the PentrationLocator 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()

GeometricSearchInterface::GeometricSearchInterface

(

const MooseObject *

moose_object

)

Definition at line 26 of file GeometricSearchInterface.C.

  : _geometric_search_data(moose_object->parameters()
                               .getCheckedPointerParam<SubProblem *>("_subproblem")
                               ->geomSearchData()),
    _requires_geometric_search(false)
{
}

Member Function Documentation

getNearestNodeLocator()

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

Retrieve the PentrationLocator associated with the two sides.

Definition at line 53 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 PentrationLocator associated with the two sides.

Definition at line 35 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 61 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 PentrationLocator associated with the two sides.

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

Definition at line 44 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 65 of file GeometricSearchInterface.h.

{ return _requires_geometric_search; }

validParams()

InputParameters GeometricSearchInterface::validParams ( )

static

Definition at line 21 of file GeometricSearchInterface.C.

Referenced by FVInterfaceKernel::validParams().

{
  return emptyInputParameters();
}

Member Data Documentation

_geometric_search_data

GeometricSearchData& GeometricSearchInterface::_geometric_search_data

protected

Definition at line 68 of file GeometricSearchInterface.h.

Referenced by 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 72 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