What’s New in the Pulse Physiology Engine 4.4.0
×

#include <SELiquidBlackBox.h>

Inherits SEFluidBlackBox.

Public Member Functions

virtual ~SELiquidBlackBox ()
 
void Clear () override
 
virtual bool HasCompartment () const
 
virtual SELiquidCompartment & GetCompartment ()
 
virtual const SELiquidCompartment & GetCompartment () const
 
virtual bool HasSourceCompartment () const
 
virtual SELiquidCompartment & GetSourceCompartment ()
 
virtual const SELiquidCompartment & GetSourceCompartment () const
 
virtual bool HasTargetCompartment () const
 
virtual SELiquidCompartment & GetTargetCompartment ()
 
virtual const SELiquidCompartment & GetTargetCompartment () const
 
virtual bool HasSourceLink () const
 
virtual SELiquidCompartmentLink & GetSourceLink ()
 
virtual const SELiquidCompartmentLink & GetSourceLink () const
 
virtual bool HasTargetLink () const
 
virtual SELiquidCompartmentLink & GetTargetLink ()
 
virtual const SELiquidCompartmentLink & GetTargetLink () const
 
- Public Member Functions inherited from SEFluidBlackBox
virtual ~SEFluidBlackBox ()
 
- Public Member Functions inherited from SEBlackBox< FLUID_BLACK_BOX >
virtual ~SEBlackBox ()
 
virtual void Clear ()
 
virtual std::string GetName () const
 
virtual void RemoveImposedPotential ()
 
virtual bool IsPotentialImposed () const
 
virtual void ImposePotential (double v, const PotentialUnit &unit)
 
virtual void ImposePotential (const PotentialScalar &s)
 
virtual double GetPotential (const PotentialUnit &unit) const
 
virtual void RemoveImposedSourcePotential ()
 
virtual bool IsSourcePotentialImposed () const
 
virtual void ImposeSourcePotential (double v, const PotentialUnit &unit)
 
virtual void ImposeSourcePotential (const PotentialScalar &s)
 
virtual double GetSourcePotential (const PotentialUnit &unit) const
 
virtual void RemoveImposedTargetPotential ()
 
virtual bool IsTargetPotentialImposed () const
 
virtual void ImposeTargetPotential (double v, const PotentialUnit &unit)
 
virtual void ImposeTargetPotential (const PotentialScalar &s)
 
virtual double GetTargetPotential (const PotentialUnit &unit) const
 
virtual void RemoveImposedSourceFlux ()
 
virtual bool IsSourceFluxImposed () const
 
virtual void ImposeSourceFlux (double v, const FluxUnit &unit)
 
virtual void ImposeSourceFlux (const FluxScalar &s)
 
virtual double GetSourceFlux (const FluxUnit &unit) const
 
virtual void RemoveImposedTargetFlux ()
 
virtual bool IsTargetFluxImposed () const
 
virtual void ImposeTargetFlux (double v, const FluxUnit &unit)
 
virtual void ImposeTargetFlux (const FluxScalar &s)
 
virtual double GetTargetFlux (const FluxUnit &unit) const
 
virtual void RemoveImposedQuantity ()
 
virtual bool IsQuantityImposed () const
 
virtual void ImposeQuantity (double v, const QuantityUnit &unit)
 
virtual void ImposeQuantity (const QuantityScalar &s)
 
virtual double GetQuantity (const QuantityUnit &unit) const
 
virtual bool HasMiddleNode () const
 
virtual NodeType * GetMiddleNode () const
 
virtual bool HasSourceNode () const
 
virtual NodeType * GetSourceNode () const
 
virtual bool HasTargetNode () const
 
virtual NodeType * GetTargetNode () const
 
virtual bool HasSourcePath () const
 
virtual PathType * GetSourcePath () const
 
virtual bool HasTargetPath () const
 
virtual PathType * GetTargetPath () const
 
- 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

 SELiquidBlackBox (const std::string &name, Logger *logger)
 
virtual void SetCompartment (SELiquidCompartment *c)
 
virtual void SetSourceCompartment (SELiquidCompartment *c)
 
virtual void SetTargetCompartment (SELiquidCompartment *c)
 
virtual void SetSourceLink (SELiquidCompartmentLink *l)
 
virtual void SetTargetLink (SELiquidCompartmentLink *l)
 
- Protected Member Functions inherited from SEFluidBlackBox
 SEFluidBlackBox (const std::string &name, Logger *logger)
 
- Protected Member Functions inherited from SEBlackBox< FLUID_BLACK_BOX >
 SEBlackBox (const std::string &name, Logger *logger)
 
virtual void SetMiddleNode (NodeType *n)
 
virtual void SetSourceNode (NodeType *n)
 
virtual void SetTargetNode (NodeType *n)
 
virtual void SetSourcePath (PathType *p)
 
virtual void SetTargetPath (PathType *p)
 

Protected Attributes

