MaskedGrainForceAndTorque Class Reference

This class is here to get the force and torque acting on a grain from different userobjects and sum them all. More...

#include <MaskedGrainForceAndTorque.h>

Inheritance diagram for MaskedGrainForceAndTorque:

Public Member Functions
	MaskedGrainForceAndTorque (const InputParameters &parameters)
virtual void	initialize ()
virtual void	execute ()
virtual void	finalize ()
virtual const std::vector< RealGradient > &	getForceValues () const
virtual const std::vector< RealGradient > &	getTorqueValues () const
virtual const std::vector< Real > &	getForceCJacobians () const
virtual const std::vector< std::vector< Real > > &	getForceEtaJacobians () const

Protected Attributes
const GrainForceAndTorqueInterface &	_grain_force_torque_input
const std::vector< RealGradient > &	_grain_forces_input
const std::vector< RealGradient > &	_grain_torques_input
const std::vector< Real > &	_grain_force_c_jacobians_input
const std::vector< std::vector< Real > > &	_grain_force_eta_jacobians_input
std::vector< unsigned int >	_pinned_grains
unsigned int	_num_pinned_grains
unsigned int	_grain_num
std::vector< RealGradient >	_force_values
	providing grain forces, torques and their jacobians w. r. t c More...
std::vector< RealGradient >	_torque_values
std::vector< Real >	_c_jacobians
std::vector< std::vector< Real > >	_eta_jacobians

Detailed Description

This class is here to get the force and torque acting on a grain from different userobjects and sum them all.

Definition at line 25 of file MaskedGrainForceAndTorque.h.

Constructor & Destructor Documentation

MaskedGrainForceAndTorque()

MaskedGrainForceAndTorque::MaskedGrainForceAndTorque

(

const InputParameters &

parameters

)

Definition at line 27 of file MaskedGrainForceAndTorque.C.

  : GrainForceAndTorqueInterface(),
    GeneralUserObject(parameters),
    _grain_force_torque_input(getUserObject<GrainForceAndTorqueInterface>("grain_force")),
    _grain_forces_input(_grain_force_torque_input.getForceValues()),
    _grain_torques_input(_grain_force_torque_input.getTorqueValues()),
    _grain_force_c_jacobians_input(_grain_force_torque_input.getForceCJacobians()),
    _grain_force_eta_jacobians_input(_grain_force_torque_input.getForceEtaJacobians()),
    _pinned_grains(getParam<std::vector<unsigned int>>("pinned_grains")),
    _num_pinned_grains(_pinned_grains.size()),
    _grain_num(_grain_forces_input.size()),
    _force_values(_grain_num),
    _torque_values(_grain_num)
{
}

Member Function Documentation

execute()

virtual void MaskedGrainForceAndTorque::execute ( )

inlinevirtual

Definition at line 31 of file MaskedGrainForceAndTorque.h.

{};

finalize()

virtual void MaskedGrainForceAndTorque::finalize ( )

inlinevirtual

Definition at line 32 of file MaskedGrainForceAndTorque.h.

{};

getForceCJacobians()

const std::vector< Real > & MaskedGrainForceAndTorque::getForceCJacobians ( ) const

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 146 of file MaskedGrainForceAndTorque.C.

{
  return _c_jacobians;
}

getForceEtaJacobians()

const std::vector< std::vector< Real > > & MaskedGrainForceAndTorque::getForceEtaJacobians ( ) const

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 152 of file MaskedGrainForceAndTorque.C.

{
  return _eta_jacobians;
}

getForceValues()

const std::vector< RealGradient > & MaskedGrainForceAndTorque::getForceValues ( ) const

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 134 of file MaskedGrainForceAndTorque.C.

{
  return _force_values;
}

getTorqueValues()

const std::vector< RealGradient > & MaskedGrainForceAndTorque::getTorqueValues ( ) const

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 140 of file MaskedGrainForceAndTorque.C.

{
  return _torque_values;
}

initialize()

void MaskedGrainForceAndTorque::initialize ( )

virtual

Definition at line 44 of file MaskedGrainForceAndTorque.C.

