GrainAdvectionVelocity Class Reference

This Material calculates the advection velocity, it's divergence and derivatives acting on a particle/grain. More...

#include <GrainAdvectionVelocity.h>

Inheritance diagram for GrainAdvectionVelocity:

Public Member Functions
	GrainAdvectionVelocity (const InputParameters &parameters)

Protected Member Functions
virtual void	computeQpProperties ()

Protected Attributes
const GrainTrackerInterface &	_grain_tracker
	getting userobject for calculating grain centers and volumes More...
const GrainForceAndTorqueInterface &	_grain_force_torque
	getting userobject for calculating grain forces and torques More...
const VectorPostprocessorValue &	_grain_volumes
	The grain volumes. 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...
const unsigned int	_op_num
const std::string	_base_name
	type of force density material More...
MaterialProperty< std::vector< RealGradient > > &	_velocity_advection
	Material storing advection velocities of grains. More...

Detailed Description

This Material calculates the advection velocity, it's divergence and derivatives acting on a particle/grain.

Definition at line 27 of file GrainAdvectionVelocity.h.

Constructor & Destructor Documentation

GrainAdvectionVelocity()

GrainAdvectionVelocity::GrainAdvectionVelocity

(

const InputParameters &

parameters

)

Definition at line 39 of file GrainAdvectionVelocity.C.

  : DerivativeMaterialInterface<Material>(parameters),
    _grain_tracker(getUserObject<GrainTrackerInterface>("grain_data")),
    _grain_force_torque(getUserObject<GrainForceAndTorqueInterface>("grain_force")),
    _grain_volumes(getVectorPostprocessorValue("grain_volumes", "feature_volumes")),
    _grain_forces(_grain_force_torque.getForceValues()),
    _grain_torques(_grain_force_torque.getTorqueValues()),
    _mt(getParam<Real>("translation_constant")),
    _mr(getParam<Real>("rotation_constant")),
    _op_num(coupledComponents("etas")),
    _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
    _velocity_advection(
        declareProperty<std::vector<RealGradient>>(_base_name + "advection_velocity"))
{
  mooseDeprecated("Use GrainAdvectionAux for visualizing advection velocities.");
}

Member Function Documentation

computeQpProperties()

void GrainAdvectionVelocity::computeQpProperties ( )

protectedvirtual

Definition at line 57 of file GrainAdvectionVelocity.C.

{
  auto grain_num = _grain_tracker.getTotalFeatureCount();
  const auto & op_to_grains = _grain_tracker.getVarToFeatureVector(_current_elem->id());
 
  _velocity_advection[_qp].resize(grain_num);
 
  for (unsigned int i = 0; i < _grain_volumes.size(); ++i)
  {
    mooseAssert(i < _grain_volumes.size(), "grain index is out of bounds");
    const auto volume = _grain_volumes[i];
    const auto centroid = _grain_tracker.getGrainCentroid(i);
 
    for (unsigned int j = 0; j < _op_num; ++j)
      if (i == op_to_grains[j])
      {
        const RealGradient velocity_translation = _mt / volume * _grain_forces[i];
        const RealGradient velocity_rotation =
            _mr / volume * (_grain_torques[i].cross(_current_elem->centroid() - centroid));
 
        _velocity_advection[_qp][i] = velocity_translation + velocity_rotation;
      }
  }
}

Member Data Documentation

_base_name

const std::string GrainAdvectionVelocity::_base_name

private

type of force density material

Definition at line 56 of file GrainAdvectionVelocity.h.

_grain_force_torque

const GrainForceAndTorqueInterface& GrainAdvectionVelocity::_grain_force_torque

protected

getting userobject for calculating grain forces and torques

Definition at line 39 of file GrainAdvectionVelocity.h.

_grain_forces

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

protected

Definition at line 44 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_grain_torques

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

protected

Definition at line 45 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_grain_tracker

const GrainTrackerInterface& GrainAdvectionVelocity::_grain_tracker

protected

getting userobject for calculating grain centers and volumes

Definition at line 36 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_grain_volumes

const VectorPostprocessorValue& GrainAdvectionVelocity::_grain_volumes

protected

The grain volumes.

Definition at line 42 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_mr

const Real GrainAdvectionVelocity::_mr

private

constant value corresponding to grain rotation

Definition at line 51 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_mt

const Real GrainAdvectionVelocity::_mt

private

constant value corresponding to grain translation

Definition at line 49 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_op_num

const unsigned int GrainAdvectionVelocity::_op_num

private

Definition at line 53 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

_velocity_advection

MaterialProperty<std::vector<RealGradient> >& GrainAdvectionVelocity::_velocity_advection

private

Material storing advection velocities of grains.

Definition at line 59 of file GrainAdvectionVelocity.h.

Referenced by computeQpProperties().

---

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

• phase_field/include/materials/GrainAdvectionVelocity.h
• phase_field/src/materials/GrainAdvectionVelocity.C