ShaftConnectedMotorUserObject.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "GeneralUserObject.h"
#include "ShaftConnectableUserObjectInterface.h"

class ShaftConnectedMotorUserObject : public GeneralUserObject,
                                      public ShaftConnectableUserObjectInterface
{
public:
  ShaftConnectedMotorUserObject(const InputParameters & params);

  virtual Real getTorque() const override;
  virtual void getTorqueJacobianData(DenseMatrix<Real> & jacobian_block,
                                     std::vector<dof_id_type> & dofs_j) const override;

  virtual Real getMomentOfInertia() const override;
  virtual void getMomentOfInertiaJacobianData(DenseMatrix<Real> & jacobian_block,
                                              std::vector<dof_id_type> & dofs_j) const override;

  virtual void initialize() override;
  virtual void execute() override;
  virtual void finalize() override;

protected:
  const Function & _torque_fn;
  const Function & _inertia_fn;
  const VariableValue & _shaft_speed;

public:
  static InputParameters validParams();
};