Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE > Class Template Reference

#include <SEFluidCompartmentLink.h>

Inherits SECompartmentLink, and EdgeType.

Public Member Functions

virtual ~SEFluidCompartmentLink ()
 
void Clear () override
 
const SEScalar * GetScalar (const std::string &name) override
 
std::string GetName () const override
 
virtual bool HasCompliance () const
 
virtual double GetCompliance (const VolumePerPressureUnit &unit) const
 
virtual bool HasFlow () const
 
virtual SEScalarVolumePerTime & GetFlow ()
 
virtual double GetFlow (const VolumePerTimeUnit &unit) const
 
virtual bool HasResistance () const
 
virtual double GetResistance (const PressureTimePerVolumeUnit &unit) const
 
virtual CompartmentType & GetSourceCompartment ()
 
virtual CompartmentType & GetTargetCompartment ()
 
virtual bool HasPath ()
 
virtual SEFluidCircuitPath * GetPath ()
 
virtual void RemovePath ()
 
virtual void MapPath (SEFluidCircuitPath &path)
 
- Public Member Functions inherited from SECompartmentLink
virtual ~SECompartmentLink ()
 
virtual void Clear ()
 
virtual std::string GetName () const
 
virtual const SEScalar * GetScalar (const std::string &name)=0
 
- Public Member Functions inherited from Loggable
 Loggable (Logger *logger=nullptr)
 
 Loggable (std::string const &logfile)
 
virtual ~Loggable ()
 
virtual Logger * GetLogger () const
 
virtual void SetLogger (Logger &logger)
 
virtual void Debug (std::string const &msg) const
 
virtual void Debug (std::stringstream &msg) const
 
virtual void Debug (std::ostream &msg) const
 
virtual void Info (std::string const &msg) const
 
virtual void Info (std::stringstream &msg) const
 
virtual void Info (const std::stringstream &msg) const
 
virtual void Info (std::ostream &msg) const
 
virtual void Warning (std::string const &msg) const
 
virtual void Warning (std::stringstream &msg) const
 
virtual void Warning (std::ostream &msg) const
 
virtual void Error (std::string const &msg) const
 
virtual void Error (std::stringstream &msg) const
 
virtual void Error (std::ostream &msg) const
 
virtual void Fatal (std::string const &msg) const
 
virtual void Fatal (std::stringstream &msg) const
 
virtual void Fatal (std::ostream &msg) const
 

Protected Member Functions

 SEFluidCompartmentLink (CompartmentType &src, CompartmentType &tgt, const std::string &name)
 
bool HasFlux () const override
 
SEScalarVolumePerTime & GetFlux () override
 
virtual double GetFlux (const VolumePerTimeUnit &unit) const
 
VertexType & GetSourceVertex () override
 
VertexType & GetTargetVertex () override
 
- Protected Member Functions inherited from SECompartmentLink
 SECompartmentLink (const std::string &nam, Logger *logger)
 

Protected Attributes

SEScalarVolumePerTime * m_Flow
 
CompartmentType & m_SourceCmpt
 
CompartmentType & m_TargetCmpt
 
VertexType & m_SourceVertex
 
VertexType & m_TargetVertex
 
SEFluidCircuitPath * m_Path
 
- Protected Attributes inherited from SECompartmentLink
std::string m_Name
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Logger * m_Logger
 

Friends

class PBCompartment
 

Constructor & Destructor Documentation

◆ SEFluidCompartmentLink()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::SEFluidCompartmentLink ( CompartmentType &  src,
CompartmentType &  tgt,
const std::string &  name 
)
protected

◆ ~SEFluidCompartmentLink()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::~SEFluidCompartmentLink
virtual

Member Function Documentation

◆ Clear()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
void SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::Clear
overridevirtual

Reimplemented from SECompartmentLink.

◆ GetCompliance()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
double SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetCompliance ( const VolumePerPressureUnit &  unit) const
virtual

◆ GetFlow() [1/2]

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEScalarVolumePerTime & SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlow
virtual

◆ GetFlow() [2/2]

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
double SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlow ( const VolumePerTimeUnit &  unit) const
virtual

◆ GetFlux() [1/2]

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEScalarVolumePerTime & SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlux ( )
inlineoverrideprotected

◆ GetFlux() [2/2]

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual double SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetFlux ( const VolumePerTimeUnit &  unit) const
inlineprotectedvirtual

◆ GetName()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
std::string SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetName ( ) const
inlineoverridevirtual

Reimplemented from SECompartmentLink.

◆ GetPath()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual SEFluidCircuitPath * SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetPath ( )
inlinevirtual

◆ GetResistance()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
double SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetResistance ( const PressureTimePerVolumeUnit &  unit) const
virtual

◆ GetScalar()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
const SEScalar * SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetScalar ( const std::string &  name)
overridevirtual

Implements SECompartmentLink.

◆ GetSourceCompartment()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual CompartmentType & SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetSourceCompartment ( )
inlinevirtual

◆ GetSourceVertex()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
VertexType & SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetSourceVertex ( )
inlineoverrideprotected

◆ GetTargetCompartment()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual CompartmentType & SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetTargetCompartment ( )
inlinevirtual

◆ GetTargetVertex()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
VertexType & SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::GetTargetVertex ( )
inlineoverrideprotected

◆ HasCompliance()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
bool SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasCompliance
virtual

◆ HasFlow()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
bool SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasFlow
virtual

◆ HasFlux()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
bool SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasFlux ( ) const
inlineoverrideprotected

◆ HasPath()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual bool SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasPath ( )
inlinevirtual

◆ HasResistance()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
bool SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::HasResistance
virtual

◆ MapPath()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual void SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::MapPath ( SEFluidCircuitPath &  path)
inlinevirtual

◆ RemovePath()

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
virtual void SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::RemovePath ( )
inlinevirtual

Friends And Related Function Documentation

◆ PBCompartment

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
friend class PBCompartment
friend

Member Data Documentation

◆ m_Flow

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEScalarVolumePerTime* SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_Flow
protected

◆ m_Path

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
SEFluidCircuitPath* SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_Path
protected

◆ m_SourceCmpt

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
CompartmentType& SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_SourceCmpt
protected

◆ m_SourceVertex

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
VertexType& SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_SourceVertex
protected

◆ m_TargetCmpt

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
CompartmentType& SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_TargetCmpt
protected

◆ m_TargetVertex

template<FLUID_COMPARTMENT_LINK_TEMPLATE >
VertexType& SEFluidCompartmentLink< FLUID_COMPARTMENT_LINK_TEMPLATE >::m_TargetVertex
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.