GrainAdvectionAux Class Reference

Calculates the advection velocity of grain due to rigid body motion Reports the components of the velocity on each element. More...

#include <GrainAdvectionAux.h>

Inheritance diagram for GrainAdvectionAux:

Public Member Functions
	GrainAdvectionAux (const InputParameters &parameters)

Protected Member Functions
virtual void	precalculateValue ()
	calculate the advection velocity More...
virtual Real	computeValue ()
	output the component of advection velocity More...

Protected Attributes
const GrainTrackerInterface &	_grain_tracker
	getting userobject for calculating grain centers and volumes More...
const VectorPostprocessorValue &	_grain_volumes
	The grain volumes. More...
const GrainForceAndTorqueInterface &	_grain_force_torque
	getting userobject for calculating grain forces and torques More...
const std::vector< RealGradient > &	_grain_forces
const std::vector< RealGradient > &	_grain_torques

Private Attributes
const Real	_mt
	constant value corresponding to grain translation More...
const Real	_mr
	constant value corresponding to grain rotation More...
RealGradient	_velocity_advection
MooseEnum	_component

Detailed Description

Calculates the advection velocity of grain due to rigid body motion Reports the components of the velocity on each element.

Definition at line 26 of file GrainAdvectionAux.h.

Constructor & Destructor Documentation

GrainAdvectionAux()

GrainAdvectionAux::GrainAdvectionAux

(

const InputParameters &

parameters

)

Definition at line 35 of file GrainAdvectionAux.C.

  : AuxKernel(parameters),
    _grain_tracker(getUserObject<GrainTrackerInterface>("grain_tracker_object")),
    _grain_volumes(getVectorPostprocessorValue("grain_volumes", "feature_volumes")),
    _grain_force_torque(getUserObject<GrainForceAndTorqueInterface>("grain_force")),
    _grain_forces(_grain_force_torque.getForceValues()),
    _grain_torques(_grain_force_torque.getTorqueValues()),
    _mt(getParam<Real>("translation_constant")),
    _mr(getParam<Real>("rotation_constant")),
    _component(getParam<MooseEnum>("component"))
{
  if (isNodal())
    mooseError("Advection velocity can be assigned to elemental variables only.");
}

Member Function Documentation

computeValue()

Real GrainAdvectionAux::computeValue ( )

protectedvirtual

output the component of advection velocity

Definition at line 72 of file GrainAdvectionAux.C.

{
  return _velocity_advection(_component);
}

precalculateValue()

void GrainAdvectionAux::precalculateValue ( )

protectedvirtual

calculate the advection velocity

Definition at line 51 of file GrainAdvectionAux.C.

{
  // ID of unique grain at current point
  const auto grain_id = _grain_tracker.getEntityValue(
      _current_elem->id(), FeatureFloodCount::FieldType::UNIQUE_REGION, 0);
  if (grain_id >= 0)
  {
    mooseAssert(grain_id < _grain_volumes.size(), "grain index is out of bounds");
    const auto volume = _grain_volumes[grain_id];
    const auto centroid = _grain_tracker.getGrainCentroid(grain_id);
 
    const RealGradient velocity_translation = _mt / volume * _grain_forces[grain_id];
    const RealGradient velocity_rotation =
        _mr / volume * (_grain_torques[grain_id].cross(_current_elem->centroid() - centroid));
    _velocity_advection = velocity_translation + velocity_rotation;
  }
  else
    _velocity_advection.zero();
}

Member Data Documentation

_component

MooseEnum GrainAdvectionAux::_component

private

Definition at line 56 of file GrainAdvectionAux.h.

Referenced by computeValue().

_grain_force_torque

const GrainForceAndTorqueInterface& GrainAdvectionAux::_grain_force_torque

protected

getting userobject for calculating grain forces and torques

Definition at line 44 of file GrainAdvectionAux.h.

_grain_forces

const std::vector<RealGradient>& GrainAdvectionAux::_grain_forces

protected

Definition at line 45 of file GrainAdvectionAux.h.

Referenced by precalculateValue().

_grain_torques

const std::vector<RealGradient>& GrainAdvectionAux::_grain_torques

protected

Definition at line 46 of file GrainAdvectionAux.h.

Referenced by precalculateValue().

_grain_tracker

const GrainTrackerInterface& GrainAdvectionAux::_grain_tracker

protected

getting userobject for calculating grain centers and volumes

Definition at line 38 of file GrainAdvectionAux.h.

Referenced by precalculateValue().

_grain_volumes

const VectorPostprocessorValue& GrainAdvectionAux::_grain_volumes

protected

The grain volumes.

Definition at line 41 of file GrainAdvectionAux.h.

Referenced by precalculateValue().

_mr

const Real GrainAdvectionAux::_mr

private

constant value corresponding to grain rotation

Definition at line 53 of file GrainAdvectionAux.h.

Referenced by precalculateValue().

_mt

const Real GrainAdvectionAux::_mt

private

constant value corresponding to grain translation

Definition at line 50 of file GrainAdvectionAux.h.

Referenced by precalculateValue().

_velocity_advection

RealGradient GrainAdvectionAux::_velocity_advection

private

Definition at line 55 of file GrainAdvectionAux.h.

Referenced by computeValue(), and precalculateValue().

---

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

• phase_field/include/auxkernels/GrainAdvectionAux.h
• phase_field/src/auxkernels/GrainAdvectionAux.C