Building Medical Digital Twins with Pulse: Open Source Simulation Tools for Developers and Researchers
Webinar
×
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
SEFluidCircuitPath Class Reference

#include <SEFluidCircuitPath.h>

Inheritance diagram for SEFluidCircuitPath:
SECircuitPath< FLUID_CIRCUIT_PATH > Loggable

Public Member Functions

virtual ~SEFluidCircuitPath ()
 
void Clear () override
 
SEFluidCircuitNode & GetSourceNode () const override
 
SEFluidCircuitNode & GetTargetNode () const override
 
virtual bool HasFlow () const
 
virtual SEScalarVolumePerTime & GetFlow ()
 
virtual double GetFlow (const VolumePerTimeUnit &unit) const
 
virtual bool HasNextFlow () const
 
virtual SEScalarVolumePerTime & GetNextFlow ()
 
virtual double GetNextFlow (const VolumePerTimeUnit &unit) const
 
bool HasResistance () const override
 
SEScalarPressureTimePerVolume & GetResistance () override
 
virtual double GetResistance (const PressureTimePerVolumeUnit &unit) const
 
bool HasNextResistance () const override
 
SEScalarPressureTimePerVolume & GetNextResistance () override
 
virtual double GetNextResistance (const PressureTimePerVolumeUnit &unit) const
 
bool HasResistanceBaseline () const override
 
SEScalarPressureTimePerVolume & GetResistanceBaseline () override
 
virtual double GetResistanceBaseline (const PressureTimePerVolumeUnit &unit) const
 
virtual void RemoveResistance () override
 
virtual bool HasCompliance () const
 
virtual SEScalarVolumePerPressure & GetCompliance ()
 
virtual double GetCompliance (const VolumePerPressureUnit &unit) const
 
virtual bool HasNextCompliance () const
 
virtual SEScalarVolumePerPressure & GetNextCompliance ()
 
virtual double GetNextCompliance (const VolumePerPressureUnit &unit) const
 
virtual bool HasComplianceBaseline () const
 
virtual SEScalarVolumePerPressure & GetComplianceBaseline ()
 
virtual double GetComplianceBaseline (const VolumePerPressureUnit &unit) const
 
virtual void RemoveCompliance ()
 
virtual bool HasInertance () const
 
virtual SEScalarPressureTimeSquaredPerVolume & GetInertance ()
 
virtual double GetInertance (const PressureTimeSquaredPerVolumeUnit &unit) const
 
virtual bool HasNextInertance () const
 
virtual SEScalarPressureTimeSquaredPerVolume & GetNextInertance ()
 
virtual double GetNextInertance (const PressureTimeSquaredPerVolumeUnit &unit) const
 
virtual bool HasInertanceBaseline () const
 
virtual SEScalarPressureTimeSquaredPerVolume & GetInertanceBaseline ()
 
virtual double GetInertanceBaseline (const PressureTimeSquaredPerVolumeUnit &unit) const
 
virtual void RemoveInertance ()
 
virtual bool HasFlowSource () const
 
virtual SEScalarVolumePerTime & GetFlowSource ()
 
virtual double GetFlowSource (const VolumePerTimeUnit &unit) const
 
virtual bool HasNextFlowSource () const
 
virtual SEScalarVolumePerTime & GetNextFlowSource ()
 
virtual double GetNextFlowSource (const VolumePerTimeUnit &unit) const
 
virtual bool HasFlowSourceBaseline () const
 
virtual SEScalarVolumePerTime & GetFlowSourceBaseline ()
 
virtual double GetFlowSourceBaseline (const VolumePerTimeUnit &unit) const
 
virtual void RemoveFlowSource ()
 
virtual bool HasPressureSource () const
 
virtual SEScalarPressure & GetPressureSource ()
 
virtual double GetPressureSource (const PressureUnit &unit) const
 
virtual bool HasNextPressureSource () const
 
virtual SEScalarPressure & GetNextPressureSource ()
 
virtual double GetNextPressureSource (const PressureUnit &unit) const
 
virtual bool HasPressureSourceBaseline () const
 
