ADShaftConnectableUserObjectInterface.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 ADShaftConnectableUserObjectInterface
{
public:
  ADShaftConnectableUserObjectInterface(const MooseObject * moose_object);

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

  virtual ADReal getTorque() const;
  virtual ADReal getMomentOfInertia() const;

protected:
  virtual void setupConnections(unsigned int n_connections, unsigned int n_flow_eq);
  virtual void setConnectionData(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);

  const MooseObject * _moose_object;
  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;
  ADReal _torque;
  ADReal _moment_of_inertia;

public:
  static InputParameters validParams();
};