#include <GrainRigidBodyMotionBase.h>

Inheritance diagram for GrainRigidBodyMotionBase:

Public Member Functions
	GrainRigidBodyMotionBase (const InputParameters &parameters)

virtual void	timestepSetup ()

Protected Member Functions
virtual bool	globalDoFEnabled (MooseVariableFEBase &, dof_id_type)

virtual void	precalculateResidual ()

virtual void	precalculateJacobian ()

virtual void	precalculateOffDiagJacobian (unsigned int jvar)

virtual void	calculateAdvectionVelocity ()

Protected Attributes
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 22 of file GrainRigidBodyMotionBase.h.

Constructor & Destructor Documentation

◆ GrainRigidBodyMotionBase()

GrainRigidBodyMotionBase::GrainRigidBodyMotionBase ( const InputParameters & parameters )

Definition at line 40 of file GrainRigidBodyMotionBase.C.

   : NonlocalKernel(parameters),
     _var_dofs(_var.dofIndices()),
     _c_var(coupled("c")),
     _c(coupledValue("c")),
     _grad_c(coupledGradient("c")),
     _c_dofs(getVar("c", 0)->dofIndices()),
     _op_num(coupledComponents("v")),
     _vals(_op_num),
     _vals_var(_op_num),
     _grad_vals(_op_num),
     _base_name(isParamValid("base_name") ? getParam<std::string>("base_name") + "_" : ""),
     _grain_force_torque(getUserObject<GrainForceAndTorqueInterface>("grain_force")),
     _grain_forces(_grain_force_torque.getForceValues()),
     _grain_torques(_grain_force_torque.getTorqueValues()),
     _grain_force_c_jacobians(_grain_force_torque.getForceCJacobians()),
     _grain_force_eta_jacobians(_grain_force_torque.getForceEtaJacobians()),
     _mt(getParam<Real>("translation_constant")),
     _mr(getParam<Real>("rotation_constant")),
     _grain_tracker(getUserObject<GrainTrackerInterface>("grain_tracker_object")),
     _grain_volumes(getVectorPostprocessorValue("grain_volumes", "feature_volumes"))
 {
   // Loop through grains and load coupled variables into the arrays
   for (unsigned int i = 0; i < _op_num; ++i)
   {
     _vals[i] = &coupledValue("v", i);
     _vals_var[i] = coupled("v", i);
     _grad_vals[i] = &coupledGradient("v", i);
   }
 }

Member Function Documentation

◆ calculateAdvectionVelocity()

virtual void GrainRigidBodyMotionBase::calculateAdvectionVelocity ( )

inlineprotectedvirtual

Reimplemented in MultiGrainRigidBodyMotion, and SingleGrainRigidBodyMotion.

Definition at line 37 of file GrainRigidBodyMotionBase.h.

37 {}

Referenced by precalculateJacobian(), precalculateOffDiagJacobian(), and precalculateResidual().

◆ globalDoFEnabled()

bool GrainRigidBodyMotionBase::globalDoFEnabled	(	MooseVariableFEBase &	,
		dof_id_type
	)

protectedvirtual

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 ( )

protectedvirtual

Definition at line 94 of file GrainRigidBodyMotionBase.C.

 {
   calculateAdvectionVelocity();
 }

◆ precalculateOffDiagJacobian()

void GrainRigidBodyMotionBase::precalculateOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 100 of file GrainRigidBodyMotionBase.C.

 {
   calculateAdvectionVelocity();
 }

◆ precalculateResidual()

void GrainRigidBodyMotionBase::precalculateResidual ( )

protectedvirtual

Definition at line 88 of file GrainRigidBodyMotionBase.C.

 {
   calculateAdvectionVelocity();
 }

◆ timestepSetup()

void GrainRigidBodyMotionBase::timestepSetup ( )

virtual

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

protected

base name specifying type of force density material

Definition at line 59 of file GrainRigidBodyMotionBase.h.

