Inheritance diagram for dss::obj::Fault:

Collaboration diagram for dss::obj::Fault:

Classes
struct	Properties

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

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

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

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

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

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

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

Fault &	bus1 (const string &value)

Fault &	bus1 (const char *value)

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

Fault &	bus2 (const string &value)

Fault &	bus2 (const char *value)

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

Fault &	phases (int32_t value)

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

Fault &	r (double value)

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

Fault &	pctstddev (double value)

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

Fault &	Gmatrix (VectorXd &value)

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

Fault &	ONtime (double value)

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

Fault &	temporary (bool value)

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

Fault &	MinAmps (double value)

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

Fault &	normamps (double value)

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

Fault &	emergamps (double value)

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

Fault &	faultrate (double value)

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

Fault &	pctperm (double value)

double	repair ()
	Hours to repair. More...

Fault &	repair (double value)

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

Fault &	basefreq (double value)

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

Fault &	enabled (bool value)

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

Fault &	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 [] = "Fault"

static const int32_t	dss_cls_idx = 25

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 Function Documentation

◆ basefreq()

double dss::obj::Fault::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15

◆ begin_edit()

Fault & dss::obj::Fault::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ bus1()

string dss::obj::Fault::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()

string dss::obj::Fault::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()

double dss::obj::Fault::emergamps ( )

inline

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 11

◆ enabled()

bool dss::obj::Fault::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 16

◆ end_edit()

Fault & dss::obj::Fault::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.

◆ faultrate()

double dss::obj::Fault::faultrate ( )

inline

Failure rate per year.

DSS property name: faultrate, DSS property index: 12

◆ Gmatrix()

VectorXd dss::obj::Fault::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]

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

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

double dss::obj::Fault::MinAmps ( )

inline

Minimum amps that can sustain a temporary fault.

Default is 5.

DSS property name: MinAmps, DSS property index: 9

◆ normamps()

double dss::obj::Fault::normamps ( )

inline

Normal rated current.

DSS property name: normamps, DSS property index: 10

◆ ONtime()

double dss::obj::Fault::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()

double dss::obj::Fault::pctperm ( )

inline

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 13

◆ pctstddev()

double dss::obj::Fault::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()

int32_t dss::obj::Fault::phases ( )

inline

Number of Phases.

Default is 1.

DSS property name: phases, DSS property index: 3

◆ r()

double dss::obj::Fault::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()

double dss::obj::Fault::repair ( )

inline

Hours to repair.

DSS property name: repair, DSS property index: 14

◆ temporary()

bool dss::obj::Fault::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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ bus1()

◆ bus2()

◆ emergamps()

◆ enabled()

◆ end_edit()

◆ faultrate()

◆ Gmatrix()

◆ like() [1/2]

◆ like() [2/2]

◆ MinAmps()

◆ normamps()

◆ ONtime()

◆ pctperm()

◆ pctstddev()

◆ phases()

◆ r()

◆ repair()

◆ temporary()