#include <SEThermalCompartment.h>

Inheritance diagram for biogears::SEThermalCompartment:

Public Member Functions
virtual	~SEThermalCompartment () override

virtual void	Clear () override

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

virtual CDM::ThermalCompartmentData *	Unload () override

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

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

virtual bool	HasChildren () const override

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

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

virtual bool	HasNodeMapping () const

virtual SECompartmentNodes< THERMAL_COMPARTMENT_NODE > &	GetNodeMapping ()

virtual void	MapNode (SEThermalCircuitNode &node)

virtual void	StateChange () override

virtual bool	HasHeatTransferRateIn () const

virtual const SEScalarPower &	GetHeatTransferRateIn ()

virtual double	GetHeatTransferRateIn (const PowerUnit &unit) const

virtual bool	HasHeatTransferRateOut () const

virtual const SEScalarPower &	GetHeatTransferRateOut ()

virtual double	GetHeatTransferRateOut (const PowerUnit &unit) const

virtual bool	HasHeat () const

virtual SEScalarEnergy &	GetHeat ()

virtual double	GetHeat (const EnergyUnit &unit) const

virtual bool	HasTemperature () const

virtual SEScalarTemperature &	GetTemperature ()

virtual double	GetTemperature (const TemperatureUnit &unit) const

virtual void	AddLink (SEThermalCompartmentLink &link)

virtual void	RemoveLink (SEThermalCompartmentLink &link)

virtual void	RemoveLinks ()

virtual const std::vector< SEThermalCompartmentLink * > &	GetLinks ()

virtual bool	HasChild (const char *name)

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

virtual void	AddChild (SEThermalCompartment &child)

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

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

virtual std::string	GetName () const

virtual const char *	GetName_cStr () const

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

	Loggable (Logger *log)

virtual	~Loggable ()

virtual Logger *	GetLogger () const

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

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

virtual void	Unload (CDM::ThermalCompartmentData &data)

virtual double	CalculateInFlow_W () const

virtual double	CalculateOutFlow_W () const

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
SEScalarPower *	m_HeatTransferRateIn

SEScalarPower *	m_HeatTransferRateOut

SEScalarEnergy *	m_Heat

SEScalarTemperature *	m_Temperature

std::vector< SEThermalCompartmentLink * >	m_Links

std::vector< SEThermalCompartmentLink * >	m_IncomingLinks

std::vector< SEThermalCompartmentLink * >	m_OutgoingLinks

std::vector< SEThermalCompartment * >	m_Children

std::vector< SEThermalCompartment * >	m_Leaves

SECompartmentNodes< THERMAL_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	SECompartmentManager

template<typename CompartmentType , typename CompartmentLinkType >
class	SECompartmentGraph

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::SEThermalCompartment::SEThermalCompartment	(	const char *	name,
		Logger *	logger
	)

protected

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

protected

biogears::SEThermalCompartment::~SEThermalCompartment ( )

overridevirtual

Member Function Documentation

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

virtual

void biogears::SEThermalCompartment::AddLink ( SEThermalCompartmentLink & link )

virtual

double biogears::SEThermalCompartment::CalculateInFlow_W ( ) const

protectedvirtual

double biogears::SEThermalCompartment::CalculateOutFlow_W ( ) const

protectedvirtual

void biogears::SEThermalCompartment::Clear ( )

overridevirtual

Reimplemented from biogears::SECompartment.

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

inlinevirtual

SEScalarEnergy & biogears::SEThermalCompartment::GetHeat ( )

virtual

double biogears::SEThermalCompartment::GetHeat ( const EnergyUnit & unit ) const

virtual

const SEScalarPower & biogears::SEThermalCompartment::GetHeatTransferRateIn ( )

virtual

double biogears::SEThermalCompartment::GetHeatTransferRateIn ( const PowerUnit & unit ) const

virtual

const SEScalarPower & biogears::SEThermalCompartment::GetHeatTransferRateOut ( )

virtual

double biogears::SEThermalCompartment::GetHeatTransferRateOut ( const PowerUnit & unit ) const

virtual

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

inlinevirtual

const std::vector< SEThermalCompartmentLink * > & biogears::SEThermalCompartment::GetLinks ( )

virtual

virtual SECompartmentNodes<THERMAL_COMPARTMENT_NODE>& biogears::SEThermalCompartment::GetNodeMapping ( )

inlinevirtual

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

overridevirtual

Implements biogears::SECompartment.

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

overridevirtual

Implements biogears::SECompartment.

SEScalarTemperature & biogears::SEThermalCompartment::GetTemperature ( )

virtual

double biogears::SEThermalCompartment::GetTemperature ( const TemperatureUnit & unit ) const

virtual

bool biogears::SEThermalCompartment::HasChild ( const char * name )

virtual

bool biogears::SEThermalCompartment::HasChild ( const std::string & name )

virtual

virtual bool biogears::SEThermalCompartment::HasChildren ( ) const

inlineoverridevirtual

Implements biogears::SECompartment.

bool biogears::SEThermalCompartment::HasHeat ( ) const

virtual

bool biogears::SEThermalCompartment::HasHeatTransferRateIn ( ) const

virtual

bool biogears::SEThermalCompartment::HasHeatTransferRateOut ( ) const

virtual

virtual bool biogears::SEThermalCompartment::HasNodeMapping ( ) const

inlinevirtual

bool biogears::SEThermalCompartment::HasTemperature ( ) const

virtual

bool biogears::SEThermalCompartment::Load	(	const CDM::ThermalCompartmentData &	in,
		SECircuitManager *	circuits = `nullptr`
	)

virtual

void biogears::SEThermalCompartment::MapNode ( SEThermalCircuitNode & node )

virtual

void biogears::SEThermalCompartment::RemoveLink ( SEThermalCompartmentLink & link )

virtual

void biogears::SEThermalCompartment::RemoveLinks ( )

virtual

void biogears::SEThermalCompartment::StateChange ( )

overridevirtual

Implements biogears::SECompartment.

CDM::ThermalCompartmentData * biogears::SEThermalCompartment::Unload ( )

overridevirtual

Implements biogears::SECompartment.

void biogears::SEThermalCompartment::Unload ( CDM::ThermalCompartmentData & data )

protectedvirtual

Friends And Related Function Documentation

template<typename CompartmentType , typename CompartmentLinkType >

friend class SECompartmentGraph

friend

friend class SECompartmentManager

friend

Member Data Documentation

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

protected

SEScalarEnergy* biogears::SEThermalCompartment::m_Heat

protected

SEScalarPower* biogears::SEThermalCompartment::m_HeatTransferRateIn

protected

SEScalarPower* biogears::SEThermalCompartment::m_HeatTransferRateOut

protected

std::vector<SEThermalCompartmentLink*> biogears::SEThermalCompartment::m_IncomingLinks

protected

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

protected

std::vector<SEThermalCompartmentLink*> biogears::SEThermalCompartment::m_Links

protected

SECompartmentNodes<THERMAL_COMPARTMENT_NODE> biogears::SEThermalCompartment::m_Nodes

protected

std::vector<SEThermalCompartmentLink*> biogears::SEThermalCompartment::m_OutgoingLinks

protected

SEScalarTemperature* biogears::SEThermalCompartment::m_Temperature

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