◆ _c

const VariableValue& GrainRigidBodyMotionBase::_c

protected

Variable value for the concentration.

Definition at line 45 of file GrainRigidBodyMotionBase.h.

◆ _c_dofs

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

protected

local dof indices of variable c

Definition at line 49 of file GrainRigidBodyMotionBase.h.

◆ _c_var

unsigned int GrainRigidBodyMotionBase::_c_var

protected

int label for the Concentration

Definition at line 43 of file GrainRigidBodyMotionBase.h.

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

◆ _grad_c

const VariableGradient& GrainRigidBodyMotionBase::_grad_c

protected

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

protected

Definition at line 56 of file GrainRigidBodyMotionBase.h.

Referenced by GrainRigidBodyMotionBase().

◆ _grain_force_c_jacobians

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

protected

Definition at line 65 of file GrainRigidBodyMotionBase.h.

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

◆ _grain_force_eta_jacobians

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

protected

Definition at line 66 of file GrainRigidBodyMotionBase.h.

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

◆ _grain_force_torque

const GrainForceAndTorqueInterface& GrainRigidBodyMotionBase::_grain_force_torque

protected

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

protected

Definition at line 63 of file GrainRigidBodyMotionBase.h.

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

◆ _grain_ids

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

protected

obtain the active grain ids

Definition at line 86 of file GrainRigidBodyMotionBase.h.

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

◆ _grain_torques

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

protected

Definition at line 64 of file GrainRigidBodyMotionBase.h.

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

◆ _grain_tracker

const GrainTrackerInterface& GrainRigidBodyMotionBase::_grain_tracker

protected

grain tracker object

Definition at line 74 of file GrainRigidBodyMotionBase.h.

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

◆ _grain_volumes

const VectorPostprocessorValue& GrainRigidBodyMotionBase::_grain_volumes

protected

The grain volumes.

Definition at line 77 of file GrainRigidBodyMotionBase.h.

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

◆ _mr

const Real GrainRigidBodyMotionBase::_mr

protected

constant value corresponding to grain rotation

Definition at line 71 of file GrainRigidBodyMotionBase.h.

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

◆ _mt

const Real GrainRigidBodyMotionBase::_mt

protected

constant value corresponding to grain translation

Definition at line 69 of file GrainRigidBodyMotionBase.h.

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

◆ _op_num

const unsigned int GrainRigidBodyMotionBase::_op_num

protected

no. of order parameters

Definition at line 52 of file GrainRigidBodyMotionBase.h.

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

◆ _total_dofs

unsigned int GrainRigidBodyMotionBase::_total_dofs

protected

get the total no. of dofs in the system

Definition at line 80 of file GrainRigidBodyMotionBase.h.

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

◆ _vals

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

protected

Variable value for the order parameters.

Definition at line 54 of file GrainRigidBodyMotionBase.h.

Referenced by GrainRigidBodyMotionBase().

◆ _vals_var

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

protected

Definition at line 55 of file GrainRigidBodyMotionBase.h.

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

◆ _var_dofs

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

protected

Variable's local dof indices.

Definition at line 40 of file GrainRigidBodyMotionBase.h.

◆ _velocity_advection

RealGradient GrainRigidBodyMotionBase::_velocity_advection

protected

storing the advection velocity and corresponding jacobian entries calculated in userobjects

Definition at line 83 of file GrainRigidBodyMotionBase.h.

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

◆ _velocity_advection_jacobian

RealGradient GrainRigidBodyMotionBase::_velocity_advection_jacobian

protected

Definition at line 84 of file GrainRigidBodyMotionBase.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GrainRigidBodyMotionBase()

Member Function Documentation

◆ calculateAdvectionVelocity()

◆ 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_num

◆ _total_dofs

◆ _vals

◆ _vals_var

◆ _var_dofs

◆ _velocity_advection

◆ _velocity_advection_jacobian