#include <SingleGrainRigidBodyMotion.h>

Inheritance diagram for SingleGrainRigidBodyMotion:

Public Member Functions
	SingleGrainRigidBodyMotion (const InputParameters &parameters)

virtual void	timestepSetup ()

Protected Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int)

virtual Real	computeQpNonlocalJacobian (dof_id_type)

virtual Real	computeQpNonlocalOffDiagJacobian (unsigned int, dof_id_type)

virtual void	calculateAdvectionVelocity ()

virtual void	getUserObjectJacobian (unsigned int jvar, dof_id_type dof_index)

virtual bool	globalDoFEnabled (MooseVariableFEBase &, dof_id_type)

virtual void	precalculateResidual ()

virtual void	precalculateJacobian ()

virtual void	precalculateOffDiagJacobian (unsigned int jvar)

Protected Attributes
unsigned int	_op_index
	Grain number for the kernel to be applied. More...

const std::vector< dof_id_type > &	_var_dofs
	Variable's local dof indices. More...

unsigned int	_c_var
	int label for the Concentration More...

const VariableValue &	_c
	Variable value for the concentration. More...

const VariableGradient &	_grad_c
	Variable gradient for the concentration. More...

const std::vector< dof_id_type > &	_c_dofs
	local dof indices of variable c More...

const unsigned int	_op_num
	no. of order parameters More...

std::vector< const VariableValue * >	_vals
	Variable value for the order parameters. More...

std::vector< unsigned int >	_vals_var

std::vector< const VariableGradient * >	_grad_vals

const std::string	_base_name
	base name specifying type of force density material 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

const std::vector< Real > &	_grain_force_c_jacobians

const std::vector< std::vector< Real > > &	_grain_force_eta_jacobians

const Real	_mt
	constant value corresponding to grain translation More...

const Real	_mr
	constant value corresponding to grain rotation More...

const GrainTrackerInterface &	_grain_tracker
	grain tracker object More...

const VectorPostprocessorValue &	_grain_volumes
	The grain volumes. More...

unsigned int	_total_dofs
	get the total no. of dofs in the system More...

RealGradient	_velocity_advection
	storing the advection velocity and corresponding jacobian entries calculated in userobjects More...

RealGradient	_velocity_advection_jacobian

std::vector< unsigned int >	_grain_ids
	obtain the active grain ids More...

Detailed Description

Definition at line 20 of file SingleGrainRigidBodyMotion.h.

Constructor & Destructor Documentation

◆ SingleGrainRigidBodyMotion()

SingleGrainRigidBodyMotion::SingleGrainRigidBodyMotion ( const InputParameters & parameters )

Definition at line 25 of file SingleGrainRigidBodyMotion.C.

   : GrainRigidBodyMotionBase(parameters), _op_index(getParam<unsigned int>("op_index"))
 {
 }

Member Function Documentation

◆ calculateAdvectionVelocity()

void SingleGrainRigidBodyMotion::calculateAdvectionVelocity ( )

protectedvirtual

Reimplemented from GrainRigidBodyMotionBase.

Definition at line 111 of file SingleGrainRigidBodyMotion.C.

 {
   _velocity_advection = 0.0;
   _grain_ids = _grain_tracker.getVarToFeatureVector(_current_elem->id());
  
   auto grain_id = _grain_ids[_op_index];
   if (grain_id != FeatureFloodCount::invalid_id)
   {
     mooseAssert(grain_id < _grain_volumes.size(), "grain_id out of bounds");
     const auto volume = _grain_volumes[grain_id];
     const auto centroid = _grain_tracker.getGrainCentroid(grain_id);
     const auto force = _mt / volume * _grain_forces[grain_id];
     const auto torque =
         _mr / volume * (_grain_torques[grain_id].cross(_current_elem->centroid() - centroid));
  
     _velocity_advection = (force + torque);
   }
 }

◆ computeQpJacobian()

Real SingleGrainRigidBodyMotion::computeQpJacobian ( )

protectedvirtual

Definition at line 37 of file SingleGrainRigidBodyMotion.C.

 {
   return _velocity_advection * _grad_phi[_j][_qp] * _test[_i][_qp] +
          _velocity_advection_jacobian * _grad_u[_qp] * _test[_i][_qp];
 }

◆ computeQpNonlocalJacobian()

Real SingleGrainRigidBodyMotion::computeQpNonlocalJacobian ( dof_id_type )

protectedvirtual

Definition at line 49 of file SingleGrainRigidBodyMotion.C.

 {
   return _velocity_advection_jacobian * _grad_u[_qp] * _test[_i][_qp];
 }

◆ computeQpNonlocalOffDiagJacobian()