{
  for (unsigned int i = 0; i < _grain_num; ++i)
  {
    _force_values[i] = _grain_forces_input[i];
    _torque_values[i] = _grain_torques_input[i];
 
    if (_num_pinned_grains != 0)
    {
      for (unsigned int j = 0; j < _num_pinned_grains; ++j)
      {
        if (i == _pinned_grains[j])
        {
          _force_values[i] = 0.0;
          _torque_values[i] = 0.0;
        }
      }
    }
  }
 
  if (_fe_problem.currentlyComputingJacobian())
  {
    unsigned int total_dofs = _subproblem.es().n_dofs();
    _c_jacobians.resize(6 * _grain_num * total_dofs, 0.0);
    _eta_jacobians.resize(_grain_num);
    for (unsigned int i = 0; i < _grain_num; ++i)
      for (unsigned int j = 0; j < total_dofs; ++j)
      {
        _c_jacobians[(6 * i + 0) * total_dofs + j] =
            _grain_force_c_jacobians_input[(6 * i + 0) * total_dofs + j];
        _c_jacobians[(6 * i + 1) * total_dofs + j] =
            _grain_force_c_jacobians_input[(6 * i + 1) * total_dofs + j];
        _c_jacobians[(6 * i + 2) * total_dofs + j] =
            _grain_force_c_jacobians_input[(6 * i + 2) * total_dofs + j];
        _c_jacobians[(6 * i + 3) * total_dofs + j] =
            _grain_force_c_jacobians_input[(6 * i + 3) * total_dofs + j];
        _c_jacobians[(6 * i + 4) * total_dofs + j] =
            _grain_force_c_jacobians_input[(6 * i + 4) * total_dofs + j];
        _c_jacobians[(6 * i + 5) * total_dofs + j] =
            _grain_force_c_jacobians_input[(6 * i + 5) * total_dofs + j];
 
        if (_num_pinned_grains != 0)
          for (unsigned int k = 0; k < _num_pinned_grains; ++k)
            if (i == _pinned_grains[k])
            {
              _c_jacobians[(6 * i + 0) * total_dofs + j] = 0.0;
              _c_jacobians[(6 * i + 1) * total_dofs + j] = 0.0;
              _c_jacobians[(6 * i + 2) * total_dofs + j] = 0.0;
              _c_jacobians[(6 * i + 3) * total_dofs + j] = 0.0;
              _c_jacobians[(6 * i + 4) * total_dofs + j] = 0.0;
              _c_jacobians[(6 * i + 5) * total_dofs + j] = 0.0;
            }
      }
 
    for (unsigned int i = 0; i < _grain_num; ++i)
    {
      _eta_jacobians[i].resize(6 * _grain_num * total_dofs);
      for (unsigned int j = 0; j < _grain_num; ++j)
        for (unsigned int k = 0; k < total_dofs; ++k)
        {
          _eta_jacobians[i][(6 * j + 0) * total_dofs + k] =
              _grain_force_eta_jacobians_input[i][(6 * j + 0) * total_dofs + k];
          _eta_jacobians[i][(6 * j + 1) * total_dofs + k] =
              _grain_force_eta_jacobians_input[i][(6 * j + 1) * total_dofs + k];
          _eta_jacobians[i][(6 * j + 2) * total_dofs + k] =
              _grain_force_eta_jacobians_input[i][(6 * j + 2) * total_dofs + k];
          _eta_jacobians[i][(6 * j + 3) * total_dofs + k] =
              _grain_force_eta_jacobians_input[i][(6 * j + 3) * total_dofs + k];
          _eta_jacobians[i][(6 * j + 4) * total_dofs + k] =
              _grain_force_eta_jacobians_input[i][(6 * j + 4) * total_dofs + k];
          _eta_jacobians[i][(6 * j + 5) * total_dofs + k] =
              _grain_force_eta_jacobians_input[i][(6 * j + 5) * total_dofs + k];
 
          if (_num_pinned_grains != 0)
            for (unsigned int l = 0; l < _num_pinned_grains; ++l)
              if (j == _pinned_grains[l])
              {
                _eta_jacobians[i][(6 * j + 0) * total_dofs + k] = 0.0;
                _eta_jacobians[i][(6 * j + 1) * total_dofs + k] = 0.0;
                _eta_jacobians[i][(6 * j + 2) * total_dofs + k] = 0.0;
                _eta_jacobians[i][(6 * j + 3) * total_dofs + k] = 0.0;
                _eta_jacobians[i][(6 * j + 4) * total_dofs + k] = 0.0;
                _eta_jacobians[i][(6 * j + 5) * total_dofs + k] = 0.0;
              }
        }
    }
  }
}

Member Data Documentation

_c_jacobians

std::vector<Real> MaskedGrainForceAndTorque::_c_jacobians

protected

Definition at line 53 of file MaskedGrainForceAndTorque.h.

Referenced by getForceCJacobians(), and initialize().

_eta_jacobians

std::vector<std::vector<Real> > MaskedGrainForceAndTorque::_eta_jacobians

protected

Definition at line 54 of file MaskedGrainForceAndTorque.h.

Referenced by getForceEtaJacobians(), and initialize().

_force_values

std::vector<RealGradient> MaskedGrainForceAndTorque::_force_values

protected

providing grain forces, torques and their jacobians w. r. t c

Definition at line 51 of file MaskedGrainForceAndTorque.h.

Referenced by getForceValues(), and initialize().

_grain_force_c_jacobians_input

const std::vector<Real>& MaskedGrainForceAndTorque::_grain_force_c_jacobians_input

protected

Definition at line 43 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_grain_force_eta_jacobians_input

const std::vector<std::vector<Real> >& MaskedGrainForceAndTorque::_grain_force_eta_jacobians_input

protected

Definition at line 44 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_grain_force_torque_input

const GrainForceAndTorqueInterface& MaskedGrainForceAndTorque::_grain_force_torque_input

protected

Definition at line 40 of file MaskedGrainForceAndTorque.h.

_grain_forces_input

const std::vector<RealGradient>& MaskedGrainForceAndTorque::_grain_forces_input

protected

Definition at line 41 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_grain_num

unsigned int MaskedGrainForceAndTorque::_grain_num

protected

Definition at line 48 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_grain_torques_input

const std::vector<RealGradient>& MaskedGrainForceAndTorque::_grain_torques_input

protected

Definition at line 42 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_num_pinned_grains

unsigned int MaskedGrainForceAndTorque::_num_pinned_grains

protected

Definition at line 47 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_pinned_grains

std::vector<unsigned int> MaskedGrainForceAndTorque::_pinned_grains

protected

Definition at line 46 of file MaskedGrainForceAndTorque.h.

Referenced by initialize().

_torque_values

std::vector<RealGradient> MaskedGrainForceAndTorque::_torque_values

protected

Definition at line 52 of file MaskedGrainForceAndTorque.h.

Referenced by getTorqueValues(), and initialize().

---

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

• phase_field/include/userobjects/MaskedGrainForceAndTorque.h
• phase_field/src/userobjects/MaskedGrainForceAndTorque.C