FlowUnit.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_UNIT_H
#define AGXHYDRAULICS_FLOW_UNIT_H
 
#include <agxHydraulics/FlowConnector.h>
#include <agxHydraulics/FlowDimension.h>
 
#include <agxPowerLine/Unit.h>
#include <agxPowerLine/Sides.h>
 
namespace agx
{
  class Constraint;
}
 
namespace agxSDK
{
  class Simulation;
}
 
namespace agxHydraulics
{
  AGX_DECLARE_POINTER_TYPES(FlowUnit);
  AGX_DECLARE_VECTOR_TYPES(FlowUnit);
 
 
  class AGXHYDRAULICS_EXPORT FlowUnit : public agxPowerLine::Unit
  {
    public:
      FlowUnit(agx::Real length, agx::Real area, agx::Real fluidDensity);
 
      DOXYGEN_START_INTERNAL_BLOCK()
      FlowUnit(agx::Real length, agx::Real area, agx::Real fluidDensity,
               agx::RigidBody* body, agx::UInt8 elementIndex);
 
      DOXYGEN_END_INTERNAL_BLOCK()
 
      explicit FlowUnit(agx::Real inertia);
 
      void setLength(agx::Real length);
 
      agx::Real getLength() const;
 
      bool setArea(agx::Real area);
 
      agx::Real getArea() const;
 
      void setFluidDensity(agx::Real density);
 
      agx::Real getFluidDensity() const;
 
      void setFluidViscosity(agx::Real viscosity);
 
      agx::Real getFluidViscosity() const;
 
      agx::Real getFlowRate() const;
 
      void addPressure(agx::Real pressure, agxPowerLine::Side side);
 
      agx::Real getPressure(agxPowerLine::Side side) const;
 
      agx::Real getInputPressure() const;
 
      agx::Real getInletPressure() const;
 
      agx::Real getOutputPressure() const;
 
      agx::Real getOutletPressure() const;
 
      agxHydraulics::FlowDimension* getFlowDimension();
 
      const agxHydraulics::FlowDimension* getFlowDimension() const;
 
 
      virtual agxHydraulics::FlowConnector* getFlowConnector(agxPowerLine::Side side);
 
      virtual const agxHydraulics::FlowConnector* getFlowConnector(agxPowerLine::Side side) const;
 
      agxHydraulics::FlowConnector* getInputFlowConnector();
 
      const agxHydraulics::FlowConnector* getInputFlowConnector() const;
 
      agxHydraulics::FlowConnector* getOutputFlowConnector();
 
      const agxHydraulics::FlowConnector* getOutputFlowConnector() const;
 
      bool isConnected(agxPowerLine::Side end) const;
 
      using Unit::isConnected;
 
      static FlowConnector* findInCommonFlowConnector(FlowUnit* a, FlowUnit* b);
 
 
    // Methods called by the rest of the PowerLine/Hydraulics frame work.
    public:
      DOXYGEN_START_INTERNAL_BLOCK()
      virtual agx::Real computeFrictionLoss(agx::Real flowRate);
 
      virtual void addTankPressure();
 
#ifndef SWIG
      virtual bool preUpdate(agx::Real timeStep) override;
 
      virtual bool store(agxStream::StorageStream& str) const override;
 
      virtual bool restore(agxStream::StorageStream& str) override;
 
      AGXSTREAM_DECLARE_SERIALIZABLE(agxHydraulics::FlowUnit);
#endif
 
    protected:
      FlowUnit();
      DOXYGEN_END_INTERNAL_BLOCK()
 
    protected:
      void init();
 
      void updateBodyMass();
 
      agx::Real computeReynoldsNumber() const;
      static agx::Real computeReynoldsNumber(agx::Real area, agx::Real flowRate, agx::Real viscosity);
      agx::Real computeFrictionFactor() const;
      agx::Real computeLaminarFrictionalLoss(agx::Real flowRate) const;
      agx::Real computeQuadraticFrictionalLoss(agx::Real flowCoefficient) const;
      agx::Real updateFrictionLoss();
 
    protected:
      virtual ~FlowUnit() {}
 
    protected:
      agxHydraulics::FlowDimensionRef m_flowDimension;
 
    private:
      agx::Real m_length;
      agx::Real m_area;
 
      agx::Real m_fluidDensity;
 
      agx::Real m_viscosity;
  };
 
}
 
#endif