#include <SELiquidCompartment.h>

Inherits SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >.

Public Member Functions

virtual ~SELiquidCompartment ()
 
virtual void Clear ()
 
virtual const SEScalarGetScalar (const std::string &name)
 
virtual void StateChange ()
 
virtual void Balance (BalanceLiquidBy e)
 
virtual bool HasPH () const
 
virtual SEScalarGetPH ()
 
virtual double GetPH () const
 
virtual bool HasWaterVolumeFraction () const
 
virtual SEScalar0To1GetWaterVolumeFraction ()
 
virtual double GetWaterVolumeFraction () const
 
virtual void AddChild (SELiquidCompartment &child)
 
virtual const std::vector< SELiquidCompartment * > & GetChildren ()
 
virtual const std::vector< SELiquidCompartment * > & GetLeaves ()
 
- Public Member Functions inherited from SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >
virtual ~SEFluidCompartment ()
 
virtual std::string GetName () const
 
virtual bool HasChildren () const
 
virtual bool HasNodeMapping () const
 
virtual SECompartmentNodes< FLUID_COMPARTMENT_NODE > & GetNodeMapping ()
 
virtual void MapNode (SEFluidCircuitNode &node)
 
virtual bool HasInFlow () const
 
virtual const SEScalarVolumePerTimeGetInFlow () const
 
virtual double GetInFlow (const VolumePerTimeUnit &unit) const
 
virtual bool HasOutFlow () const
 
virtual const SEScalarVolumePerTimeGetOutFlow () const
 
virtual double GetOutFlow (const VolumePerTimeUnit &unit) const
 
virtual bool HasPressure () const
 
virtual SEScalarPressureGetPressure ()
 
virtual double GetPressure (const PressureUnit &unit) const
 
virtual bool HasVolume () const
 
virtual SEScalarVolumeGetVolume ()
 
virtual double GetVolume (const VolumeUnit &unit) const
 
virtual bool HasSubstanceQuantities () const
 
virtual bool HasSubstanceQuantity (const SESubstance &substance) const
 
virtual SubstanceQuantityType * GetSubstanceQuantity (const SESubstance &substance) const
 
virtual const std::vector< SubstanceQuantityType *> & GetSubstanceQuantities () const
 
virtual void ZeroSubstanceQuantities ()
 
virtual void AddLink (LinkType &link)
 
virtual void RemoveLink (LinkType &link)
 
virtual void RemoveLinks ()
 
virtual const std::vector< LinkType *> & GetLinks ()
 
virtual bool HasChild (const std::string &name)
 
- Public Member Functions inherited from SECompartment
virtual ~SECompartment ()
 
- Public Member Functions inherited from Loggable
 Loggable ()
 
 Loggable (Logger *log)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
virtual void Debug (std::string const &msg, std::string const &origin=empty) const
 
