ThermalModelRegion class is used for thermal model domains.
The class can be called from the Study class.
. More...

Public Member Functions
void	AddSelected (String &key, Selection *selection)
	Adds a selection to the specified setting target of the thermal model region. More...

void	AddSet (String &key, Set *set)
	Adds a Set object to the specified setting target for the reference slot of the thermal model region. More...

void	ClearTarget ()
	Clears all selected targets for the thermal model region.

int	GetLayers ()
	Returns the number of layers in the thermal model region. More...

int	GetMotorType ()
	Returns the motor type of the thermal model region setting. More...

String	GetName ()
	Returns the thermal model region name as a string. More...

int	GetRotorSlots ()
	Returns the number of rotor slots in the thermal model region. More...

Selection *	GetSelection (String &key)
	Returns the targets for the given thermal model region as a Selection object. More...

Set *	GetSet (String &key, int dataIndex)
	Returns the targets for the given thermal model region as a Set object. More...

int	GetStatorSlots ()
	Returns the number of stator slots in the thermal model region. More...

bool	HasWarning (String &key)
	Returns True as the return value a warning in the targets in the thermal model region. More...

bool	IsValid ()
	Returns True if an object is valid. More...

void	SetLayers (Variant &value)
	Specifies the number of layers in the thermal model region. More...

void	SetName (String &name)
	Specifies the name of this thermal model region. More...

void	SetRotorSlots (Variant &value)
	Specifies the number of rotor slots in the thermal model region. More...

void	SetStatorSlots (Variant &value)
	Specifies the number of stator slots in the thermal model region. More...

Detailed Description

ThermalModelRegion class is used for thermal model domains.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetThermalModelRegion(0)

Member Function Documentation

void ThermalModelRegion::AddSelected	(	String &	key,
		Selection *	selection
	)

Adds a selection to the specified setting target of the thermal model region.

Parameters

key

Setting target

stator_gap : Gap (Stator Side)
rotor_gap : Gap (Rotor Side)
stator_outer : Stator Outer
rotor_inner : Rotor Inner
stator_core : Stator Core (Front Side) (Specify Front/Rear Side Parts for 2D)
rotor_core : Rotor Core (Front Side) (Specify Front/Rear Side Parts for 2D)
coil : Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_stator_core : Stator Core (Rear) (3D Only)
rear_rotor_core : Rotor Core (Rear) (3D Only)
rear_coil : Coil (Rear) (3D Only)
field_coil : Field Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_field_coil : Field Coil (Rear) (3D Only)

selection Selection object

void ThermalModelRegion::AddSet	(	String &	key,
		Set *	set
	)

Adds a Set object to the specified setting target for the reference slot of the thermal model region.

Parameters

key

Setting target

stator_gap : Gap (Stator Side)
rotor_gap : Gap (Rotor Side)
stator_outer : Stator Outer
rotor_inner : Rotor Inner
stator_core : Stator Core (Front Side) (Specify Front/Rear Side Parts for 2D)
rotor_core : Rotor Core (Front Side) (Specify Front/Rear Side Parts for 2D)
coil : Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_stator_core : Stator Core (Rear) (3D Only)
rear_rotor_core : Rotor Core (Rear) (3D Only)
rear_coil : Coil (Rear) (3D Only)
field_coil : Field Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_field_coil : Field Coil (Rear) (3D Only)

selection Set object

int ThermalModelRegion::GetLayers ( )

Returns the number of layers in the thermal model region.

Returns: Number of layers

int ThermalModelRegion::GetMotorType ( )

Returns the motor type of the thermal model region setting.

Returns: Motor type (integer value)
0 : Default (Ex. Permanent Magnet Motor)

1 : Field Coil Motor

String ThermalModelRegion::GetName ( )

Returns the thermal model region name as a string.

Returns: Name of the thermal model region

int ThermalModelRegion::GetRotorSlots ( )

Returns the number of rotor slots in the thermal model region.

Returns: Number of rotor slots

Selection * ThermalModelRegion::GetSelection ( String & key )

Returns the targets for the given thermal model region as a Selection object.

Parameters

key

Setting target

stator_gap : Gap (Stator Side)
rotor_gap : Gap (Rotor Side)
stator_outer : Stator Outer
rotor_inner : Rotor Inner
stator_core : Stator Core (Front Side) (Specify Front/Rear Side Parts for 2D)
rotor_core : Rotor Core (Front Side) (Specify Front/Rear Side Parts for 2D)
coil : Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_stator_core : Stator Core (Rear) (3D Only)
rear_rotor_core : Rotor Core (Rear) (3D Only)
rear_coil : Coil (Rear) (3D Only)
field_coil : Field Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_field_coil : Field Coil (Rear) (3D Only)

Returns: Selection object

Set * ThermalModelRegion::GetSet	(	String &	key,
		int	index
	)

Returns the targets for the given thermal model region as a Set object.

Parameters

key

Setting target

stator_gap : Gap (Stator Side)
rotor_gap : Gap (Rotor Side)
stator_outer : Stator Outer
rotor_inner : Rotor Inner
stator_core : Stator Core (Front Side) (Specify Front/Rear Side Parts for 2D)
rotor_core : Rotor Core (Front Side) (Specify Front/Rear Side Parts for 2D)
coil : Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_stator_core : Stator Core (Rear) (3D Only)
rear_rotor_core : Rotor Core (Rear) (3D Only)
rear_coil : Coil (Rear) (3D Only)
field_coil : Field Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_field_coil : Field Coil (Rear) (3D Only)

index

Returns: Set object

int ThermalModelRegion::GetStatorSlots ( )

Returns the number of stator slots in the thermal model region.

Returns: Number of stator slots

bool ThermalModelRegion::HasWarning ( String & key )

Returns True as the return value a warning in the targets in the thermal model region.

Parameters

key

Setting target

stator_gap : Gap (Stator Side)
rotor_gap : Gap (Rotor Side)
stator_outer : Stator Outer
rotor_inner : Rotor Inner
stator_core : Stator Core (Front Side) (Specify Front/Rear Side Parts for 2D)
rotor_core : Rotor Core (Front Side) (Specify Front/Rear Side Parts for 2D)
coil : Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_stator_core : Stator Core (Rear) (3D Only)
rear_rotor_core : Rotor Core (Rear) (3D Only)
rear_coil : Coil (Rear) (3D Only)
field_coil : Field Coil (Front Side) (Specify Front/Rear Side Parts for 2D)
rear_field_coil : Field Coil (Rear) (3D Only)

Returns: Whether the target has warnings in the thermal model region

bool ThermalModelRegion::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the ThermalModelRegion object is valid

void ThermalModelRegion::SetLayers ( Variant & value )

Specifies the number of layers in the thermal model region.

Parameters

layers Number of layers

void ThermalModelRegion::SetName ( String & name )

Specifies the name of this thermal model region.

Parameters

name	Name of the thermal model region

void ThermalModelRegion::SetRotorSlots ( Variant & value )

Specifies the number of rotor slots in the thermal model region.

Parameters

value Number of rotor slots

void ThermalModelRegion::SetStatorSlots ( Variant & value )

Specifies the number of stator slots in the thermal model region.

Parameters

value Number of stator slots

Public Member Functions

Detailed Description

Member Function Documentation