virtual SEScalarPressure & GetPressureSourceBaseline ()
 
virtual double GetPressureSourceBaseline (const PressureUnit &unit) const
 
virtual void RemovePressureSource ()
 
virtual bool HasValveBreakdownPressure () const
 
virtual SEScalarPressure & GetValveBreakdownPressure ()
 
virtual double GetValveBreakdownPressure (const PressureUnit &unit) const
 
- Public Member Functions inherited from SECircuitPath< FLUID_CIRCUIT_PATH >
virtual ~SECircuitPath ()
 
virtual std::string GetName () const
 
virtual bool IsPartOfBlackBox () const
 
virtual void SetPartOfBlackBox (bool b)
 
virtual bool HasFlux () const
 
virtual FluxScalar & GetFlux ()
 
virtual bool HasNextFlux () const
 
virtual FluxScalar & GetNextFlux ()
 
virtual bool HasFluxSource () const
 
virtual FluxScalar & GetFluxSource ()
 
virtual bool HasNextFluxSource () const
 
virtual FluxScalar & GetNextFluxSource ()
 
virtual bool HasFluxSourceBaseline () const
 
virtual FluxScalar & GetFluxSourceBaseline ()
 
virtual void RemoveFluxSource ()
 
virtual void RemoveImposedFlux ()
 
virtual bool IsFluxImposed () const
 
virtual void ImposeFlux (const FluxScalar &s)
 
virtual void ImposeFlux (double v, const FluxUnit &unit)
 
virtual bool HasCapacitance () const
 
virtual CapacitanceScalar & GetCapacitance ()
 
virtual bool HasNextCapacitance () const
 
virtual CapacitanceScalar & GetNextCapacitance ()
 
virtual bool HasCapacitanceBaseline () const
 
virtual CapacitanceScalar & GetCapacitanceBaseline ()
 
virtual void RemoveCapacitance ()
 
virtual bool HasInductance () const
 
virtual InductanceScalar & GetInductance ()
 
virtual bool HasNextInductance () const
 
virtual InductanceScalar & GetNextInductance ()
 
virtual bool HasInductanceBaseline () const
 
virtual InductanceScalar & GetInductanceBaseline ()
 
virtual void RemoveInductance ()
 
virtual bool HasPotentialSource () const
 
virtual PotentialScalar & GetPotentialSource ()
 
virtual bool HasNextPotentialSource () const
 
virtual PotentialScalar & GetNextPotentialSource ()
 
virtual bool HasPotentialSourceBaseline () const
 
virtual PotentialScalar & GetPotentialSourceBaseline ()
 
virtual void RemovePotentialSource ()
 
virtual bool HasValveBreakdownPotential () const
 
virtual PotentialScalar & GetValveBreakdownPotential ()
 
virtual eGate GetSwitch () const
 
virtual void SetSwitch (eGate state)
 
virtual void FlipSwitch ()
 
virtual bool HasSwitch () const
 
virtual void InvalidateSwitch ()
 
virtual eGate GetNextSwitch () const
 
virtual void SetNextSwitch (eGate state)
 
virtual void FlipNextSwitch ()
 
virtual bool HasNextSwitch () const
 
virtual void InvalidateNextSwitch ()
 
virtual void RemoveSwitch ()
 
virtual eGate GetValve () const
 
virtual void SetValve (eGate state)
 
virtual void FlipValve ()
 
virtual bool HasValve () const
 
virtual void InvalidateValve ()
 
virtual eGate GetNextValve () const
 
virtual void SetNextValve (eGate state)
 
virtual void FlipNextValve ()
 
virtual bool HasNextValve () const
 
virtual void InvalidateNextValve ()
 
virtual void RemoveValve ()
 
virtual eGate GetPolarizedState () const
 
virtual void SetPolarizedState (eGate state)
 
virtual void FlipPolarizedState ()
 
virtual bool HasPolarizedState () const
 
virtual void InvalidatePolarizedState ()
 
virtual eGate GetNextPolarizedState () const
 
virtual void SetNextPolarizedState (eGate state)
 