Real SingleGrainRigidBodyMotion::computeQpNonlocalOffDiagJacobian	(	unsigned int	,
		dof_id_type
	)

protectedvirtual

Definition at line 55 of file SingleGrainRigidBodyMotion.C.

 {
   return _velocity_advection_jacobian * _grad_u[_qp] * _test[_i][_qp];
 }

◆ computeQpOffDiagJacobian()

Real SingleGrainRigidBodyMotion::computeQpOffDiagJacobian ( unsigned int )

protectedvirtual

Definition at line 44 of file SingleGrainRigidBodyMotion.C.

 {
   return _velocity_advection_jacobian * _grad_u[_qp] * _test[_i][_qp];
 }

◆ computeQpResidual()

Real SingleGrainRigidBodyMotion::computeQpResidual ( )

protectedvirtual

Definition at line 31 of file SingleGrainRigidBodyMotion.C.

 {
   return _velocity_advection * _grad_u[_qp] * _test[_i][_qp];
 }

◆ getUserObjectJacobian()

void SingleGrainRigidBodyMotion::getUserObjectJacobian	(	unsigned int	jvar,
		dof_id_type	dof_index
	)

protectedvirtual

Definition at line 62 of file SingleGrainRigidBodyMotion.C.

 {
   _velocity_advection_jacobian = 0.0;
  
   auto grain_id = _grain_ids[_op_index];
   if (grain_id != FeatureFloodCount::invalid_id)
   {
     mooseAssert(grain_id < _grain_volumes.size(), "grain_id out of bounds");
     const auto volume = _grain_volumes[grain_id];
     const auto centroid = _grain_tracker.getGrainCentroid(grain_id);
     RealGradient force_jacobian;
     RealGradient torque_jacobian;
  
     if (jvar == _c_var)
     {
       force_jacobian(0) = _grain_force_c_jacobians[(6 * grain_id + 0) * _total_dofs + dof_index];
       force_jacobian(1) = _grain_force_c_jacobians[(6 * grain_id + 1) * _total_dofs + dof_index];
       force_jacobian(2) = _grain_force_c_jacobians[(6 * grain_id + 2) * _total_dofs + dof_index];
       torque_jacobian(0) = _grain_force_c_jacobians[(6 * grain_id + 3) * _total_dofs + dof_index];
       torque_jacobian(1) = _grain_force_c_jacobians[(6 * grain_id + 4) * _total_dofs + dof_index];
       torque_jacobian(2) = _grain_force_c_jacobians[(6 * grain_id + 5) * _total_dofs + dof_index];
     }
  
     for (unsigned int jvar_index = 0; jvar_index < _op_num; ++jvar_index)
       if (jvar == _vals_var[jvar_index])
       {
         force_jacobian(0) =
             _grain_force_eta_jacobians[jvar_index][(6 * grain_id + 0) * _total_dofs + dof_index];
         force_jacobian(1) =
             _grain_force_eta_jacobians[jvar_index][(6 * grain_id + 1) * _total_dofs + dof_index];
         force_jacobian(2) =
             _grain_force_eta_jacobians[jvar_index][(6 * grain_id + 2) * _total_dofs + dof_index];
         torque_jacobian(0) =
             _grain_force_eta_jacobians[jvar_index][(6 * grain_id + 3) * _total_dofs + dof_index];
         torque_jacobian(1) =
             _grain_force_eta_jacobians[jvar_index][(6 * grain_id + 4) * _total_dofs + dof_index];
         torque_jacobian(2) =
             _grain_force_eta_jacobians[jvar_index][(6 * grain_id + 5) * _total_dofs + dof_index];
       }
  
     const auto force_jac = _mt / volume * force_jacobian;
     const auto torque_jac =
         _mr / volume * torque_jacobian.cross(_current_elem->centroid() - centroid);
  
     _velocity_advection_jacobian = (force_jac + torque_jac);
   }
 }

◆ globalDoFEnabled()

bool GrainRigidBodyMotionBase::globalDoFEnabled	(	MooseVariableFEBase &	,
		dof_id_type
	)

protectedvirtualinherited

Definition at line 78 of file GrainRigidBodyMotionBase.C.

 {
   if (_velocity_advection_jacobian(0) == 0 && _velocity_advection_jacobian(1) == 0 &&
       _velocity_advection_jacobian(2) == 0)
     return false;
  
   return true;
 }

◆ precalculateJacobian()

void GrainRigidBodyMotionBase::precalculateJacobian ( )

protectedvirtualinherited

Definition at line 94 of file GrainRigidBodyMotionBase.C.

 {
   calculateAdvectionVelocity();
 }

◆ precalculateOffDiagJacobian()

void GrainRigidBodyMotionBase::precalculateOffDiagJacobian ( unsigned int jvar )

