Inheritance diagram for dss::obj::FaultBatch:

Collaboration diagram for dss::obj::FaultBatch:

Public Types
typedef Fault::Properties	Properties

typedef Fault	BatchElementClass

Public Member Functions
	FaultBatch (APIUtil *util)
	Create a batch of all Fault elements.

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

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

FaultBatch &	begin_edit ()

FaultBatch &	end_edit (int32_t num_edits=1)

strings	bus1 ()
	Name of first bus. More...

FaultBatch &	bus1 (const string &value)

FaultBatch &	bus1 (strings &value)

strings	bus2 ()
	Name of 2nd bus of the 2-terminal Fault object. More...

FaultBatch &	bus2 (const string &value)

FaultBatch &	bus2 (strings &value)

BatchInt32ArrayProxy	phases ()
	Number of Phases. More...

FaultBatch &	phases (int32_t value)

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

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

BatchFloat64ArrayProxy	r ()
	Resistance, each phase, ohms. More...

FaultBatch &	r (double value)

template<typename T >
FaultBatch &	r (T &value)

template<typename T >
FaultBatch &	r (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctstddev ()
	Percent standard deviation in resistance to assume for Monte Carlo fault (MF) solution mode for GAUSSIAN distribution. More...

FaultBatch &	pctstddev (double value)

template<typename T >
FaultBatch &	pctstddev (T &value)

template<typename T >
FaultBatch &	pctstddev (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	Gmatrix ()
	Use this to specify a nodal conductance (G) matrix to represent some arbitrary resistance network. More...

FaultBatch &	Gmatrix (VectorXd &value)

BatchFloat64ArrayProxy	ONtime ()
	Time (sec) at which the fault is established for time varying simulations. More...

FaultBatch &	ONtime (double value)

template<typename T >
FaultBatch &	ONtime (T &value)

template<typename T >
FaultBatch &	ONtime (typename T::iterator it_begin, typename T::iterator it_end)

bools	temporary ()
	{Yes \| No} Default is No. More...

FaultBatch &	temporary (bool value)

FaultBatch &	temporary (bools &value)

BatchFloat64ArrayProxy	MinAmps ()
	Minimum amps that can sustain a temporary fault. More...

FaultBatch &	MinAmps (double value)

template<typename T >
FaultBatch &	MinAmps (T &value)

template<typename T >
FaultBatch &	MinAmps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	normamps ()
	Normal rated current. More...

FaultBatch &	normamps (double value)

template<typename T >
FaultBatch &	normamps (T &value)

template<typename T >
FaultBatch &	normamps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	emergamps ()
	Maximum or emerg current. More...

FaultBatch &	emergamps (double value)

template<typename T >
FaultBatch &	emergamps (T &value)

template<typename T >
FaultBatch &	emergamps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	faultrate ()
	Failure rate per year. More...

FaultBatch &	faultrate (double value)

template<typename T >
FaultBatch &	faultrate (T &value)

template<typename T >
FaultBatch &	faultrate (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctperm ()
	Percent of failures that become permanent. More...

FaultBatch &	pctperm (double value)

template<typename T >
FaultBatch &	pctperm (T &value)

template<typename T >
FaultBatch &	pctperm (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	repair ()
	Hours to repair. More...

FaultBatch &	repair (double value)

template<typename T >
FaultBatch &	repair (T &value)

template<typename T >
FaultBatch &	repair (typename T::iterator it_begin, typename T::iterator it_end)

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

FaultBatch &	basefreq (double value)

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

template<typename T >
FaultBatch &	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...

FaultBatch &	enabled (bool value)

FaultBatch &	enabled (bools &value)

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

FaultBatch &	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::FaultBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15

◆ bus1()

strings dss::obj::FaultBatch::bus1 ( )

inline

Name of first bus.

Examples:

bus1=busname bus1=busname.1.2.3

Bus2 automatically defaults to busname.0,0,0 unless it was previously defined.

DSS property name: bus1, DSS property index: 1

◆ bus2()

strings dss::obj::FaultBatch::bus2 ( )

inline

Name of 2nd bus of the 2-terminal Fault object.

Defaults to all phases connected to first bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

That is, the Fault defaults to a ground fault unless otherwise specified.

DSS property name: bus2, DSS property index: 2

◆ emergamps()

BatchFloat64ArrayProxy dss::obj::FaultBatch::emergamps ( )

inline

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 11

◆ enabled()

bools dss::obj::FaultBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 16

◆ faultrate()

BatchFloat64ArrayProxy dss::obj::FaultBatch::faultrate ( )

inline

Failure rate per year.

DSS property name: faultrate, DSS property index: 12

◆ Gmatrix()

std::vector< VectorXd > dss::obj::FaultBatch::Gmatrix ( )

inline

Use this to specify a nodal conductance (G) matrix to represent some arbitrary resistance network.

Specify in lower triangle form as usual for DSS matrices.

DSS property name: Gmatrix, DSS property index: 6

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 17

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 17

◆ MinAmps()

BatchFloat64ArrayProxy dss::obj::FaultBatch::MinAmps ( )

inline

Minimum amps that can sustain a temporary fault.

Default is 5.

DSS property name: MinAmps, DSS property index: 9

◆ normamps()

BatchFloat64ArrayProxy dss::obj::FaultBatch::normamps ( )

inline

Normal rated current.

DSS property name: normamps, DSS property index: 10

◆ ONtime()

BatchFloat64ArrayProxy dss::obj::FaultBatch::ONtime ( )

inline

Time (sec) at which the fault is established for time varying simulations.

Default is 0.0 (on at the beginning of the simulation)

DSS property name: ONtime, DSS property index: 7

◆ pctperm()

BatchFloat64ArrayProxy dss::obj::FaultBatch::pctperm ( )

inline

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 13

◆ pctstddev()

BatchFloat64ArrayProxy dss::obj::FaultBatch::pctstddev ( )

inline

Percent standard deviation in resistance to assume for Monte Carlo fault (MF) solution mode for GAUSSIAN distribution.

Default is 0 (no variation from mean).

DSS property name: stddev, DSS property index: 5

◆ phases()

BatchInt32ArrayProxy dss::obj::FaultBatch::phases ( )

inline

Number of Phases.

Default is 1.

DSS property name: phases, DSS property index: 3

◆ r()

BatchFloat64ArrayProxy dss::obj::FaultBatch::r ( )

inline

Resistance, each phase, ohms.

Default is 0.0001. Assumed to be Mean value if gaussian random mode.Max value if uniform mode. A Fault is actually a series resistance that defaults to a wye connection to ground on the second terminal. You may reconnect the 2nd terminal to achieve whatever connection. Use the Gmatrix property to specify an arbitrary conductance matrix.

DSS property name: r, DSS property index: 4

◆ repair()

BatchFloat64ArrayProxy dss::obj::FaultBatch::repair ( )

inline

Hours to repair.

DSS property name: repair, DSS property index: 14

◆ temporary()

bools dss::obj::FaultBatch::temporary ( )

inline

{Yes | No} Default is No.

Designate whether the fault is temporary. For Time-varying simulations, the fault will be removed if the current through the fault drops below the MINAMPS criteria.

DSS property name: temporary, DSS property index: 8

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()

◆ bus2()

◆ emergamps()

◆ enabled()

◆ faultrate()

◆ Gmatrix()

◆ like() [1/2]

◆ like() [2/2]

◆ MinAmps()

◆ normamps()

◆ ONtime()

◆ pctperm()

◆ pctstddev()

◆ phases()

◆ r()

◆ repair()

◆ temporary()