virtual void FlipNextPolarizedState ()
 
virtual bool HasNextPolarizedState () const
 
virtual void InvalidateNextPolarizedState ()
 
virtual bool HasValidElements () const
 
virtual unsigned short NumberOfElements () const
 
virtual unsigned short NumberOfNextElements () 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

 SEFluidCircuitPath (SEFluidCircuitNode &src, SEFluidCircuitNode &tgt, const std::string &name)
 
- Protected Member Functions inherited from SECircuitPath< FLUID_CIRCUIT_PATH >
 SECircuitPath (SECircuitNode< CIRCUIT_NODE_TYPES > &src, SECircuitNode< CIRCUIT_NODE_TYPES > &tgt, const std::string &name)
 

Protected Attributes

SEFluidCircuitNode & m_FluidSourceNode
 
SEFluidCircuitNode & m_FluidTargetNode
 
- Protected Attributes inherited from SECircuitPath< FLUID_CIRCUIT_PATH >
std::string m_Name
 
SECircuitNode< CIRCUIT_NODE_TYPES > & m_SourceNode
 
SECircuitNode< CIRCUIT_NODE_TYPES > & m_TargetNode
 
unsigned short m_NumElements
 
unsigned short m_NumNextElements
 
bool m_IsPartOfBlackBox
 
eGate m_Switch
 
eGate m_NextSwitch
 
eGate m_Valve
 
eGate m_NextValve
 
eGate m_PolarizedState
 
eGate m_NextPolarizedState
 
ResistanceScalar * m_Resistance
 
ResistanceScalar * m_NextResistance
 
ResistanceScalar * m_ResistanceBaseline
 
CapacitanceScalar * m_Capacitance
 
CapacitanceScalar * m_NextCapacitance
 
CapacitanceScalar * m_CapacitanceBaseline
 
InductanceScalar * m_Inductance
 
InductanceScalar * m_NextInductance
 
InductanceScalar * m_InductanceBaseline
 
FluxScalar * m_Flux
 
FluxScalar * m_NextFlux
 
FluxScalar * m_FluxSource
 
FluxScalar * m_NextFluxSource
 
FluxScalar * m_FluxSourceBaseline
 
eBlackBox_Property_Type m_FluxType
 
PotentialScalar * m_PotentialSource
 
PotentialScalar * m_NextPotentialSource
 
PotentialScalar * m_PotentialSourceBaseline
 
PotentialScalar * m_ValveBreakdownPotential
 
- Protected Attributes inherited from Loggable
bool myLogger
 
Logger * m_Logger
 

Friends

class PBCircuit
 
class SECircuitManager
 

Constructor & Destructor Documentation

◆ SEFluidCircuitPath()

SEFluidCircuitPath::SEFluidCircuitPath ( SEFluidCircuitNode &  src,
SEFluidCircuitNode &  tgt,
const std::string &  name 
)
protected

◆ ~SEFluidCircuitPath()

SEFluidCircuitPath::~SEFluidCircuitPath ( )
virtual

Member Function Documentation

◆ Clear()

void SEFluidCircuitPath::Clear ( )
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ GetCompliance() [1/2]

SEScalarVolumePerPressure & SEFluidCircuitPath::GetCompliance ( )
virtual

◆ GetCompliance() [2/2]

double SEFluidCircuitPath::GetCompliance ( const VolumePerPressureUnit &  unit) const
virtual

◆ GetComplianceBaseline() [1/2]

SEScalarVolumePerPressure & SEFluidCircuitPath::GetComplianceBaseline ( )
virtual

◆ GetComplianceBaseline() [2/2]

double SEFluidCircuitPath::GetComplianceBaseline ( const VolumePerPressureUnit &  unit) const
virtual

◆ GetFlow() [1/2]

SEScalarVolumePerTime & SEFluidCircuitPath::GetFlow ( )
virtual

◆ GetFlow() [2/2]

double SEFluidCircuitPath::GetFlow ( const VolumePerTimeUnit &  unit) const
virtual

◆ GetFlowSource() [1/2]