protectedvirtualinherited

Definition at line 100 of file GrainRigidBodyMotionBase.C.

 {
   calculateAdvectionVelocity();
 }

◆ precalculateResidual()

void GrainRigidBodyMotionBase::precalculateResidual ( )

protectedvirtualinherited

Definition at line 88 of file GrainRigidBodyMotionBase.C.

 {
   calculateAdvectionVelocity();
 }

◆ timestepSetup()

void GrainRigidBodyMotionBase::timestepSetup ( )

virtualinherited

Definition at line 72 of file GrainRigidBodyMotionBase.C.

 {
   _total_dofs = _subproblem.es().n_dofs();
 }

Member Data Documentation

◆ _base_name

const std::string GrainRigidBodyMotionBase::_base_name

protectedinherited

base name specifying type of force density material

Definition at line 59 of file GrainRigidBodyMotionBase.h.

◆ _c

const VariableValue& GrainRigidBodyMotionBase::_c

protectedinherited

Variable value for the concentration.

Definition at line 45 of file GrainRigidBodyMotionBase.h.

◆ _c_dofs

const std::vector<dof_id_type>& GrainRigidBodyMotionBase::_c_dofs

protectedinherited

local dof indices of variable c

Definition at line 49 of file GrainRigidBodyMotionBase.h.

◆ _c_var

unsigned int GrainRigidBodyMotionBase::_c_var

protectedinherited

int label for the Concentration

Definition at line 43 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::computeQpJacobian(), MultiGrainRigidBodyMotion::computeQpNonlocalJacobian(), MultiGrainRigidBodyMotion::computeQpOffDiagJacobian(), getUserObjectJacobian(), and MultiGrainRigidBodyMotion::getUserObjectJacobian().

◆ _grad_c

const VariableGradient& GrainRigidBodyMotionBase::_grad_c

protectedinherited

Variable gradient for the concentration.

Definition at line 47 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::computeQpJacobian(), MultiGrainRigidBodyMotion::computeQpNonlocalJacobian(), MultiGrainRigidBodyMotion::computeQpNonlocalOffDiagJacobian(), MultiGrainRigidBodyMotion::computeQpOffDiagJacobian(), and MultiGrainRigidBodyMotion::computeQpResidual().

◆ _grad_vals

std::vector<const VariableGradient *> GrainRigidBodyMotionBase::_grad_vals

protectedinherited

Definition at line 56 of file GrainRigidBodyMotionBase.h.

Referenced by GrainRigidBodyMotionBase::GrainRigidBodyMotionBase().

◆ _grain_force_c_jacobians

const std::vector<Real>& GrainRigidBodyMotionBase::_grain_force_c_jacobians

protectedinherited

Definition at line 65 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::getUserObjectJacobian(), and getUserObjectJacobian().

◆ _grain_force_eta_jacobians

const std::vector<std::vector<Real> >& GrainRigidBodyMotionBase::_grain_force_eta_jacobians

protectedinherited

Definition at line 66 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::getUserObjectJacobian(), and getUserObjectJacobian().

◆ _grain_force_torque

const GrainForceAndTorqueInterface& GrainRigidBodyMotionBase::_grain_force_torque

protectedinherited

getting userobject for calculating grain forces and torques

Definition at line 62 of file GrainRigidBodyMotionBase.h.

◆ _grain_forces

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

protectedinherited

Definition at line 63 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), and calculateAdvectionVelocity().

◆ _grain_ids

std::vector<unsigned int> GrainRigidBodyMotionBase::_grain_ids

protectedinherited

obtain the active grain ids

Definition at line 86 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), calculateAdvectionVelocity(), getUserObjectJacobian(), and MultiGrainRigidBodyMotion::getUserObjectJacobian().

◆ _grain_torques

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

protectedinherited

Definition at line 64 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), and calculateAdvectionVelocity().

◆ _grain_tracker

const GrainTrackerInterface& GrainRigidBodyMotionBase::_grain_tracker

protectedinherited

grain tracker object

Definition at line 74 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), calculateAdvectionVelocity(), getUserObjectJacobian(), and MultiGrainRigidBodyMotion::getUserObjectJacobian().

◆ _grain_volumes

const VectorPostprocessorValue& GrainRigidBodyMotionBase::_grain_volumes

protectedinherited

The grain volumes.

Definition at line 77 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), calculateAdvectionVelocity(), getUserObjectJacobian(), and MultiGrainRigidBodyMotion::getUserObjectJacobian().

◆ _mr

const Real GrainRigidBodyMotionBase::_mr

protectedinherited

constant value corresponding to grain rotation

