Inheritance diagram for dss::obj::IndMach012Batch:

Collaboration diagram for dss::obj::IndMach012Batch:

Public Types
typedef IndMach012::Properties	Properties

typedef IndMach012	BatchElementClass

typedef IndMach012::IndMach012SlipOption	IndMach012SlipOption

Public Member Functions
	IndMach012Batch (APIUtil *util)
	Create a batch of all IndMach012 elements.

	IndMach012Batch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all IndMach012 elements that match an integer property value.

	IndMach012Batch (APIUtil util, const char regexp)
	Create a batch of all IndMach012 elements that match a regular expression.

IndMach012Batch &	begin_edit ()

IndMach012Batch &	end_edit (int32_t num_edits=1)

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

IndMach012Batch &	phases (int32_t value)

template<typename T >
IndMach012Batch &	phases (T &value)

template<typename T >
IndMach012Batch &	phases (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	bus1 (const string &value)

IndMach012Batch &	bus1 (strings &value)

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

IndMach012Batch &	kv (double value)

template<typename T >
IndMach012Batch &	kv (T &value)

template<typename T >
IndMach012Batch &	kv (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	kW (double value)

template<typename T >
IndMach012Batch &	kW (T &value)

template<typename T >
IndMach012Batch &	kW (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	pf (double value)

template<typename T >
IndMach012Batch &	pf (T &value)

template<typename T >
IndMach012Batch &	pf (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	conn (string &value)

IndMach012Batch &	conn (int32_t value)

IndMach012Batch &	conn (Connection value)

IndMach012Batch &	conn (strings &value)

IndMach012Batch &	conn (std::vector< int32_t > &value)

IndMach012Batch &	conn (std::vector< Connection > &value)

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

IndMach012Batch &	conn_str (string &value)

IndMach012Batch &	conn_str (strings &value)

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

IndMach012Batch &	kVA (double value)

template<typename T >
IndMach012Batch &	kVA (T &value)

template<typename T >
IndMach012Batch &	kVA (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	H (double value)

template<typename T >
IndMach012Batch &	H (T &value)

template<typename T >
IndMach012Batch &	H (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	D ()
	Damping constant. More...

IndMach012Batch &	D (double value)

template<typename T >
IndMach012Batch &	D (T &value)

template<typename T >
IndMach012Batch &	D (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	puRs (double value)

template<typename T >
IndMach012Batch &	puRs (T &value)

template<typename T >
IndMach012Batch &	puRs (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	puXs (double value)

template<typename T >
IndMach012Batch &	puXs (T &value)

template<typename T >
IndMach012Batch &	puXs (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	puRr (double value)

template<typename T >
IndMach012Batch &	puRr (T &value)

template<typename T >
IndMach012Batch &	puRr (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	puXr (double value)

template<typename T >
IndMach012Batch &	puXr (T &value)

template<typename T >
IndMach012Batch &	puXr (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	puXm (double value)

template<typename T >
IndMach012Batch &	puXm (T &value)

template<typename T >
IndMach012Batch &	puXm (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	Slip (double value)

template<typename T >
IndMach012Batch &	Slip (T &value)

template<typename T >
IndMach012Batch &	Slip (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	MaxSlip (double value)

template<typename T >
IndMach012Batch &	MaxSlip (T &value)

template<typename T >
IndMach012Batch &	MaxSlip (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	SlipOption (string &value)

IndMach012Batch &	SlipOption (int32_t value)

IndMach012Batch &	SlipOption (IndMach012::IndMach012SlipOption value)

IndMach012Batch &	SlipOption (strings &value)

IndMach012Batch &	SlipOption (std::vector< int32_t > &value)

IndMach012Batch &	SlipOption (std::vector< IndMach012::IndMach012SlipOption > &value)

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

IndMach012Batch &	SlipOption_str (string &value)

IndMach012Batch &	SlipOption_str (strings &value)

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

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

IndMach012Batch &	Yearly (const string &value)

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

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

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

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

IndMach012Batch &	Daily (const string &value)

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

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

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

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

IndMach012Batch &	Duty (const string &value)

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

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

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

IndMach012Batch &	Debugtrace (bool value)

IndMach012Batch &	Debugtrace (bools &value)

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

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

IndMach012Batch &	spectrum (const string &value)

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

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

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

IndMach012Batch &	basefreq (double value)

template<typename T >
IndMach012Batch &	basefreq (T &value)

template<typename T >
IndMach012Batch &	basefreq (typename T::iterator it_begin, typename T::iterator it_end)

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

IndMach012Batch &	enabled (bool value)

IndMach012Batch &	enabled (bools &value)

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

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

Public Member Functions inherited from dss::obj::DSSBatch
	DSSBatch (APIUtil *util, int32_t cls_idx)
	Create a batch of all elements in the DSS class.

	DSSBatch (APIUtil *util, int32_t cls_idx, int32_t prop_idx, int32_t prop_value)
	Create a batch of all elements that match an integer property value.

	DSSBatch (APIUtil util, int32_t cls_idx, const char regexp)
	Create a batch of all elements that match a regular expression.

	DSSBatch (APIUtil *util)
	Create an uninitialized batch instance.

strings	name ()

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

void **	pointer

int32_t	count [2]

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

bools	get_batch_bool (int32_t index)

std::vector< complex >	get_batch_complex (int32_t index)

template<typename T = VectorXd>
std::vector< T >	get_batch_valarray (int32_t index)

void	set_batch_complex_for_each (int32_t index, std::vector< complex > &values)

template<typename T >
void	set_batch_val (int32_t index, const T &value)

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

template<typename T >
void	set_batch_val_for_each (int32_t index, typename T::iterator v, typename T::iterator v_end)

Static Protected Member Functions inherited from dss::obj::DSSBatch
template<typename T = VectorXd>
static T	get_batch_val (int32_t index, DSSBatch &batch)

Member Function Documentation

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 23

◆ bus1()

strings dss::obj::IndMach012Batch::bus1 ( )

inline

Bus to which the Induction Machine is connected.

May include specific node specification.

DSS property name: bus1, DSS property index: 2

◆ conn()

BatchInt32ArrayProxy dss::obj::IndMach012Batch::conn ( )

inline

Connection of stator: Delta or Wye.

Default is Delta.

DSS property name: conn, DSS property index: 6

◆ conn_str()

strings dss::obj::IndMach012Batch::conn_str ( )

inline

Connection of stator: Delta or Wye.

Default is Delta.

DSS property name: conn, DSS property index: 6

◆ D()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::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()

strings dss::obj::IndMach012Batch::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()

std::vector< dss::obj::LoadShape > dss::obj::IndMach012Batch::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()

bools dss::obj::IndMach012Batch::Debugtrace ( )

inline

[Yes | No*] Write DebugTrace file.

DSS property name: Debugtrace, DSS property index: 21

◆ Duty()

strings dss::obj::IndMach012Batch::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()

std::vector< dss::obj::LoadShape > dss::obj::IndMach012Batch::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()

bools dss::obj::IndMach012Batch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 24

◆ H()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::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()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::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()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::kVA ( )

inline

Rated kVA for the machine.

DSS property name: kVA, DSS property index: 7

◆ kW()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::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]

IndMach012Batch & dss::obj::IndMach012Batch::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]

IndMach012Batch & dss::obj::IndMach012Batch::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()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::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()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::pf ( )

inline

[Read Only] Present power factor for the machine.

DSS property name: pf, DSS property index: 5

◆ phases()

BatchInt32ArrayProxy dss::obj::IndMach012Batch::phases ( )

inline

Number of Phases, this Induction Machine.

DSS property name: phases, DSS property index: 1

◆ puRr()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::puRr ( )

inline

Per unit rotor resistance.

Default is 0.007.

DSS property name: puRr, DSS property index: 12

◆ puRs()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::puRs ( )

inline

Per unit stator resistance.

Default is 0.0053.

DSS property name: puRs, DSS property index: 10

◆ puXm()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::puXm ( )

inline

Per unit magnetizing reactance.Default is 4.0.

DSS property name: puXm, DSS property index: 14

◆ puXr()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::puXr ( )

inline

Per unit rotor leakage reactance.

Default is 0.12.

DSS property name: puXr, DSS property index: 13

◆ puXs()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::puXs ( )

inline

Per unit stator leakage reactance.

Default is 0.106.

DSS property name: puXs, DSS property index: 11

◆ Slip()

BatchFloat64ArrayProxy dss::obj::IndMach012Batch::Slip ( )

inline

Initial slip value.

Default is 0.007

DSS property name: Slip, DSS property index: 15

◆ SlipOption()

BatchInt32ArrayProxy dss::obj::IndMach012Batch::SlipOption ( )

inline

Option for slip model.

One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17

◆ SlipOption_str()

strings dss::obj::IndMach012Batch::SlipOption_str ( )

inline

Option for slip model.

One of {fixedslip | variableslip* }

DSS property name: SlipOption, DSS property index: 17

◆ spectrum()

strings dss::obj::IndMach012Batch::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()

std::vector< dss::obj::Spectrum > dss::obj::IndMach012Batch::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()

strings dss::obj::IndMach012Batch::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()

std::vector< dss::obj::LoadShape > dss::obj::IndMach012Batch::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

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ bus1()

◆ conn()

◆ conn_str()

◆ D()

◆ Daily()

◆ Daily_obj()

◆ Debugtrace()

◆ Duty()

◆ Duty_obj()

◆ enabled()

◆ H()

◆ kv()

◆ kVA()

◆ kW()

◆ like() [1/2]

◆ like() [2/2]

◆ MaxSlip()

◆ pf()

◆ phases()

◆ puRr()

◆ puRs()

◆ puXm()

◆ puXr()

◆ puXs()

◆ Slip()

◆ SlipOption()

◆ SlipOption_str()

◆ spectrum()

◆ spectrum_obj()

◆ Yearly()

◆ Yearly_obj()