SELiquidSubstanceQuantity.h

/* Distributed under the Apache License, Version 2.0.
   See accompanying NOTICE file for details.*/
 
#pragma once
#include "cdm/compartment/substances/SESubstanceQuantity.h"
#include "cdm/substance/SESubstanceTransport.h"
class SELiquidCompartment;
 
enum class BalanceLiquidBy { Mass, Concentration, Molarity, PartialPressure };
 
class CDM_DECL SELiquidSubstanceQuantity : public SESubstanceQuantity, public SELiquidTransportSubstance
{
  friend class PBSubstanceQuantity;//friend the serialization class
  friend class SELiquidCompartment;
protected:
  SELiquidSubstanceQuantity(SESubstance& sub, SELiquidCompartment& compartment);
public:
  virtual ~SELiquidSubstanceQuantity();
 
  void Clear() override;
 
  virtual std::string GetCompartmentName() override;
 
  void SetToZero() override;
  const SEScalar* GetScalar(const std::string& name) override;
 
  virtual void Balance(BalanceLiquidBy e);// Balance Substance based on a specific property
 
  virtual bool HasConcentration() const;
  virtual SEScalarMassPerVolume& GetConcentration();
  virtual double GetConcentration(const MassPerVolumeUnit& unit) const;
 
  virtual bool HasMass() const;
  virtual SEScalarMass& GetMass();
  virtual double GetMass(const MassUnit& unit) const;
 
  virtual bool HasMassCleared() const;
  virtual SEScalarMass& GetMassCleared();
  virtual double GetMassCleared(const MassUnit& unit) const;
 
  virtual bool HasMassDeposited() const;
  virtual SEScalarMass& GetMassDeposited();
  virtual double GetMassDeposited(const MassUnit& unit) const;
 
  virtual bool HasMassExcreted() const;
  virtual SEScalarMass& GetMassExcreted();
  virtual double GetMassExcreted(const MassUnit& unit) const;
  
  virtual bool HasMolarity() const;
  virtual SEScalarAmountPerVolume& GetMolarity();
  virtual double GetMolarity(const AmountPerVolumeUnit& unit) const;
  
  virtual bool HasPartialPressure() const;
  virtual SEScalarPressure& GetPartialPressure();
  virtual double GetPartialPressure(const PressureUnit& unit) const;
 
  virtual bool HasSaturation() const;
  virtual SEScalar0To1& GetSaturation();
  virtual double GetSaturation() const;
  virtual void SetHemoglobins(const SESubstance& Hb, const SESubstance& HbO2, const SESubstance& HbCO2, const SESubstance& HbO2CO2, const SESubstance& HbCO);
 
protected:
  virtual void AddChild(SELiquidSubstanceQuantity& subQ);
 
  bool HasExtensive() const override { return HasMass(); }
  SEScalarMass& GetExtensive() override { return GetMass(); }
 
  bool HasIntensive() const override { return HasConcentration(); }
  SEScalarMassPerVolume& GetIntensive() override { return GetConcentration(); }
 
  SEScalarMassPerVolume*   m_Concentration;
  SEScalarMass*            m_Mass;
  SEScalarMass*            m_MassCleared;
  SEScalarMass*            m_MassDeposited;
  SEScalarMass*            m_MassExcreted;
  SEScalarAmountPerVolume* m_Molarity;
  SEScalarPressure*        m_PartialPressure;
  SEScalar0To1*            m_Saturation;
 
  SELiquidCompartment&     m_Compartment;
  std::vector<SELiquidSubstanceQuantity*> m_Children;
 
  bool m_isO2;
  bool m_isCO;
  bool m_isCO2;
  // Inorder to caluclate a hierarchical saturation, we need these substances
  const SESubstance* m_Hb;
  const SESubstance* m_HbO2;
  const SESubstance* m_HbCO2;
  const SESubstance* m_HbO2CO2;
  const SESubstance* m_HbCO;
};