virtual void Debug (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Debug (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Info (std::string const &msg, std::string const &origin=empty) const
 
virtual void Info (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Info (const std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Info (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Warning (std::string const &msg, std::string const &origin=empty) const
 
virtual void Warning (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Warning (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Error (std::string const &msg, std::string const &origin=empty) const
 
virtual void Error (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Error (std::ostream &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::string const &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::stringstream &msg, std::string const &origin=empty) const
 
virtual void Fatal (std::ostream &msg, std::string const &origin=empty) const
 

Protected Member Functions

 SELiquidCompartment (const std::string &name, Logger *logger)
 
virtual SELiquidSubstanceQuantityCreateSubstanceQuantity (SESubstance &substance)
 
- Protected Member Functions inherited from SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >
 SEFluidCompartment (const std::string &name, Logger *logger)
 
virtual void RemoveSubstanceQuantity (const SESubstance &substance)
 
virtual bool HasQuantity () const
 
virtual SEScalarVolumeGetQuantity ()
 
virtual double CalculateInFlow_mL_Per_s () const
 
virtual double CalculateOutFlow_mL_Per_s () const
 
virtual std::vector< TransportSubstanceType *> & GetTransportSubstances ()
 
- Protected Member Functions inherited from SECompartment
 SECompartment (const std::string &name, Logger *logger)
 

Protected Attributes

SEScalarm_pH
 
SEScalar0To1m_WaterVolumeFraction
 
std::vector< SELiquidCompartment * > m_Children
 
std::vector< SELiquidCompartment * > m_Leaves
 
- Protected Attributes inherited from SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >
SEScalarVolumePerTimem_InFlow
 
SEScalarVolumePerTimem_OutFlow
 
SEScalarPressurem_Pressure
 
SEScalarVolumem_Volume
 
std::vector< SubstanceQuantityType *> m_SubstanceQuantities
 
std::vector< TransportSubstanceType *> m_TransportSubstances
 
std::vector< LinkType *> m_Links
 
std::vector< LinkType *> m_IncomingLinks
 
std::vector< LinkType *> m_OutgoingLinks
 
std::vector< SEFluidCompartment *> m_FluidChildren
 
SECompartmentNodes< FLUID_COMPARTMENT_NODE > m_Nodes
 
- Protected Attributes inherited from SECompartment
std::string m_Name
 
- Protected Attributes inherited from Loggable
Loggerm_Logger
 

Friends

class PBCompartment
 
class SETissueCompartment
 
class SECompartmentManager
 
class SELiquidSubstanceQuantity
 

Additional Inherited Members

- Static Public Member Functions inherited from SECompartment
template<typename CompartmentType >
static void FindLeaves (CompartmentType &cmpt, std::vector< CompartmentType *> &leaves)
 
- Static Public Attributes inherited from Loggable
static const std::string empty
 

Constructor & Destructor Documentation

◆ SELiquidCompartment()

SELiquidCompartment::SELiquidCompartment ( const std::string &  name,
Logger logger 
)
protected

◆ ~SELiquidCompartment()

SELiquidCompartment::~SELiquidCompartment ( )
virtual

Member Function Documentation

◆ AddChild()

void SELiquidCompartment::AddChild ( SELiquidCompartment child)
virtual

◆ Balance()

void SELiquidCompartment::Balance ( BalanceLiquidBy  e)
virtual

◆ Clear()

◆ CreateSubstanceQuantity()

SELiquidSubstanceQuantity & SELiquidCompartment::CreateSubstanceQuantity ( SESubstance substance)
protectedvirtual

◆ GetChildren()

virtual const std::vector<SELiquidCompartment*>& SELiquidCompartment::GetChildren ( )
inlinevirtual

◆ GetLeaves()

virtual const std::vector<SELiquidCompartment*>& SELiquidCompartment::GetLeaves ( )
inlinevirtual

◆ GetPH() [1/2]

SEScalar & SELiquidCompartment::GetPH ( )
virtual

◆ GetPH() [2/2]

double SELiquidCompartment::GetPH ( ) const
virtual

◆ GetScalar()

const SEScalar * SELiquidCompartment::GetScalar ( const std::string &  name)
virtual

◆ GetWaterVolumeFraction() [1/2]

SEScalar0To1 & SELiquidCompartment::GetWaterVolumeFraction ( )
virtual

◆ GetWaterVolumeFraction() [2/2]

double SELiquidCompartment::GetWaterVolumeFraction ( ) const
virtual

◆ HasPH()

bool SELiquidCompartment::HasPH ( ) const
virtual

◆ HasWaterVolumeFraction()

bool SELiquidCompartment::HasWaterVolumeFraction ( ) const
virtual

◆ StateChange()

void SELiquidCompartment::StateChange ( )
virtual

Implements SECompartment.

Friends And Related Function Documentation

◆ PBCompartment

friend class PBCompartment
friend

◆ SECompartmentManager

friend class SECompartmentManager
friend

◆ SELiquidSubstanceQuantity

friend class SELiquidSubstanceQuantity
friend

◆ SETissueCompartment

friend class SETissueCompartment
friend

Member Data Documentation

◆ m_Children

std::vector<SELiquidCompartment*> SELiquidCompartment::m_Children
protected

◆ m_Leaves

std::vector<SELiquidCompartment*> SELiquidCompartment::m_Leaves
protected

◆ m_pH

SEScalar* SELiquidCompartment::m_pH
protected

◆ m_WaterVolumeFraction

SEScalar0To1* SELiquidCompartment::m_WaterVolumeFraction
protected