CIMPP::GovHydroPID Class Reference

PID governor and turbine. More...

#include <GovHydroPID.hpp>

Inheritance diagram for CIMPP::GovHydroPID:

Collaboration diagram for CIMPP::GovHydroPID:

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::TurbineGovernorDynamics
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::TurbineGovernorDynamics
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	aturb
	Turbine numerator multiplier (Aturb) (see parameter detail 3). Typical value -1. Default: 0.0.
CIMPP::PU	bturb
	Turbine denominator multiplier (Bturb) (see parameter detail 3). Typical value = 0,5. Default: 0.0.
CIMPP::Frequency	db1
	Intentional dead-band width (db1). Unit = Hz. Typical value = 0. Default: 0.0.
CIMPP::ActivePower	db2
	Unintentional dead-band (db2). Unit = MW. Typical value = 0. Default: 0.0.
CIMPP::Frequency	eps
	Intentional db hysteresis (eps). Unit = Hz. Typical value = 0. Default: 0.0.
CIMPP::PU	gv1
	Nonlinear gain point 1, PU gv (Gv1). Typical value = 0. Default: 0.0.
CIMPP::PU	gv2
	Nonlinear gain point 2, PU gv (Gv2). Typical value = 0. Default: 0.0.
CIMPP::PU	gv3
	Nonlinear gain point 3, PU gv (Gv3). Typical value = 0. Default: 0.0.
CIMPP::PU	gv4
	Nonlinear gain point 4, PU gv (Gv4). Typical value = 0. Default: 0.0.
CIMPP::PU	gv5
	Nonlinear gain point 5, PU gv (Gv5). Typical value = 0. Default: 0.0.
CIMPP::PU	gv6
	Nonlinear gain point 6, PU gv (Gv6). Typical value = 0. Default: 0.0.
CIMPP::Boolean	inputSignal
	Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tt is zero, Flag is set to false. If Tt is not zero, Flag is set to true. Typical value = true. Default: false.
CIMPP::PU	kd
	Derivative gain (Kd). Typical value = 1,11. Default: 0.0.
CIMPP::PU	kg
	Gate servo gain (Kg). Typical value = 2,5. Default: 0.0.
CIMPP::PU	ki
	Integral gain (Ki). Typical value = 0,36. Default: 0.0.
CIMPP::PU	kp
	Proportional gain (Kp). Typical value = 0,1. Default: 0.0.
CIMPP::ActivePower	mwbase
	Base for power values (MWbase) (> 0). Unit = MW. Default: 0.0.
CIMPP::PU	pgv1
	Nonlinear gain point 1, PU power (Pgv1). Typical value = 0. Default: 0.0.
CIMPP::PU	pgv2
	Nonlinear gain point 2, PU power (Pgv2). Typical value = 0. Default: 0.0.
CIMPP::PU	pgv3
	Nonlinear gain point 3, PU power (Pgv3). Typical value = 0. Default: 0.0.
CIMPP::PU	pgv4
	Nonlinear gain point 4, PU power (Pgv4). Typical value = 0. Default: 0.0.
CIMPP::PU	pgv5
	Nonlinear gain point 5, PU power (Pgv5). Typical value = 0. Default: 0.0.
CIMPP::PU	pgv6
	Nonlinear gain point 6, PU power (Pgv6). Typical value = 0. Default: 0.0.
CIMPP::PU	pmax
	Maximum gate opening, PU of MWbase (Pmax) (> GovHydroPID.pmin). Typical value = 1. Default: 0.0.
CIMPP::PU	pmin
	Minimum gate opening, PU of MWbase (Pmin) (< GovHydroPID.pmax). Typical value = 0. Default: 0.0.
CIMPP::PU	r
	Steady state droop (R). Typical value = 0,05. Default: 0.0.
CIMPP::Seconds	td
	Input filter time constant (Td) (>= 0). If = 0, block is bypassed. Typical value = 0. Default: 0.0.
CIMPP::Seconds	tf
	Washout time constant (Tf) (>= 0). Typical value = 0,1. Default: 0.0.
CIMPP::Seconds	tp
	Gate servo time constant (Tp) (>= 0). If = 0, block is bypassed. Typical value = 0,35. Default: 0.0.
CIMPP::Seconds	tt
	Power feedback time constant (Tt) (>= 0). If = 0, block is bypassed. Typical value = 0,02. Default: 0.0.
CIMPP::Seconds	tturb
	Turbine time constant (Tturb) (>= 0). See Parameter detail 3. Typical value = 0,8. Default: 0.0.
CIMPP::Float	velcl
	Maximum gate closing velocity (Velcl). Unit = PU / s. Typical value = -0,14. Default: 0.0.
CIMPP::Float	velop
	Maximum gate opening velocity (Velop). Unit = PU / s. Typical value = 0,09. Default: 0.0.
Public Attributes inherited from CIMPP::TurbineGovernorDynamics
CIMPP::AsynchronousMachineDynamics *	AsynchronousMachineDynamics
	Asynchronous machine model with which this turbine-governor model is associated. TurbineGovernorDynamics shall have either an association to SynchronousMachineDynamics or to AsynchronousMachineDynamics. Default: nullptr.
CIMPP::SynchronousMachineDynamics *	SynchronousMachineDynamics
	Synchronous machine model with which this turbine-governor model is associated. TurbineGovernorDynamics shall have either an association to SynchronousMachineDynamics or to AsynchronousMachineDynamics. Default: nullptr.
CIMPP::TurbineLoadControllerDynamics *	TurbineLoadControllerDynamics
	Turbine load controller providing input to this turbine-governor. 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 [] = "GovHydroPID"
Static Public Attributes inherited from CIMPP::TurbineGovernorDynamics
static const char	debugName [] = "TurbineGovernorDynamics"
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::TurbineGovernorDynamics
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override

Detailed Description

PID governor and turbine.

Member Function Documentation

addClassGetFnsToMap()

void GovHydroPID::addClassGetFnsToMap ( std::map< std::string, class_get_function > & get_map ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

addEnumGetFnsToMap()

void GovHydroPID::addEnumGetFnsToMap ( std::map< std::string, get_function > & get_map ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

addPrimitiveGetFnsToMap()

void GovHydroPID::addPrimitiveGetFnsToMap ( std::map< std::string, get_function > & get_map ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

allAttrDetailsMap()

std::map< std::string, AttrDetails > GovHydroPID::allAttrDetailsMap ( ) const

overrideprotectedvirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

debugString()

const char * GovHydroPID::debugString ( ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getAttributeNames()

const std::list< std::string > & GovHydroPID::getAttributeNames ( ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getAttributeNamespaceUrl()

const std::string & GovHydroPID::getAttributeNamespaceUrl ( const std::string & attrName ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getClassNamespaceUrl()

const std::string & GovHydroPID::getClassNamespaceUrl ( ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getPossibleAttributeProfiles()

const std::list< CGMESProfile > & GovHydroPID::getPossibleAttributeProfiles ( const std::string & attrName ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getPossibleProfiles()

const std::list< CGMESProfile > & GovHydroPID::getPossibleProfiles ( ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & GovHydroPID::getPossibleProfilesIncludingAttributes ( ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

getRecommendedProfile()

const CGMESProfile & GovHydroPID::getRecommendedProfile ( ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

isAssignableFrom()

bool GovHydroPID::isAssignableFrom ( BaseClass * otherObject ) const

overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

---

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

• CGMES_3.0.0/GovHydroPID.hpp
• CGMES_3.0.0/GovHydroPID.cpp