IEEE 421.5-2005 type ST4B model. This model is a variation of the type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that is in the ST3A model. Both potential and compound source rectifier excitation systems are modelled. The PI regulator blocks have non-windup limits that are represented. The voltage regulator of this model is typically implemented digitally. Reference: IEEE 421.5-2005, 7.4. More...

#include <ExcIEEEST4B.hpp>

Inheritance diagram for CIMPP::ExcIEEEST4B:

[legend]

Collaboration diagram for CIMPP::ExcIEEEST4B:

[legend]

Public Member Functions
const char *	debugString () const override
const std::list< std::string > &	getAttributeNames () const override
const std::string &	getClassNamespaceUrl () const override
const std::string &	getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfiles () const override
const CGMESProfile &	getRecommendedProfile () const override
const std::list< CGMESProfile > &	getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfilesIncludingAttributes () const override
void	addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void	addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void	addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool	isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::ExcitationSystemDynamics
const char *	debugString () const override
const std::list< std::string > &	getAttributeNames () const override
const std::string &	getClassNamespaceUrl () const override
const std::string &	getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfiles () const override
const CGMESProfile &	getRecommendedProfile () const override
const std::list< CGMESProfile > &	getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfilesIncludingAttributes () const override
void	addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void	addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void	addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool	isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::IdentifiedObject
const char *	debugString () const override
const std::list< std::string > &	getAttributeNames () const override
const std::string &	getClassNamespaceUrl () const override
const std::string &	getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfiles () const override
const CGMESProfile &	getRecommendedProfile () const override
const std::list< CGMESProfile > &	getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > &	getPossibleProfilesIncludingAttributes () const override
void	addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void	addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void	addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool	isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from BaseClass
void	setRdfid (const std::string &id)
std::string	getRdfid () const

Static Public Member Functions
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::ExcitationSystemDynamics
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::DynamicsFunctionBlock
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from CIMPP::IdentifiedObject
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner	declare ()
Static Public Member Functions inherited from BaseClass
static void	addConstructToMap (std::unordered_map< std::string, BaseClass ()()> &factory_map)
static void	addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void	addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const CIMPP::BaseClassDefiner	declare ()

Public Attributes
CIMPP::PU	kc
	Rectifier loading factor proportional to commutating reactance (K_C) (>= 0). Typical value = 0,113. Default: 0.0.
CIMPP::PU	kg
	Feedback gain constant of the inner loop field regulator (K_G) (>= 0). Typical value = 0. Default: 0.0.
CIMPP::PU	ki
	Potential circuit gain coefficient (K_I) (>= 0). Typical value = 0. Default: 0.0.
CIMPP::PU	kim
	Voltage regulator integral gain output (K_IM). Typical value = 0. Default: 0.0.
CIMPP::PU	kir
	Voltage regulator integral gain (K_IR). Typical value = 10,75. Default: 0.0.
CIMPP::PU	kp
	Potential circuit gain coefficient (K_P) (> 0). Typical value = 9,3. Default: 0.0.
CIMPP::PU	kpm
	Voltage regulator proportional gain output (K_PM). Typical value = 1. Default: 0.0.
CIMPP::PU	kpr
	Voltage regulator proportional gain (K_PR). Typical value = 10,75. Default: 0.0.
CIMPP::Seconds	ta
	Voltage regulator time constant (T_A) (>= 0). Typical value = 0,02. Default: 0.0.
CIMPP::AngleDegrees	thetap
	Potential circuit phase angle (thetap). Typical value = 0. Default: 0.0.
CIMPP::PU	vbmax
	Maximum excitation voltage (V_BMax) (> 0). Typical value = 11,63. Default: 0.0.
CIMPP::PU	vmmax
	Maximum inner loop output (V_MMax) (> ExcIEEEST4B.vmmin). Typical value = 99. Default: 0.0.
CIMPP::PU	vmmin
	Minimum inner loop output (V_MMin) (< ExcIEEEST4B.vmmax). Typical value = -99. Default: 0.0.
CIMPP::PU	vrmax
	Maximum voltage regulator output (V_RMAX) (> 0). Typical value = 1. Default: 0.0.
CIMPP::PU	vrmin
	Minimum voltage regulator output (V_RMIN) (< 0). Typical value = -0,87. Default: 0.0.
CIMPP::PU	xl
	Reactance associated with potential source (X_L) (>= 0). Typical value = 0,124. Default: 0.0.
Public Attributes inherited from CIMPP::ExcitationSystemDynamics
CIMPP::DiscontinuousExcitationControlDynamics *	DiscontinuousExcitationControlDynamics
	Discontinuous excitation control model associated with this excitation system model. Default: nullptr.
CIMPP::OverexcitationLimiterDynamics *	OverexcitationLimiterDynamics
	Overexcitation limiter model associated with this excitation system model. Default: nullptr.
CIMPP::PFVArControllerType1Dynamics *	PFVArControllerType1Dynamics
	Power factor or VAr controller type 1 model associated with this excitation system model. Default: nullptr.
CIMPP::PFVArControllerType2Dynamics *	PFVArControllerType2Dynamics
	Power factor or VAr controller type 2 model associated with this excitation system model. Default: nullptr.
CIMPP::PowerSystemStabilizerDynamics *	PowerSystemStabilizerDynamics
	Power system stabilizer model associated with this excitation system model. Default: nullptr.
CIMPP::SynchronousMachineDynamics *	SynchronousMachineDynamics
	Synchronous machine model with which this excitation system model is associated. Default: nullptr.
CIMPP::UnderexcitationLimiterDynamics *	UnderexcitationLimiterDynamics
	Undrexcitation limiter model associated with this excitation system model. Default: nullptr.
CIMPP::VoltageCompensatorDynamics *	VoltageCompensatorDynamics
	Voltage compensator model associated with this excitation system model. Default: nullptr.
Public Attributes inherited from CIMPP::DynamicsFunctionBlock
CIMPP::Boolean	enabled
	Function block used indicator. true = use of function block is enabled false = use of function block is disabled. Default: false.
Public Attributes inherited from CIMPP::IdentifiedObject
std::list< CIMPP::DiagramObject * >	DiagramObjects
	The diagram objects that are associated with the domain object. Default: {}.
CIMPP::String	description
	The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: "".
CIMPP::String	energyIdentCodeEic
	The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. For details on EIC scheme please refer to ENTSO-E web site. Default: "".
CIMPP::String	mRID
	Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: "".
CIMPP::String	name
	The name is any free human readable and possibly non unique text naming the object. Default: "".
CIMPP::String	shortName
	The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: "".

Static Public Attributes
static const char	debugName [] = "ExcIEEEST4B"
Static Public Attributes inherited from CIMPP::ExcitationSystemDynamics
static const char	debugName [] = "ExcitationSystemDynamics"
Static Public Attributes inherited from CIMPP::DynamicsFunctionBlock
static const char	debugName [] = "DynamicsFunctionBlock"
Static Public Attributes inherited from CIMPP::IdentifiedObject
static const char	debugName [] = "IdentifiedObject"
Static Public Attributes inherited from BaseClass
static const char	debugName [] = "BaseClass"

Protected Member Functions
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::ExcitationSystemDynamics
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::IdentifiedObject
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override

Detailed Description

IEEE 421.5-2005 type ST4B model. This model is a variation of the type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that is in the ST3A model. Both potential and compound source rectifier excitation systems are modelled. The PI regulator blocks have non-windup limits that are represented. The voltage regulator of this model is typically implemented digitally. Reference: IEEE 421.5-2005, 7.4.