Definition at line 71 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), calculateAdvectionVelocity(), getUserObjectJacobian(), and MultiGrainRigidBodyMotion::getUserObjectJacobian().

◆ _mt

const Real GrainRigidBodyMotionBase::_mt

protectedinherited

constant value corresponding to grain translation

Definition at line 69 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), calculateAdvectionVelocity(), getUserObjectJacobian(), and MultiGrainRigidBodyMotion::getUserObjectJacobian().

◆ _op_index

unsigned int SingleGrainRigidBodyMotion::_op_index

protected

Grain number for the kernel to be applied.

Definition at line 37 of file SingleGrainRigidBodyMotion.h.

Referenced by calculateAdvectionVelocity(), and getUserObjectJacobian().

◆ _op_num

const unsigned int GrainRigidBodyMotionBase::_op_num

protectedinherited

no. of order parameters

Definition at line 52 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::getUserObjectJacobian(), getUserObjectJacobian(), and GrainRigidBodyMotionBase::GrainRigidBodyMotionBase().

◆ _total_dofs

unsigned int GrainRigidBodyMotionBase::_total_dofs

protectedinherited

get the total no. of dofs in the system

Definition at line 80 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::getUserObjectJacobian(), getUserObjectJacobian(), and GrainRigidBodyMotionBase::timestepSetup().

◆ _vals

std::vector<const VariableValue *> GrainRigidBodyMotionBase::_vals

protectedinherited

Variable value for the order parameters.

Definition at line 54 of file GrainRigidBodyMotionBase.h.

Referenced by GrainRigidBodyMotionBase::GrainRigidBodyMotionBase().

◆ _vals_var

std::vector<unsigned int> GrainRigidBodyMotionBase::_vals_var

protectedinherited

Definition at line 55 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::getUserObjectJacobian(), getUserObjectJacobian(), and GrainRigidBodyMotionBase::GrainRigidBodyMotionBase().

◆ _var_dofs

const std::vector<dof_id_type>& GrainRigidBodyMotionBase::_var_dofs

protectedinherited

Variable's local dof indices.

Definition at line 40 of file GrainRigidBodyMotionBase.h.

◆ _velocity_advection

RealGradient GrainRigidBodyMotionBase::_velocity_advection

protectedinherited

storing the advection velocity and corresponding jacobian entries calculated in userobjects

Definition at line 83 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::calculateAdvectionVelocity(), calculateAdvectionVelocity(), MultiGrainRigidBodyMotion::computeQpJacobian(), computeQpJacobian(), MultiGrainRigidBodyMotion::computeQpOffDiagJacobian(), computeQpResidual(), and MultiGrainRigidBodyMotion::computeQpResidual().

◆ _velocity_advection_jacobian

RealGradient GrainRigidBodyMotionBase::_velocity_advection_jacobian

protectedinherited

Definition at line 84 of file GrainRigidBodyMotionBase.h.

Referenced by MultiGrainRigidBodyMotion::computeQpJacobian(), computeQpJacobian(), MultiGrainRigidBodyMotion::computeQpNonlocalJacobian(), computeQpNonlocalJacobian(), computeQpNonlocalOffDiagJacobian(), MultiGrainRigidBodyMotion::computeQpNonlocalOffDiagJacobian(), computeQpOffDiagJacobian(), MultiGrainRigidBodyMotion::computeQpOffDiagJacobian(), getUserObjectJacobian(), MultiGrainRigidBodyMotion::getUserObjectJacobian(), and GrainRigidBodyMotionBase::globalDoFEnabled().

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

phase_field/include/kernels/SingleGrainRigidBodyMotion.h
phase_field/src/kernels/SingleGrainRigidBodyMotion.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SingleGrainRigidBodyMotion()

Member Function Documentation

◆ calculateAdvectionVelocity()

◆ computeQpJacobian()

◆ computeQpNonlocalJacobian()

◆ computeQpNonlocalOffDiagJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ getUserObjectJacobian()

◆ globalDoFEnabled()

◆ precalculateJacobian()

◆ precalculateOffDiagJacobian()

◆ precalculateResidual()

◆ timestepSetup()

Member Data Documentation

◆ _base_name

◆ _c

◆ _c_dofs

◆ _c_var

◆ _grad_c

◆ _grad_vals

◆ _grain_force_c_jacobians

◆ _grain_force_eta_jacobians

◆ _grain_force_torque

◆ _grain_forces

◆ _grain_ids

◆ _grain_torques

◆ _grain_tracker

◆ _grain_volumes

◆ _mr

◆ _mt

◆ _op_index

◆ _op_num

◆ _total_dofs

◆ _vals

◆ _vals_var

◆ _var_dofs

◆ _velocity_advection

◆ _velocity_advection_jacobian