SEScalarVolumePerTime & SEFluidCircuitPath::GetFlowSource ( )
virtual

◆ GetFlowSource() [2/2]

double SEFluidCircuitPath::GetFlowSource ( const VolumePerTimeUnit &  unit) const
virtual

◆ GetFlowSourceBaseline() [1/2]

SEScalarVolumePerTime & SEFluidCircuitPath::GetFlowSourceBaseline ( )
virtual

◆ GetFlowSourceBaseline() [2/2]

double SEFluidCircuitPath::GetFlowSourceBaseline ( const VolumePerTimeUnit &  unit) const
virtual

◆ GetInertance() [1/2]

SEScalarPressureTimeSquaredPerVolume & SEFluidCircuitPath::GetInertance ( )
virtual

◆ GetInertance() [2/2]

double SEFluidCircuitPath::GetInertance ( const PressureTimeSquaredPerVolumeUnit &  unit) const
virtual

◆ GetInertanceBaseline() [1/2]

SEScalarPressureTimeSquaredPerVolume & SEFluidCircuitPath::GetInertanceBaseline ( )
virtual

◆ GetInertanceBaseline() [2/2]

double SEFluidCircuitPath::GetInertanceBaseline ( const PressureTimeSquaredPerVolumeUnit &  unit) const
virtual

◆ GetNextCompliance() [1/2]

SEScalarVolumePerPressure & SEFluidCircuitPath::GetNextCompliance ( )
virtual

◆ GetNextCompliance() [2/2]

double SEFluidCircuitPath::GetNextCompliance ( const VolumePerPressureUnit &  unit) const
virtual

◆ GetNextFlow() [1/2]

SEScalarVolumePerTime & SEFluidCircuitPath::GetNextFlow ( )
virtual

◆ GetNextFlow() [2/2]

double SEFluidCircuitPath::GetNextFlow ( const VolumePerTimeUnit &  unit) const
virtual

◆ GetNextFlowSource() [1/2]

SEScalarVolumePerTime & SEFluidCircuitPath::GetNextFlowSource ( )
virtual

◆ GetNextFlowSource() [2/2]

double SEFluidCircuitPath::GetNextFlowSource ( const VolumePerTimeUnit &  unit) const
virtual

◆ GetNextInertance() [1/2]

SEScalarPressureTimeSquaredPerVolume & SEFluidCircuitPath::GetNextInertance ( )
virtual

◆ GetNextInertance() [2/2]

double SEFluidCircuitPath::GetNextInertance ( const PressureTimeSquaredPerVolumeUnit &  unit) const
virtual

◆ GetNextPressureSource() [1/2]

SEScalarPressure & SEFluidCircuitPath::GetNextPressureSource ( )
virtual

◆ GetNextPressureSource() [2/2]

double SEFluidCircuitPath::GetNextPressureSource ( const PressureUnit &  unit) const
virtual

◆ GetNextResistance() [1/2]

SEScalarPressureTimePerVolume & SEFluidCircuitPath::GetNextResistance ( )
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ GetNextResistance() [2/2]

double SEFluidCircuitPath::GetNextResistance ( const PressureTimePerVolumeUnit &  unit) const
virtual

◆ GetPressureSource() [1/2]

SEScalarPressure & SEFluidCircuitPath::GetPressureSource ( )
virtual

◆ GetPressureSource() [2/2]

double SEFluidCircuitPath::GetPressureSource ( const PressureUnit &  unit) const
virtual

◆ GetPressureSourceBaseline() [1/2]

SEScalarPressure & SEFluidCircuitPath::GetPressureSourceBaseline ( )
virtual

◆ GetPressureSourceBaseline() [2/2]

double SEFluidCircuitPath::GetPressureSourceBaseline ( const PressureUnit &  unit) const
virtual

◆ GetResistance() [1/2]

SEScalarPressureTimePerVolume & SEFluidCircuitPath::GetResistance ( )
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ GetResistance() [2/2]

double SEFluidCircuitPath::GetResistance ( const PressureTimePerVolumeUnit &  unit) const
virtual

◆ GetResistanceBaseline() [1/2]

