ShaftConnectable.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 "InputParameters.h"

class Component;

class ShaftConnectable
{
public:
  ShaftConnectable(const Component * const component);

  virtual void checkShaftConnection(const Component * const component) const;
  virtual VariableName getMomentofInertiaVariableName() const;
  virtual VariableName getTorqueVariableName() const;
  virtual UserObjectName getShaftConnectedUserObjectName() const;
  virtual void setShaftName(const std::string & name) const;

protected:
  VariableName _moment_of_inertia_var_name;
  VariableName _torque_var_name;
  UserObjectName _user_object_name;
  mutable std::string _shaft_name;
  mutable bool _connected_to_shaft;

public:
  static InputParameters validParams();
};