Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       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 "GrainForceAndTorqueInterface.h"
      13             : #include "GeneralUserObject.h"
      14             : 
      15             : // Forward Declarations
      16             : 
      17             : /**
      18             :  * This class is here to get the force and torque acting on a grain
      19             :  * from different userobjects and sum them all
      20             :  */
      21             : class GrainForceAndTorqueSum : public GrainForceAndTorqueInterface, public GeneralUserObject
      22             : {
      23             : public:
      24             :   static InputParameters validParams();
      25             : 
      26             :   GrainForceAndTorqueSum(const InputParameters & parameters);
      27             : 
      28             :   virtual void initialize();
      29         119 :   virtual void execute(){};
      30         119 :   virtual void finalize(){};
      31             : 
      32             :   virtual const std::vector<RealGradient> & getForceValues() const;
      33             :   virtual const std::vector<RealGradient> & getTorqueValues() const;
      34             :   virtual const std::vector<Real> & getForceCJacobians() const;
      35             :   virtual const std::vector<std::vector<Real>> & getForceEtaJacobians() const;
      36             : 
      37             : protected:
      38             :   /// Vector of userobjects providing forces and torques acting on grains
      39             :   std::vector<UserObjectName> _sum_objects;
      40             :   /// Total no. of userobjects that provides forces and torques acting on grains
      41             :   unsigned int _num_forces;
      42             :   unsigned int _grain_num;
      43             : 
      44             :   std::vector<const GrainForceAndTorqueInterface *> _sum_forces;
      45             : 
      46             :   ///@{ providing grain forces, torques and their jacobians w. r. t c
      47             :   std::vector<RealGradient> _force_values;
      48             :   std::vector<RealGradient> _torque_values;
      49             :   std::vector<Real> _c_jacobians;
      50             :   std::vector<std::vector<Real>> _eta_jacobians;
      51             :   ///@}
      52             : };