#include <SELiquidCompartment.h>

Inheritance diagram for biogears::SELiquidCompartment:

Public Member Functions
virtual	~SELiquidCompartment ()

virtual void	Clear () override

virtual bool	Load (const CDM::LiquidCompartmentData &in, SESubstanceManager &subMgr, SECircuitManager *circuits=nullptr)

virtual CDM::LiquidCompartmentData *	Unload () override

virtual const SEScalar *	GetScalar (const char *name) override

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

virtual void	StateChange () override

virtual void	Balance (BalanceLiquidBy by)

virtual bool	HasPH () const

virtual SEScalar &	GetPH ()

virtual double	GetPH () const

virtual bool	HasWaterVolumeFraction () const

virtual SEScalarFraction &	GetWaterVolumeFraction ()

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 biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >
virtual	~SEFluidCompartment ()

void	Clear () override

virtual bool	Load (const CDM::FluidCompartmentData &in, SECircuitManager *circuits=nullptr)

std::string	GetName () const override

const char *	GetName_cStr () const override

const SEScalar *	GetScalar (const char *name) override

const SEScalar *	GetScalar (const std::string &name) override

bool	HasChildren () const override

virtual bool	HasNodeMapping () const

virtual SECompartmentNodes< FLUID_COMPARTMENT_NODE > &	GetNodeMapping ()

virtual void	MapNode (SEFluidCircuitNode &node)

virtual bool	HasInFlow () const

virtual const SEScalarVolumePerTime &	GetInFlow ()

virtual double	GetInFlow (const VolumePerTimeUnit &unit) const

virtual bool	HasOutFlow () const

virtual const SEScalarVolumePerTime &	GetOutFlow ()

virtual double	GetOutFlow (const VolumePerTimeUnit &unit) const

virtual bool	HasPressure () const

virtual SEScalarPressure &	GetPressure ()

virtual double	GetPressure (const PressureUnit &unit) const

virtual bool	HasVolume () const

virtual SEScalarVolume &	GetVolume ()

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 char *name)

virtual bool	HasChild (const std::string &name)

Public Member Functions inherited from biogears::SECompartment
virtual	~SECompartment () override

virtual bool	Load (const CDM::CompartmentData &in, SECircuitManager *circuits=nullptr)

Public Member Functions inherited from biogears::Loggable
	Loggable ()

	Loggable (Logger *log)

virtual	~Loggable ()

virtual Logger *	GetLogger () const

Protected Member Functions
	SELiquidCompartment (const char name, Logger logger)

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

virtual void	Unload (CDM::LiquidCompartmentData &data)

virtual SELiquidSubstanceQuantity &	CreateSubstanceQuantity (SESubstance &substance)

Protected Member Functions inherited from biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >
	SEFluidCompartment (const char name, Logger logger)

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

virtual void	Unload (CDM::FluidCompartmentData &data)

virtual void	RemoveSubstanceQuantity (const SESubstance &substance)

virtual bool	HasQuantity () const override

virtual SEScalarVolume &	GetQuantity () override

virtual double	CalculateInFlow_mL_Per_s () const

virtual double	CalculateOutFlow_mL_Per_s () const

virtual std::vector< TransportSubstanceType * > &	GetTransportSubstances () override

Protected Member Functions inherited from biogears::SECompartment
	SECompartment (const char name, Logger logger)

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

virtual void	Unload (CDM::CompartmentData &data)

Protected Member Functions inherited from biogears::Loggable
virtual void	Debug (const char msg, const char origin="") const

virtual void	Debug (const std::string &msg, const std::string &origin=empty) const

virtual void	Debug (std::ostream &msg, const std::string &origin=empty) const

virtual void	Info (const char msg, const char origin="") const

virtual void	Info (const std::string &msg, const std::string &origin=empty) const

virtual void	Info (std::ostream &msg, const std::string &origin=empty) const

virtual void	Warning (const char msg, const char origin="") const

virtual void	Warning (const std::string &msg, const std::string &origin=empty) const

