ShaftConnectableUserObjectInterface.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 "libmesh/dense_matrix.h"
#include "InputParameters.h"

using namespace libMesh;
class UserObject;
class MooseVariableScalar;

class ShaftConnectableUserObjectInterface
{
public:
  ShaftConnectableUserObjectInterface(const MooseObject * moose_object);

  virtual void initialize();
  virtual void execute();
  virtual void finalize();
  virtual void threadJoin(const UserObject & uo);

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

protected:
  virtual void setupConnections(unsigned int n_connections, unsigned int n_flow_eq);
  virtual void
  setConnectionData(const std::vector<std::vector<std::vector<Real>>> & phi_face_values,
                    const std::vector<std::vector<dof_id_type>> & flow_channel_dofs);
  virtual void setOmegaDofs(const MooseVariableScalar * omega_var);
  virtual void setupJunctionData(std::vector<dof_id_type> & scalar_dofs);

  virtual void computeMomentOfInertiaScalarJacobianWRTFlowDofs(const DenseMatrix<Real> & jac,
                                                               const unsigned int & c);
  virtual void computeTorqueScalarJacobianWRTFlowDofs(const DenseMatrix<Real> & jac,
                                                      const unsigned int & c);

  unsigned int _n_shaft_eq;
  unsigned int _n_connections;
  unsigned int _n_flow_eq;

  std::vector<dof_id_type> _omega_dof;
  std::vector<dof_id_type> _scalar_dofs;
  std::vector<std::vector<dof_id_type>> _flow_channel_dofs;
  Real _torque;
  Real _moment_of_inertia;

  std::vector<DenseMatrix<Real>> _torque_jacobian_flow_channel_vars;
  DenseMatrix<Real> _torque_jacobian_scalar_vars;
  DenseMatrix<Real> _torque_jacobian_omega_var;

  std::vector<DenseMatrix<Real>> _moi_jacobian_flow_channel_vars;
  DenseMatrix<Real> _moi_jacobian_scalar_vars;
  DenseMatrix<Real> _moi_jacobian_omega_var;

  std::vector<std::vector<std::vector<Real>>> _phi_face_values;

public:
  static InputParameters validParams();
};