SELiquidCompartment * m_Compartment = nullptr
 
SELiquidCompartment * m_srcCompartment = nullptr
 
SELiquidCompartment * m_tgtCompartment = nullptr
 
SELiquidCompartmentLink * m_srcLink = nullptr
 
SELiquidCompartmentLink * m_tgtLink = nullptr
 
- Protected Attributes inherited from SEBlackBox< FLUID_BLACK_BOX >
std::string m_Name
 
NodeType * m_MiddleNode
 
NodeType * m_SourceNode
 
NodeType * m_TargetNode
 
PathType * m_SourcePath
 
PathType * m_TargetPath
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Logger * m_Logger
 

Friends

class SEBlackBoxManager
 

Constructor & Destructor Documentation

◆ SELiquidBlackBox()

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

◆ ~SELiquidBlackBox()

SELiquidBlackBox::~SELiquidBlackBox ( )
virtual

Member Function Documentation

◆ Clear()

void SELiquidBlackBox::Clear ( )
overridevirtual

Reimplemented from SEBlackBox< FLUID_BLACK_BOX >.

◆ GetCompartment() [1/2]

virtual SELiquidCompartment & SELiquidBlackBox::GetCompartment ( )
inlinevirtual

◆ GetCompartment() [2/2]

virtual const SELiquidCompartment & SELiquidBlackBox::GetCompartment ( ) const
inlinevirtual

◆ GetSourceCompartment() [1/2]

virtual SELiquidCompartment & SELiquidBlackBox::GetSourceCompartment ( )
inlinevirtual

◆ GetSourceCompartment() [2/2]

virtual const SELiquidCompartment & SELiquidBlackBox::GetSourceCompartment ( ) const
inlinevirtual

◆ GetSourceLink() [1/2]

virtual SELiquidCompartmentLink & SELiquidBlackBox::GetSourceLink ( )
inlinevirtual

◆ GetSourceLink() [2/2]

virtual const SELiquidCompartmentLink & SELiquidBlackBox::GetSourceLink ( ) const
inlinevirtual

◆ GetTargetCompartment() [1/2]

virtual SELiquidCompartment & SELiquidBlackBox::GetTargetCompartment ( )
inlinevirtual

◆ GetTargetCompartment() [2/2]

virtual const SELiquidCompartment & SELiquidBlackBox::GetTargetCompartment ( ) const
inlinevirtual

◆ GetTargetLink() [1/2]

virtual SELiquidCompartmentLink & SELiquidBlackBox::GetTargetLink ( )
inlinevirtual

◆ GetTargetLink() [2/2]

virtual const SELiquidCompartmentLink & SELiquidBlackBox::GetTargetLink ( ) const
inlinevirtual

◆ HasCompartment()

virtual bool SELiquidBlackBox::HasCompartment ( ) const
inlinevirtual

◆ HasSourceCompartment()

virtual bool SELiquidBlackBox::HasSourceCompartment ( ) const
inlinevirtual

◆ HasSourceLink()

virtual bool SELiquidBlackBox::HasSourceLink ( ) const
inlinevirtual

◆ HasTargetCompartment()

virtual bool SELiquidBlackBox::HasTargetCompartment ( ) const
inlinevirtual

◆ HasTargetLink()

virtual bool SELiquidBlackBox::HasTargetLink ( ) const
inlinevirtual

◆ SetCompartment()

virtual void SELiquidBlackBox::SetCompartment ( SELiquidCompartment *  c)
inlineprotectedvirtual

◆ SetSourceCompartment()

virtual void SELiquidBlackBox::SetSourceCompartment ( SELiquidCompartment *  c)
inlineprotectedvirtual

◆ SetSourceLink()

virtual void SELiquidBlackBox::SetSourceLink ( SELiquidCompartmentLink *  l)
inlineprotectedvirtual

◆ SetTargetCompartment()

virtual void SELiquidBlackBox::SetTargetCompartment ( SELiquidCompartment *  c)
inlineprotectedvirtual

◆ SetTargetLink()

virtual void SELiquidBlackBox::SetTargetLink ( SELiquidCompartmentLink *  l)
inlineprotectedvirtual

Friends And Related Function Documentation

◆ SEBlackBoxManager

friend class SEBlackBoxManager
friend

Member Data Documentation

◆ m_Compartment

SELiquidCompartment* SELiquidBlackBox::m_Compartment = nullptr
protected

◆ m_srcCompartment

SELiquidCompartment* SELiquidBlackBox::m_srcCompartment = nullptr
protected

◆ m_srcLink

SELiquidCompartmentLink* SELiquidBlackBox::m_srcLink = nullptr
protected

◆ m_tgtCompartment

SELiquidCompartment* SELiquidBlackBox::m_tgtCompartment = nullptr
protected

◆ m_tgtLink

SELiquidCompartmentLink* SELiquidBlackBox::m_tgtLink = nullptr
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.