Inheritance diagram for dss::obj::IndMach012:

Collaboration diagram for dss::obj::IndMach012:

Classes
struct	Properties

Public Types
enum class	IndMach012SlipOption : int32_t { VariableSlip = 0 , FixedSlip = 1 }
	IndMach012: Slip Option (DSS enumeration for IndMach012) More...

Public Member Functions
	IndMach012 (APIUtil util=nullptr, void ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.

	IndMach012 (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".

	IndMach012 (APIUtil util, char name)
	Create a wrapper for an element given its name.

const char *	name ()
	Returns the object's name.

IndMach012 &	begin_edit ()
	Marks an object for edition. More...

IndMach012 &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...

int32_t	phases ()
	Number of Phases, this Induction Machine. More...

IndMach012 &	phases (int32_t value)

string	bus1 ()
	Bus to which the Induction Machine is connected. More...

IndMach012 &	bus1 (const string &value)

IndMach012 &	bus1 (const char *value)

double	kv ()
	Nominal rated (1.0 per unit) voltage, kV. More...

IndMach012 &	kv (double value)

double	kW ()
	Shaft Power, kW, for the Induction Machine. More...

IndMach012 &	kW (double value)

double	pf ()
	[Read Only] Present power factor for the machine. More...

IndMach012 &	pf (double value)

Connection	conn ()
	Connection of stator: Delta or Wye. More...

IndMach012 &	conn (int32_t value)

IndMach012 &	conn (Connection value)

IndMach012 &	conn (const string &value)

IndMach012 &	conn (const char *value)

string	conn_str ()
	Connection of stator: Delta or Wye. More...

IndMach012 &	conn_str (const string &value)
	Connection of stator: Delta or Wye. More...

double	kVA ()
	Rated kVA for the machine. More...

IndMach012 &	kVA (double value)

double	H ()
	Per unit mass constant of the machine. More...

IndMach012 &	H (double value)

double	D ()
	Damping constant. More...

IndMach012 &	D (double value)

double	puRs ()
	Per unit stator resistance. More...

IndMach012 &	puRs (double value)

double	puXs ()
	Per unit stator leakage reactance. More...

IndMach012 &	puXs (double value)

double	puRr ()
	Per unit rotor resistance. More...

IndMach012 &	puRr (double value)

double	puXr ()
	Per unit rotor leakage reactance. More...

IndMach012 &	puXr (double value)

double	puXm ()
	Per unit magnetizing reactance.Default is 4.0. More...

IndMach012 &	puXm (double value)

double	Slip ()
	Initial slip value. More...

IndMach012 &	Slip (double value)

double	MaxSlip ()
	Max slip value to allow. More...

IndMach012 &	MaxSlip (double value)

IndMach012SlipOption	SlipOption ()
	Option for slip model. More...

IndMach012 &	SlipOption (int32_t value)

IndMach012 &	SlipOption (IndMach012SlipOption value)

IndMach012 &	SlipOption (const string &value)

IndMach012 &	SlipOption (const char *value)

string	SlipOption_str ()
	Option for slip model. More...

IndMach012 &	SlipOption_str (const string &value)
	Option for slip model. More...

string	Yearly ()
	LOADSHAPE object to use for yearly simulations. More...

IndMach012 &	Yearly (const string &value)

IndMach012 &	Yearly (dss::obj::LoadShape &value)

dss::obj::LoadShape	Yearly_obj ()
	LOADSHAPE object to use for yearly simulations. More...

IndMach012 &	Yearly_obj (dss::obj::LoadShape &value)

string	Daily ()
	LOADSHAPE object to use for daily simulations. More...

IndMach012 &	Daily (const string &value)

IndMach012 &	Daily (dss::obj::LoadShape &value)

dss::obj::LoadShape	Daily_obj ()
	LOADSHAPE object to use for daily simulations. More...

IndMach012 &	Daily_obj (dss::obj::LoadShape &value)

string	Duty ()
	LOADSHAPE object to use for duty cycle simulations. More...

IndMach012 &	Duty (const string &value)

IndMach012 &	Duty (dss::obj::LoadShape &value)

dss::obj::LoadShape	Duty_obj ()
	LOADSHAPE object to use for duty cycle simulations. More...

IndMach012 &	Duty_obj (dss::obj::LoadShape &value)

bool	Debugtrace ()
	[Yes \| No*] Write DebugTrace file. More...

IndMach012 &	Debugtrace (bool value)

string	spectrum ()
	Name of harmonic voltage or current spectrum for this IndMach012. More...

IndMach012 &	spectrum (const string &value)

IndMach012 &	spectrum (dss::obj::Spectrum &value)

dss::obj::Spectrum	spectrum_obj ()
	Name of harmonic voltage or current spectrum for this IndMach012. More...

IndMach012 &	spectrum_obj (dss::obj::Spectrum &value)

double	basefreq ()
	Base Frequency for ratings. More...

IndMach012 &	basefreq (double value)

bool	enabled ()
	{Yes\|No or True\|False} Indicates whether this element is enabled. More...

IndMach012 &	enabled (bool value)

IndMach012 &	like (const string &value)
	Make like another object, e.g. More...

IndMach012 &	like (const char *value)
	Make like another object, e.g. More...

Public Member Functions inherited from dss::obj::DSSObj
	DSSObj (APIUtil util=nullptr, void ptr_=nullptr)

Static Public Attributes
static const char	dss_cls_name [] = "IndMach012"

static const int32_t	dss_cls_idx = 38

Additional Inherited Members
Public Attributes inherited from dss::obj::DSSObj
APIUtil *	api_util

void *	ptr

Protected Member Functions inherited from dss::obj::DSSObj
void	check_for_error ()

void	set_string (int32_t index, const string &value)

void	set_string (int32_t index, const char *value)

string	get_prop_string (int32_t index)

complex	get_complex (int32_t index)

void	set_complex (int32_t index, complex value)

void	set_string_array (int32_t index, strings &value)

void	set_obj (int32_t index, DSSObj &value)

template<typename T >
T	get_obj (int32_t index)

template<typename T = VectorXd>
T	get_array (int32_t index)

template<typename T = VectorXd>
void	set_array (int32_t index, T value)

Static Protected Member Functions inherited from dss::obj::DSSObj
template<typename T = VectorXd>
static void	set_array (void *ptr, int32_t index, T value)

Protected Attributes inherited from dss::obj::DSSObj
friend	DSSBatch

Member Enumeration Documentation

◆ IndMach012SlipOption

enum class dss::obj::IndMach012::IndMach012SlipOption : int32_t

strong

IndMach012: Slip Option (DSS enumeration for IndMach012)

Enumerator
VariableSlip	VariableSlip.
FixedSlip	FixedSlip.

Member Function Documentation

◆ basefreq()

double dss::obj::IndMach012::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 23

◆ begin_edit()

IndMach012 & dss::obj::IndMach012::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ bus1()

string dss::obj::IndMach012::bus1 ( )

inline

Bus to which the Induction Machine is connected.

May include specific node specification.

DSS property name: bus1, DSS property index: 2

◆ conn()

Connection dss::obj::IndMach012::conn ( )

inline

Connection of stator: Delta or Wye.

Default is Delta.

DSS property name: conn, DSS property index: 6

◆ conn_str() [1/2]

string dss::obj::IndMach012::conn_str ( )

inline

Connection of stator: Delta or Wye.

Default is Delta.

DSS property name: conn, DSS property index: 6

◆ conn_str() [2/2]

IndMach012 & dss::obj::IndMach012::conn_str ( const string & value )

inline

Connection of stator: Delta or Wye.

Default is Delta.

DSS property name: conn, DSS property index: 6

◆ D()

double dss::obj::IndMach012::D ( )

inline

Damping constant.

Usual range is 0 to 4. Default is 1.0. Adjust to get damping in Dynamics mode,

DSS property name: D, DSS property index: 9

◆ Daily()

string dss::obj::IndMach012::Daily ( )

inline

LOADSHAPE object to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: Daily, DSS property index: 19

◆ Daily_obj()

dss::obj::LoadShape dss::obj::IndMach012::Daily_obj ( )

inline

LOADSHAPE object to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. Default is no variation (constant) if not defined. Side effect: Sets Yearly load shape if not already defined.

DSS property name: Daily, DSS property index: 19

◆ Debugtrace()

bool dss::obj::IndMach012::Debugtrace ( )

inline

[Yes | No*] Write DebugTrace file.

DSS property name: Debugtrace, DSS property index: 21

◆ Duty()

string dss::obj::IndMach012::Duty ( )

inline

LOADSHAPE object to use for duty cycle simulations.

Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: Duty, DSS property index: 20

◆ Duty_obj()

dss::obj::LoadShape dss::obj::IndMach012::Duty_obj ( )

inline

LOADSHAPE object to use for duty cycle simulations.

Must be previously defined as a Loadshape object. Typically would have time intervals less than 1 hr. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.Set to NONE to reset to no loadahape. Set Status=Fixed to ignore Loadshape designation. Defaults to Daily curve If not specified.

DSS property name: Duty, DSS property index: 20

◆ enabled()

bool dss::obj::IndMach012::enabled ( )

inline

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 24

◆ end_edit()

IndMach012 & dss::obj::IndMach012::end_edit ( int32_t num_edits = 1 )

inline

Finalizes an object edition.

This will result more compelx side-effects like Yprim and other internal data recalculation, for example.

◆ H()

double dss::obj::IndMach012::H ( )

inline

Per unit mass constant of the machine.

MW-sec/MVA. Default is 1.0.

DSS property name: H, DSS property index: 8

◆ kv()

double dss::obj::IndMach012::kv ( )

inline

Nominal rated (1.0 per unit) voltage, kV.

For 2- and 3-phase machines, specify phase-phase kV. Otherwise, specify actual kV across each branch of the machine. If wye (star), specify phase-neutral kV. If delta or phase-phase connected, specify phase-phase kV.

DSS property name: kv, DSS property index: 3

◆ kVA()

double dss::obj::IndMach012::kVA ( )

inline

Rated kVA for the machine.

DSS property name: kVA, DSS property index: 7

◆ kW()

double dss::obj::IndMach012::kW ( )

inline

Shaft Power, kW, for the Induction Machine.

A positive value denotes power for a load. Negative value denotes an induction generator.

DSS property name: kW, DSS property index: 4

◆ like() [1/2]

IndMach012 & dss::obj::IndMach012::like ( const char * value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 25

◆ like() [2/2]

IndMach012 & dss::obj::IndMach012::like ( const string & value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 25

◆ MaxSlip()

double dss::obj::IndMach012::MaxSlip ( )

inline

Max slip value to allow.

Default is 0.1. Set this before setting slip.

DSS property name: MaxSlip, DSS property index: 16

◆ pf()

double dss::obj::IndMach012::pf ( )

inline

[Read Only] Present power factor for the machine.

DSS property name: pf, DSS property index: 5

◆ phases()

int32_t dss::obj::IndMach012::phases ( )

inline

Number of Phases, this Induction Machine.

DSS property name: phases, DSS property index: 1

◆ puRr()

double dss::obj::IndMach012::puRr ( )

inline

Per unit rotor resistance.

Default is 0.007.

DSS property name: puRr, DSS property index: 12

◆ puRs()

double dss::obj::IndMach012::puRs ( )

inline

Per unit stator resistance.

Default is 0.0053.

DSS property name: puRs, DSS property index: 10

◆ puXm()

double dss::obj::IndMach012::puXm ( )

inline

Per unit magnetizing reactance.Default is 4.0.

DSS property name: puXm, DSS property index: 14

◆ puXr()

double dss::obj::IndMach012::puXr ( )

inline

Per unit rotor leakage reactance.

Default is 0.12.

DSS property name: puXr, DSS property index: 13

◆ puXs()

double dss::obj::IndMach012::puXs ( )

inline

Per unit stator leakage reactance.

Default is 0.106.

DSS property name: puXs, DSS property index: 11

◆ Slip()

double dss::obj::IndMach012::Slip ( )

inline

Initial slip value.

Default is 0.007

DSS property name: Slip, DSS property index: 15

◆ SlipOption()

IndMach012SlipOption dss::obj::IndMach012::SlipOption ( )

inline

Option for slip model.

One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17

◆ SlipOption_str() [1/2]

string dss::obj::IndMach012::SlipOption_str ( )

inline

Option for slip model.

One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17

◆ SlipOption_str() [2/2]

IndMach012 & dss::obj::IndMach012::SlipOption_str ( const string & value )

inline

Option for slip model.

One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17

◆ spectrum()

string dss::obj::IndMach012::spectrum ( )

inline

Name of harmonic voltage or current spectrum for this IndMach012.

Voltage behind Xd" for machine - default. Current injection for inverter. Default value is "default", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 22

◆ spectrum_obj()

dss::obj::Spectrum dss::obj::IndMach012::spectrum_obj ( )

inline

Name of harmonic voltage or current spectrum for this IndMach012.

Voltage behind Xd" for machine - default. Current injection for inverter. Default value is "default", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 22

◆ Yearly()

string dss::obj::IndMach012::Yearly ( )

inline

LOADSHAPE object to use for yearly simulations.

Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: Yearly, DSS property index: 18

◆ Yearly_obj()

dss::obj::LoadShape dss::obj::IndMach012::Yearly_obj ( )

inline

LOADSHAPE object to use for yearly simulations.

Must be previously defined as a Loadshape object. Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set Status=Fixed to ignore Loadshape designation. Set to NONE to reset to no loadahape. The default is no variation.

DSS property name: Yearly, DSS property index: 18

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

include/dss_obj.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ IndMach012SlipOption

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ bus1()

◆ conn()

◆ conn_str() [1/2]

◆ conn_str() [2/2]

◆ D()

◆ Daily()

◆ Daily_obj()

◆ Debugtrace()

◆ Duty()

◆ Duty_obj()

◆ enabled()

◆ end_edit()

◆ H()

◆ kv()

◆ kVA()

◆ kW()

◆ like() [1/2]

◆ like() [2/2]

◆ MaxSlip()

◆ pf()

◆ phases()

◆ puRr()

◆ puRs()

◆ puXm()

◆ puXr()

◆ puXs()

◆ Slip()

◆ SlipOption()

◆ SlipOption_str() [1/2]

◆ SlipOption_str() [2/2]

◆ spectrum()

◆ spectrum_obj()

◆ Yearly()

◆ Yearly_obj()