www.mooseframework.org
Public Member Functions | List of all members
GrainTrackerHaloRM Class Reference

GrainTrackerHaloRM is used to ensure a level of elements at least as thick as the desired halo level is available on each processor's partition to support detecting grain interaction. More...

#include <GrainTrackerHaloRM.h>

Inheritance diagram for GrainTrackerHaloRM:
[legend]

Public Member Functions

 GrainTrackerHaloRM (const InputParameters &parameters)
 
virtual std::string getInfo () const override
 

Detailed Description

GrainTrackerHaloRM is used to ensure a level of elements at least as thick as the desired halo level is available on each processor's partition to support detecting grain interaction.

Definition at line 25 of file GrainTrackerHaloRM.h.

Constructor & Destructor Documentation

◆ GrainTrackerHaloRM()

GrainTrackerHaloRM::GrainTrackerHaloRM ( const InputParameters &  parameters)

Definition at line 31 of file GrainTrackerHaloRM.C.

32  : ElementPointNeighbors(parameters)
33 {
34  // The grain tracker halo algorithm requires at least as many element neighbors as the required
35  // halo level (See GrainTrackerInterface)
36  _element_point_neighbor_layers = getParam<unsigned short>("halo_level");
37 }

Member Function Documentation

◆ getInfo()

std::string GrainTrackerHaloRM::getInfo ( ) const
overridevirtual

Definition at line 40 of file GrainTrackerHaloRM.C.

41 {
42  if (_point_coupling)
43  {
44  std::ostringstream oss;
45  oss << "GrainTrackerHaloRM (" << _element_point_neighbor_layers << " layers)";
46  return oss.str();
47  }
48  return "";
49 }

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