A ThermalCapacitor is used to model a thermal capacitance between two thermal domains. More...

#include <thermal_model.hh>

Inheritance diagram for ThermalCapacitor:

Public Types
typedef ThermalCapacitorParams	Params

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	ThermalCapacitor (const Params *p)
	ThermalCapacitor. More...

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

LinearEquation	getEquation (ThermalNode *tn, unsigned n, double step) const override

void	setNodes (ThermalNode n1, ThermalNode n2)

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. More...

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. More...

virtual void	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index. More...

virtual void	startup ()
	startup() is the final initialization call before simulation. More...

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining. More...

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes. More...

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers. More...

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Public Member Functions inherited from EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue. More...

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section. More...

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object. More...

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from Drainable
DrainState	drainState () const
	Return the current drain state of an object. More...

virtual void	notifyFork ()
	Notify a child process of a fork. More...

Public Member Functions inherited from Stats::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group. More...

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters. More...

virtual void	resetStats ()
	Callback to reset stats. More...

virtual void	preDumpStats ()
	Callback before stats are dumped. More...

void	addStat (Stats::Info *info)
	Register a stat with this group. More...

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object. More...

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object. More...

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block. More...

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Private Attributes
double	_capacitance

ThermalNode *	node1

ThermalNode *	node2

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain. More...

void	signalDrainDone () const
	Signal that an object is drained. More...

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Detailed Description

A ThermalCapacitor is used to model a thermal capacitance between two thermal domains.

This domains can be either a reference (fixed temp.) or a heat producer (power source).

Definition at line 88 of file thermal_model.hh.

Member Typedef Documentation

◆ Params

typedef ThermalCapacitorParams ThermalCapacitor::Params

Definition at line 91 of file thermal_model.hh.

Constructor & Destructor Documentation

◆ ThermalCapacitor()

ThermalCapacitor::ThermalCapacitor ( const Params * p )

ThermalCapacitor.

Definition at line 138 of file thermal_model.cc.

Member Function Documentation

◆ getEquation()

LinearEquation ThermalCapacitor::getEquation	(	ThermalNode *	tn,
		unsigned	n,
		double	step
	)		const

overridevirtual

Implements ThermalEntity.

Definition at line 162 of file thermal_model.cc.

References _capacitance, PowerISA::eq, ThermalNode::id, ThermalNode::isref, ArmISA::n, node1, node2, and ThermalNode::temp.

◆ serialize()

void ThermalCapacitor::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 150 of file thermal_model.cc.

References _capacitance, and SERIALIZE_SCALAR.

◆ setNodes()

void ThermalCapacitor::setNodes	(	ThermalNode *	n1,
		ThermalNode *	n2
	)

inline

Definition at line 100 of file thermal_model.hh.

References node1, and node2.

◆ unserialize()

void ThermalCapacitor::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 156 of file thermal_model.cc.

References _capacitance, and UNSERIALIZE_SCALAR.

Member Data Documentation

◆ _capacitance

double ThermalCapacitor::_capacitance

private

Definition at line 107 of file thermal_model.hh.

Referenced by getEquation(), serialize(), and unserialize().

◆ node1

ThermalNode* ThermalCapacitor::node1

private

Definition at line 109 of file thermal_model.hh.

Referenced by getEquation(), and setNodes().

◆ node2

ThermalNode * ThermalCapacitor::node2

private

Definition at line 109 of file thermal_model.hh.

Referenced by getEquation(), and setNodes().

The documentation for this class was generated from the following files:

sim/power/thermal_model.hh
sim/power/thermal_model.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ ThermalCapacitor()

Member Function Documentation

◆ getEquation()

◆ serialize()

◆ setNodes()

◆ unserialize()

Member Data Documentation

◆ _capacitance

◆ node1

◆ node2