WsfThermalSystemComponent Class Reference

#include <WsfThermalSystem.hpp>

Inheritance diagram for WsfThermalSystemComponent:

Collaboration diagram for WsfThermalSystemComponent:

Public Member Functions
	WsfThermalSystemComponent ()
	WsfThermalSystemComponent (const std::string &aTypeString, double aSpecificHeatCapacity, double aSpecificHeatCapacityHighTemp=0.0, double aEnthalpy=0.0, double aEnthalpyTransitionTemperature=10000.0)
	Constructor for adding a new type.
bool	ProcessInput (UtInput &aInput) override
double	TransferHeat (double aHeatTransfer)
	Update based on heat transfer.
double	GetTemperature ()
void	SetTemperature (double aTemperature)
	Set the temperature, regardless of heat transfer.
void	SetMass (double aMass)
double	GetRequiredHeatForTemperature (double aTemperature) const
double	GetHeatCapacity () const
double	GetHeatCapacity (double aTemperature) const
double	GetSpecificHeatCapacity () const
double	GetPhaseTransitionTemperature () const
double	GetPhaseTransitionEnergy () const
double	GetRemainingPhaseTransitionEnergy (bool aIsAddingHeat) const
bool	InPhaseChange () const
double	GetEnergy (double aLowTemp, double aHighTemp) const
double	PrintInfo (double aLowTemp, double aHighTemp, ut::log::MessageStream &aMessageStream) const
void	PrintState (ut::log::MessageStream &aMessageStream) const
Public Member Functions inherited from WsfUncloneableObject
	WsfUncloneableObject ()
WsfObject *	Clone () const override
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

WsfThermalSystemComponent() [1/2]

WsfThermalSystemComponent::WsfThermalSystemComponent

(

)

WsfThermalSystemComponent() [2/2]

WsfThermalSystemComponent::WsfThermalSystemComponent	(	const std::string &	aTypeString,
		double	aSpecificHeatCapacity,
		double	aSpecificHeatCapacityHighTemp = 0.0,
		double	aEnthalpy = 0.0,
		double	aEnthalpyTransitionTemperature = 10000.0 )

Constructor for adding a new type.

References WsfObject::SetType().

Member Function Documentation

GetEnergy()

double WsfThermalSystemComponent::GetEnergy	(	double	aLowTemp,
		double	aHighTemp ) const

Get the total available energy of the system, between the two given temperatures.

References GetHeatCapacity(), GetPhaseTransitionEnergy(), and GetPhaseTransitionTemperature().

Referenced by WsfThermalSystem::GetEnergy().

GetHeatCapacity() [1/2]

double WsfThermalSystemComponent::GetHeatCapacity

(

)

const

References GetHeatCapacity().

Referenced by GetEnergy(), GetHeatCapacity(), PrintInfo(), and TransferHeat().

GetHeatCapacity() [2/2]

double WsfThermalSystemComponent::GetHeatCapacity

(

double

aTemperature

)

const

GetPhaseTransitionEnergy()

double WsfThermalSystemComponent::GetPhaseTransitionEnergy ( ) const

inline

Referenced by GetEnergy(), and PrintInfo().

GetPhaseTransitionTemperature()

double WsfThermalSystemComponent::GetPhaseTransitionTemperature ( ) const

inline

Referenced by GetEnergy().

GetRemainingPhaseTransitionEnergy()

double WsfThermalSystemComponent::GetRemainingPhaseTransitionEnergy

(

bool

aIsAddingHeat

)

const

Given whether we intend to add or remove heat; return the energy necessary to transition out of a phase change. If the component is not in the phase change state, this method returns zero.

Referenced by GetRequiredHeatForTemperature().

GetRequiredHeatForTemperature()

double WsfThermalSystemComponent::GetRequiredHeatForTemperature

(

double

aTemperature

)

const

References GetRemainingPhaseTransitionEnergy().

GetSpecificHeatCapacity()

double WsfThermalSystemComponent::GetSpecificHeatCapacity ( ) const

inline

Referenced by WsfThermalSystem::ProcessInput().

GetTemperature()

double WsfThermalSystemComponent::GetTemperature ( )

inline

InPhaseChange()

bool WsfThermalSystemComponent::InPhaseChange ( ) const

inline

PrintInfo()

double WsfThermalSystemComponent::PrintInfo	(	double	aLowTemp,
		double	aHighTemp,
		ut::log::MessageStream &	aMessageStream ) const

References GetHeatCapacity(), GetPhaseTransitionEnergy(), and WsfObject::GetType().

Referenced by WsfThermalSystem::PrintInfo().

PrintState()

void WsfThermalSystemComponent::PrintState

(

ut::log::MessageStream &

aMessageStream

)

const

References WsfObject::GetType().

ProcessInput()

bool WsfThermalSystemComponent::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput

a reference to a UtInput object.

Returns

'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or an object derived from it) if the command was recognized but contains some sort of error.

Note

If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

References WsfObjectTypeList< T >::Find(), WsfScenario::FromInput(), and WsfScenario::GetThermalSystemComponentTypes().

Referenced by WsfThermalSystem::ProcessInput().

SetMass()

void WsfThermalSystemComponent::SetMass ( double aMass )

inline

SetTemperature()

void WsfThermalSystemComponent::SetTemperature

(

double

aTemperature

)

Set the temperature, regardless of heat transfer.

Referenced by TransferHeat().

TransferHeat()

double WsfThermalSystemComponent::TransferHeat

(

double

aHeatTransfer

)

Update based on heat transfer.

References GetHeatCapacity(), SetTemperature(), and TransferHeat().

Referenced by TransferHeat().

---

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

• WsfThermalSystem.hpp
• WsfThermalSystem.cpp