FlowConnector.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
 
 
#ifndef AGXHYDRAULICS_FLOW_CONNECTOR_H
#define AGXHYDRAULICS_FLOW_CONNECTOR_H
 
#include <agxHydraulics/export.h>
#include <agxHydraulics/PressureConnector.h>
#include <agxPowerLine/PowerLineUtils.h>
 
 
namespace agxHydraulics
{
  AGX_DECLARE_POINTER_TYPES(FlowConnector);
  AGX_DECLARE_VECTOR_TYPES(FlowConnector);
 
  class AGXHYDRAULICS_EXPORT FlowConnector : public agxHydraulics::PressureConnector
  {
    public:
      FlowConnector(bool holonomic = true);
 
      virtual bool connect(
        agxPowerLine::Side mySide,
        agxPowerLine::Side unitSide,
        agxPowerLine::Unit* unit) override;
 
      using agxHydraulics::PressureConnector::connect;
 
      void setCompliance(agx::Real volumePerPressure);
 
      agx::Real getCompliance() const;
 
      void setDamping(agx::Real damping);
 
      agx::Real getDamping() const;
 
      void setVolumeExpansionPressureRatio(agx::Real ratio);
 
      agx::Real getVolumeExpansionPressureRatio() const;
 
      virtual agx::Real getPressure() const override;
 
      agx::Real getStoredFluid() const;
 
 
 
 
      static void setDefaultCompliance(agx::Real compliance);
 
      static agx::Real getDefaultCompliance();
 
      static void setDefaultDamping(agx::Real damping);
 
      static agx::Real getDefaultDamping();
 
 
    // Methods called by the rest of the PowerLine/Hydraulics frame work.
    public:
 
      DOXYGEN_START_INTERNAL_BLOCK()
      void setStoredFluid(agx::Real storedFluid);
 
 
      virtual agxPowerLine::PhysicalDimensionMultiBodyConstraintImplementation* createConstraint() override;
 
 
      virtual agx::RegularizationParameters::VariableType calculateComplianceAndDamping(
          const agx::Real timeStep, agx::Real& compliance, agx::Real& damping) override;
 
      void setIsImpacting(bool impact);
 
#ifndef SWIG
      virtual bool postStore(agxStream::StorageStream& str) const override;
 
      virtual bool postRestore(agxStream::StorageStream& str) override;
 
 
      virtual bool store(agxStream::StorageStream& str) const override;
 
      virtual bool restore(agxStream::StorageStream& str) override;
 
 
      AGXSTREAM_DECLARE_SERIALIZABLE(agxHydraulics::FlowConnector);
#endif
      DOXYGEN_END_INTERNAL_BLOCK()
 
    protected:
 
// Swig tries to generate bindings to this protected connect member function
// which leads to compiler errors since the function is protected.
#ifndef SWIG
      virtual bool connect(
          agxPowerLine::Unit* inputUnit, agxPowerLine::Side inputUnitSide,
          agxPowerLine::Side outputUnitSide, agxPowerLine::Unit* outputUnit) override;
#endif
 
      virtual ~FlowConnector() {}
 
    private:
      agx::Real m_volumeExpansionPressureRatio;
      agx::Real m_damping;
      bool m_holonomic;
 
      static agx::Real s_defaultCompliance;
      static agx::Real s_defaultDamping;
  };
 
 
}
 
#endif