www.mooseframework.org
ComputeGrainForceAndTorque.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "ShapeElementUserObject.h"
14 #include "DerivativeMaterialInterface.h"
15 
16 // Forward Declarations
19 
20 template <>
22 
26 class ComputeGrainForceAndTorque : public DerivativeMaterialInterface<ShapeElementUserObject>,
28 {
29 public:
30  ComputeGrainForceAndTorque(const InputParameters & parameters);
31 
32  virtual void initialize();
33  virtual void execute();
34  virtual void executeJacobian(unsigned int jvar);
35  virtual void finalize();
36  virtual void threadJoin(const UserObject & y);
37 
38  virtual const std::vector<RealGradient> & getForceValues() const;
39  virtual const std::vector<RealGradient> & getTorqueValues() const;
40  virtual const std::vector<Real> & getForceCJacobians() const;
41  virtual const std::vector<std::vector<Real>> & getForceEtaJacobians() const;
42 
43 protected:
44  unsigned int _qp;
45 
46  VariableName _c_name;
47  unsigned int _c_var;
49  MaterialPropertyName _dF_name;
50  const MaterialProperty<std::vector<RealGradient>> & _dF;
52  const MaterialProperty<std::vector<RealGradient>> & _dFdc;
54  unsigned int _op_num;
57  unsigned int _grain_num;
58  unsigned int _ncomp;
59 
60  std::vector<unsigned int> _vals_var;
61  std::vector<VariableName> _vals_name;
62  std::vector<const MaterialProperty<std::vector<Real>> *> _dFdgradeta;
63  std::vector<const MaterialProperty<Real> *> _test_derivatives;
64 
66  std::vector<RealGradient> _force_values;
67  std::vector<RealGradient> _torque_values;
68 
70  std::vector<Real> _force_torque_store;
72  std::vector<Real> _force_torque_c_jacobian_store;
73  std::vector<std::vector<Real>> _force_torque_eta_jacobian_store;
74 
75  unsigned int _total_dofs;
76 };
77 
ComputeGrainForceAndTorque::_total_dofs
unsigned int _total_dofs
Definition: ComputeGrainForceAndTorque.h:75
GrainTrackerInterface
This class defines the interface for the GrainTracking objects.
Definition: GrainTrackerInterface.h:24
ComputeGrainForceAndTorque::executeJacobian
virtual void executeJacobian(unsigned int jvar)
Definition: ComputeGrainForceAndTorque.C:101
ComputeGrainForceAndTorque::_dF_name
MaterialPropertyName _dF_name
material property that provides force density
Definition: ComputeGrainForceAndTorque.h:49
validParams< ComputeGrainForceAndTorque >
InputParameters validParams< ComputeGrainForceAndTorque >()
Definition: ComputeGrainForceAndTorque.C:19
ComputeGrainForceAndTorque
This class is here to get the force and torque acting on a grain.
Definition: ComputeGrainForceAndTorque.h:26
ComputeGrainForceAndTorque::_force_torque_store
std::vector< Real > _force_torque_store
vector storing grain force and torque values
Definition: ComputeGrainForceAndTorque.h:70
ComputeGrainForceAndTorque::getForceValues
virtual const std::vector< RealGradient > & getForceValues() const
Definition: ComputeGrainForceAndTorque.C:200
ComputeGrainForceAndTorque::_grain_tracker
const GrainTrackerInterface & _grain_tracker
provide UserObject for calculating grain volumes and centers
Definition: ComputeGrainForceAndTorque.h:56
ComputeGrainForceAndTorque::getForceEtaJacobians
virtual const std::vector< std::vector< Real > > & getForceEtaJacobians() const
Definition: ComputeGrainForceAndTorque.C:217
ComputeGrainForceAndTorque::initialize
virtual void initialize()
Definition: ComputeGrainForceAndTorque.C:55
ComputeGrainForceAndTorque::_dF
const MaterialProperty< std::vector< RealGradient > > & _dF
Definition: ComputeGrainForceAndTorque.h:50
GrainForceAndTorqueInterface.h
ComputeGrainForceAndTorque::_force_values
std::vector< RealGradient > _force_values
providing grain forces, torques and their jacobians w. r. t c
Definition: ComputeGrainForceAndTorque.h:66
ComputeGrainForceAndTorque::finalize
virtual void finalize()
Definition: ComputeGrainForceAndTorque.C:162
ComputeGrainForceAndTorque::_qp
unsigned int _qp
Definition: ComputeGrainForceAndTorque.h:44
ComputeGrainForceAndTorque::_force_torque_eta_jacobian_store
std::vector< std::vector< Real > > _force_torque_eta_jacobian_store
Definition: ComputeGrainForceAndTorque.h:73
ComputeGrainForceAndTorque::_torque_values
std::vector< RealGradient > _torque_values
Definition: ComputeGrainForceAndTorque.h:67
ComputeGrainForceAndTorque::_c_var
unsigned int _c_var
Definition: ComputeGrainForceAndTorque.h:47
ComputeGrainForceAndTorque::threadJoin
virtual void threadJoin(const UserObject &y)
Definition: ComputeGrainForceAndTorque.C:184
ComputeGrainForceAndTorque::_dFdc
const MaterialProperty< std::vector< RealGradient > > & _dFdc
material property that provides jacobian of force density with respect to c
Definition: ComputeGrainForceAndTorque.h:52
ComputeGrainForceAndTorque::execute
virtual void execute()
Definition: ComputeGrainForceAndTorque.C:76
ComputeGrainForceAndTorque::_dFdgradeta
std::vector< const MaterialProperty< std::vector< Real > > * > _dFdgradeta
Definition: ComputeGrainForceAndTorque.h:62
ComputeGrainForceAndTorque::_vals_name
std::vector< VariableName > _vals_name
Definition: ComputeGrainForceAndTorque.h:61
ComputeGrainForceAndTorque::_vals_var
std::vector< unsigned int > _vals_var
Definition: ComputeGrainForceAndTorque.h:60
ComputeGrainForceAndTorque::_c_name
VariableName _c_name
Definition: ComputeGrainForceAndTorque.h:46
ComputeGrainForceAndTorque::_force_torque_c_jacobian_store
std::vector< Real > _force_torque_c_jacobian_store
vector storing jacobian of grain force and torque values
Definition: ComputeGrainForceAndTorque.h:72
ComputeGrainForceAndTorque::getTorqueValues
virtual const std::vector< RealGradient > & getTorqueValues() const
Definition: ComputeGrainForceAndTorque.C:206
ComputeGrainForceAndTorque::_test_derivatives
std::vector< const MaterialProperty< Real > * > _test_derivatives
Definition: ComputeGrainForceAndTorque.h:63
ComputeGrainForceAndTorque::ComputeGrainForceAndTorque
ComputeGrainForceAndTorque(const InputParameters &parameters)
Definition: ComputeGrainForceAndTorque.C:30
ComputeGrainForceAndTorque::_grain_num
unsigned int _grain_num
Definition: ComputeGrainForceAndTorque.h:57
ComputeGrainForceAndTorque::_op_num
unsigned int _op_num
no. of order parameters
Definition: ComputeGrainForceAndTorque.h:54
ComputeGrainForceAndTorque::_ncomp
unsigned int _ncomp
Definition: ComputeGrainForceAndTorque.h:58
GrainForceAndTorqueInterface
This class provides interface for extracting the forces and torques computed in other UserObjects.
Definition: GrainForceAndTorqueInterface.h:24
ComputeGrainForceAndTorque::getForceCJacobians
virtual const std::vector< Real > & getForceCJacobians() const
Definition: ComputeGrainForceAndTorque.C:212