SEScalarPressureTimePerVolume & SEFluidCircuitPath::GetResistanceBaseline ( )
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ GetResistanceBaseline() [2/2]

double SEFluidCircuitPath::GetResistanceBaseline ( const PressureTimePerVolumeUnit &  unit) const
virtual

◆ GetSourceNode()

SEFluidCircuitNode& SEFluidCircuitPath::GetSourceNode ( ) const
inlineoverridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ GetTargetNode()

SEFluidCircuitNode& SEFluidCircuitPath::GetTargetNode ( ) const
inlineoverridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ GetValveBreakdownPressure() [1/2]

SEScalarPressure & SEFluidCircuitPath::GetValveBreakdownPressure ( )
virtual

◆ GetValveBreakdownPressure() [2/2]

double SEFluidCircuitPath::GetValveBreakdownPressure ( const PressureUnit &  unit) const
virtual

◆ HasCompliance()

bool SEFluidCircuitPath::HasCompliance ( ) const
virtual

◆ HasComplianceBaseline()

bool SEFluidCircuitPath::HasComplianceBaseline ( ) const
virtual

◆ HasFlow()

bool SEFluidCircuitPath::HasFlow ( ) const
virtual

◆ HasFlowSource()

bool SEFluidCircuitPath::HasFlowSource ( ) const
virtual

◆ HasFlowSourceBaseline()

bool SEFluidCircuitPath::HasFlowSourceBaseline ( ) const
virtual

◆ HasInertance()

bool SEFluidCircuitPath::HasInertance ( ) const
virtual

◆ HasInertanceBaseline()

bool SEFluidCircuitPath::HasInertanceBaseline ( ) const
virtual

◆ HasNextCompliance()

bool SEFluidCircuitPath::HasNextCompliance ( ) const
virtual

◆ HasNextFlow()

bool SEFluidCircuitPath::HasNextFlow ( ) const
virtual

◆ HasNextFlowSource()

bool SEFluidCircuitPath::HasNextFlowSource ( ) const
virtual

◆ HasNextInertance()

bool SEFluidCircuitPath::HasNextInertance ( ) const
virtual

◆ HasNextPressureSource()

bool SEFluidCircuitPath::HasNextPressureSource ( ) const
virtual

◆ HasNextResistance()

bool SEFluidCircuitPath::HasNextResistance ( ) const
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ HasPressureSource()

bool SEFluidCircuitPath::HasPressureSource ( ) const
virtual

◆ HasPressureSourceBaseline()

bool SEFluidCircuitPath::HasPressureSourceBaseline ( ) const
virtual

◆ HasResistance()

bool SEFluidCircuitPath::HasResistance ( ) const
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ HasResistanceBaseline()

bool SEFluidCircuitPath::HasResistanceBaseline ( ) const
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

◆ HasValveBreakdownPressure()

bool SEFluidCircuitPath::HasValveBreakdownPressure ( ) const
virtual

◆ RemoveCompliance()

void SEFluidCircuitPath::RemoveCompliance ( )
virtual

◆ RemoveFlowSource()

void SEFluidCircuitPath::RemoveFlowSource ( )
virtual

◆ RemoveInertance()

void SEFluidCircuitPath::RemoveInertance ( )
virtual

◆ RemovePressureSource()

void SEFluidCircuitPath::RemovePressureSource ( )
virtual

◆ RemoveResistance()

void SEFluidCircuitPath::RemoveResistance ( )
overridevirtual

Reimplemented from SECircuitPath< FLUID_CIRCUIT_PATH >.

Friends And Related Function Documentation

◆ PBCircuit

friend class PBCircuit
friend

◆ SECircuitManager

friend class SECircuitManager
friend

Member Data Documentation

◆ m_FluidSourceNode

SEFluidCircuitNode& SEFluidCircuitPath::m_FluidSourceNode
protected

◆ m_FluidTargetNode

SEFluidCircuitNode& SEFluidCircuitPath::m_FluidTargetNode
protected

Distributed under the Apache License, Version 2.0.

See accompanying NOTICE file for details.