GrainDistance Struct Reference

This struct is used to hold distance information to other grains in the simulation. More...

#include <GrainTracker.h>

Public Member Functions
	GrainDistance (Real distance, std::size_t var_index)
	GrainDistance (Real distance, std::size_t var_index, std::size_t grain_index, unsigned int grain_id)
	GrainDistance (const GrainDistance &f)=default
GrainDistance &	operator= (const GrainDistance &f)=default
	GrainDistance (GrainDistance &&f)=default
GrainDistance &	operator= (GrainDistance &&f)=default
bool	operator< (const GrainDistance &rhs) const

Public Attributes
Real	_distance
std::size_t	_var_index
std::size_t	_grain_index
unsigned int	_grain_id

Detailed Description

This struct is used to hold distance information to other grains in the simulation.

It is used for sorting and during the remapping algorithm.

Definition at line 257 of file GrainTracker.h.

Constructor & Destructor Documentation

GrainDistance() [1/4]

GrainDistance::GrainDistance	(	Real	distance,
		std::size_t	var_index
	)

Definition at line 1804 of file GrainTracker.C.

  : GrainDistance(distance,
                  var_index,
                  std::numeric_limits<std::size_t>::max(),
                  std::numeric_limits<unsigned int>::max())
{
}

GrainDistance() [2/4]

GrainDistance::GrainDistance	(	Real	distance,
		std::size_t	var_index,
		std::size_t	grain_index,
		unsigned int	grain_id
	)

Definition at line 1812 of file GrainTracker.C.

  : _distance(distance), _var_index(var_index), _grain_index(grain_index), _grain_id(grain_id)
{
}

GrainDistance() [3/4]

GrainDistance::GrainDistance ( const GrainDistance &  f )

default

GrainDistance() [4/4]

GrainDistance::GrainDistance ( GrainDistance &&  f )

default

Member Function Documentation

operator<()

bool GrainDistance::operator<

(

const GrainDistance &

rhs

)

const

Definition at line 1820 of file GrainTracker.C.

{
  return _distance < rhs._distance;
}

operator=() [1/2]

GrainDistance & GrainDistance::operator= ( const GrainDistance &  f )

default

operator=() [2/2]

GrainDistance & GrainDistance::operator= ( GrainDistance &&  f )

default

Member Data Documentation

_distance

Real GrainDistance::_distance

Definition at line 276 of file GrainTracker.h.

Referenced by GrainTracker::computeMinDistancesFromGrain(), and operator<().

_grain_id

unsigned int GrainDistance::_grain_id

Definition at line 279 of file GrainTracker.h.

_grain_index

std::size_t GrainDistance::_grain_index

Definition at line 278 of file GrainTracker.h.

_var_index

std::size_t GrainDistance::_var_index

Definition at line 277 of file GrainTracker.h.

---

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

• phase_field/include/postprocessors/GrainTracker.h
• phase_field/src/postprocessors/GrainTracker.C