#include <SELiquidBlackBox.h>

Inherits SEFluidBlackBox.

Public Member Functions

virtual ~SELiquidBlackBox ()
 
virtual void Clear ()
 
virtual bool HasCompartment () const
 
virtual SELiquidCompartmentGetCompartment ()
 
virtual const SELiquidCompartmentGetCompartment () const
 
virtual bool HasSourceCompartment () const
 
virtual SELiquidCompartmentGetSourceCompartment ()
 
virtual const SELiquidCompartmentGetSourceCompartment () const
 
virtual bool HasTargetCompartment () const
 
virtual SELiquidCompartmentGetTargetCompartment ()
 
virtual const SELiquidCompartmentGetTargetCompartment () const
 
virtual bool HasSourceLink () const
 
virtual SELiquidCompartmentLinkGetSourceLink ()
 
virtual const SELiquidCompartmentLinkGetSourceLink () const
 
virtual bool HasTargetLink () const
 
virtual SELiquidCompartmentLinkGetTargetLink ()
 
virtual const SELiquidCompartmentLinkGetTargetLink () const
 
- Public Member Functions inherited from SEFluidBlackBox
virtual ~SEFluidBlackBox ()
 
- Public Member Functions inherited from SEBlackBox< FLUID_BLACK_BOX >
virtual ~SEBlackBox ()
 
virtual std::string GetName () const
 
virtual void ProvideSourceFlux ()
 
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 ProvideTargetFlux ()
 
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 ProvidePotential ()
 
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 ProvideSourcePotential ()
 
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 ProvideTargetPotential ()
 
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 ProvideQuantity ()
 
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
 
- Public Member Functions inherited from Loggable
 Loggable (Logger *logger=nullptr)
 
 Loggable (std::string const &logfile)
 
virtual ~Loggable ()
 
virtual LoggerGetLogger () const
 
virtual void SetLogger (Logger &logger)
 
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

 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 bool HasNode () const
 
virtual NodeType * GetNode () const
 
virtual void SetNode (NodeType *n)
 
virtual bool HasSourceNode () const
 
virtual NodeType * GetSourceNode () const
 
virtual void SetSourceNode (NodeType *n)
 
virtual bool HasTargetNode () const
 
virtual NodeType * GetTargetNode () const
 
virtual void SetTargetNode (NodeType *n)
 
virtual bool HasSourcePath () const
 
virtual PathType * GetSourcePath () const
 
virtual void SetSourcePath (PathType *p)
 
virtual bool HasTargetPath () const
 
virtual PathType * GetTargetPath () const
 
virtual void SetTargetPath (PathType *p)
 

Protected Attributes

SELiquidCompartmentm_Compartment = nullptr
 
SELiquidCompartmentm_srcCompartment = nullptr
 
SELiquidCompartmentm_tgtCompartment = nullptr
 
SELiquidCompartmentLinkm_srcLink = nullptr
 
SELiquidCompartmentLinkm_tgtLink = nullptr
 
- Protected Attributes inherited from SEBlackBox< FLUID_BLACK_BOX >
std::string m_Name
 
NodeType * m_Node
 
NodeType * m_SourceNode
 
NodeType * m_TargetNode
 
PathType * m_SourcePath
 
PathType * m_TargetPath
 
eBlackBox_Property_Type m_SourceFlux
 
eBlackBox_Property_Type m_TargetFlux
 
eBlackBox_Property_Type m_SourcePotential
 
eBlackBox_Property_Type m_TargetPotential
 
eBlackBox_Property_Type m_Potential
 
eBlackBox_Property_Type m_Quantity
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Loggerm_Logger
 

Friends

class SEBlackBoxManager
 

Additional Inherited Members

- Static Public Attributes inherited from Loggable
static const std::string empty
 

Constructor & Destructor Documentation

◆ SELiquidBlackBox()

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

◆ ~SELiquidBlackBox()

SELiquidBlackBox::~SELiquidBlackBox ( )
virtual

Member Function Documentation

◆ Clear()

void SELiquidBlackBox::Clear ( )
virtual

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.