This class is here to get the force and torque acting on a grain. More...

#include <ConstantGrainForceAndTorque.h>

Inheritance diagram for ConstantGrainForceAndTorque:

Public Member Functions
	ConstantGrainForceAndTorque (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
std::vector< Real >	_F
	Applied force on particles, size should be 3 times no. of grains. More...

std::vector< Real >	_M
	Applied torque on particles, size should be 3 times no. of grains. More...

unsigned int	_grain_num

unsigned int	_ncomp


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.

Definition at line 24 of file ConstantGrainForceAndTorque.h.

Constructor & Destructor Documentation

◆ ConstantGrainForceAndTorque()

ConstantGrainForceAndTorque::ConstantGrainForceAndTorque ( const InputParameters & parameters )

Definition at line 25 of file ConstantGrainForceAndTorque.C.

   : GrainForceAndTorqueInterface(),
     GeneralUserObject(parameters),
     _F(getParam<std::vector<Real>>("force")),
     _M(getParam<std::vector<Real>>("torque")),
     _grain_num(_F.size() / 3),
     _ncomp(6 * _grain_num),
     _force_values(_grain_num),
     _torque_values(_grain_num)
 {
 }

Member Function Documentation

◆ execute()

virtual void ConstantGrainForceAndTorque::execute ( )

inlinevirtual

Definition at line 30 of file ConstantGrainForceAndTorque.h.

30 {}

◆ finalize()

virtual void ConstantGrainForceAndTorque::finalize ( )

inlinevirtual

Definition at line 31 of file ConstantGrainForceAndTorque.h.

31 {}

◆ getForceCJacobians()

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

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 73 of file ConstantGrainForceAndTorque.C.

 {
   return _c_jacobians;
 }

◆ getForceEtaJacobians()

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

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 79 of file ConstantGrainForceAndTorque.C.

 {
   return _eta_jacobians;
 }

◆ getForceValues()

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

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 61 of file ConstantGrainForceAndTorque.C.

 {
   return _force_values;
 }

◆ getTorqueValues()

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

virtual

Implements GrainForceAndTorqueInterface.

Definition at line 67 of file ConstantGrainForceAndTorque.C.

 {
   return _torque_values;
 }

◆ initialize()

void ConstantGrainForceAndTorque::initialize ( )

virtual

Definition at line 38 of file ConstantGrainForceAndTorque.C.

 {
   unsigned int total_dofs = _subproblem.es().n_dofs();
   for (unsigned int i = 0; i < _grain_num; ++i)
   {
     _force_values[i](0) = _F[3 * i + 0];
     _force_values[i](1) = _F[3 * i + 1];
     _force_values[i](2) = _F[3 * i + 2];
     _torque_values[i](0) = _M[3 * i + 0];
     _torque_values[i](1) = _M[3 * i + 1];
     _torque_values[i](2) = _M[3 * i + 2];
   }
  
   if (_fe_problem.currentlyComputingJacobian())
   {
     _c_jacobians.assign(6 * _grain_num * total_dofs, 0.0);
     _eta_jacobians.resize(_grain_num);
     for (unsigned int i = 0; i < _grain_num; ++i)
       _eta_jacobians[i].assign(6 * _grain_num * total_dofs, 0.0);
   }
 }