virtual void	Warning (std::ostream &msg, const std::string &origin=empty) const

virtual void	Error (const char msg, const char origin="") const

virtual void	Error (const std::string msg, const std::string origin=empty) const

virtual void	Error (std::ostream &msg, const std::string &origin=empty) const

virtual void	Fatal (const char msg, const char origin="") const

virtual void	Fatal (const std::string &msg, const std::string &origin=empty) const

virtual void	Fatal (std::ostream &msg, const std::string &origin=empty) const

Protected Attributes
SEScalar *	m_pH

SEScalarFraction *	m_WaterVolumeFraction

std::vector< SELiquidCompartment * >	m_Children

std::vector< SELiquidCompartment * >	m_Leaves

Protected Attributes inherited from biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >
SEScalarVolumePerTime *	m_InFlow

SEScalarVolumePerTime *	m_OutFlow

SEScalarPressure *	m_Pressure

SEScalarVolume *	m_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 biogears::SECompartment
std::string	m_Name

Protected Attributes inherited from biogears::Loggable
Logger *	m_Logger

Friends
class	SETissueCompartment

class	SECompartmentManager

class	SELiquidSubstanceQuantity

Additional Inherited Members
Static Public Member Functions inherited from biogears::SECompartment
template<typename CompartmentType >
static void	FindLeaves (CompartmentType &cmpt, std::vector< CompartmentType * > &leaves)

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

static const char *	empty_cStr

Constructor & Destructor Documentation

biogears::SELiquidCompartment::SELiquidCompartment	(	const char *	name,
		Logger *	logger
	)

protected

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

protected

biogears::SELiquidCompartment::~SELiquidCompartment ( )

virtual

Member Function Documentation

void biogears::SELiquidCompartment::AddChild ( SELiquidCompartment & child )

virtual

void biogears::SELiquidCompartment::Balance ( BalanceLiquidBy by )

virtual

void biogears::SELiquidCompartment::Clear ( )

overridevirtual

Reimplemented from biogears::SECompartment.

SELiquidSubstanceQuantity & biogears::SELiquidCompartment::CreateSubstanceQuantity ( SESubstance & substance )

protectedvirtual

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

inlinevirtual

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

inlinevirtual

SEScalar & biogears::SELiquidCompartment::GetPH ( )

virtual

double biogears::SELiquidCompartment::GetPH ( ) const

virtual

const SEScalar * biogears::SELiquidCompartment::GetScalar ( const char * name )

overridevirtual

Implements biogears::SECompartment.

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

overridevirtual

Implements biogears::SECompartment.

SEScalarFraction & biogears::SELiquidCompartment::GetWaterVolumeFraction ( )

virtual

double biogears::SELiquidCompartment::GetWaterVolumeFraction ( ) const

virtual

bool biogears::SELiquidCompartment::HasPH ( ) const

virtual

bool biogears::SELiquidCompartment::HasWaterVolumeFraction ( ) const

virtual

bool biogears::SELiquidCompartment::Load	(	const CDM::LiquidCompartmentData &	in,
		SESubstanceManager &	subMgr,
		SECircuitManager *	circuits = `nullptr`
	)

virtual

void biogears::SELiquidCompartment::StateChange ( )

overridevirtual

Implements biogears::SECompartment.

CDM::LiquidCompartmentData * biogears::SELiquidCompartment::Unload ( )

overridevirtual

Implements biogears::SEFluidCompartment< SELiquidCompartmentLink, SELiquidTransportVertex, SELiquidTransportSubstance, SELiquidSubstanceQuantity >.

void biogears::SELiquidCompartment::Unload ( CDM::LiquidCompartmentData & data )

protectedvirtual

Friends And Related Function Documentation

friend class SECompartmentManager

friend

friend class SELiquidSubstanceQuantity

friend

friend class SETissueCompartment

friend

Member Data Documentation

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

protected

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

protected

SEScalar* biogears::SELiquidCompartment::m_pH

protected

SEScalarFraction* biogears::SELiquidCompartment::m_WaterVolumeFraction

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation