CGMES_3_0_0
Loading...
Searching...
No Matches
CIMPP::GovHydroFrancis Class Reference

Detailed hydro unit - Francis model. This model can be used to represent three types of governors. A schematic of the hydraulic system of detailed hydro unit models, such as Francis and Pelton, is provided in the DetailedHydroModelHydraulicSystem diagram. More...

#include <GovHydroFrancis.hpp>

Inheritance diagram for CIMPP::GovHydroFrancis:
Collaboration diagram for CIMPP::GovHydroFrancis:

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 am
 Opening section SEFF at the maximum efficiency (Am). Typical value = 0,7. Default: 0.0.
CIMPP::Area av0
 Area of the surge tank (AV0). Unit = m2. Typical value = 30. Default: 0.0.
CIMPP::Area av1
 Area of the compensation tank (AV1). Unit = m2. Typical value = 700. Default: 0.0.
CIMPP::PU bp
 Droop (Bp). Typical value = 0,05. Default: 0.0.
CIMPP::Frequency db1
 Intentional dead-band width (DB1). Unit = Hz. Typical value = 0. Default: 0.0.
CIMPP::PU etamax
 Maximum efficiency (EtaMax). Typical value = 1,05. Default: 0.0.
CIMPP::FrancisGovernorControlKind governorControl
 Governor control flag (Cflag). Typical value = mechanicHydrolicTachoAccelerator. Default: 0.
CIMPP::Length h1
 Head of compensation chamber water level with respect to the level of penstock (H1). Unit = km. Typical value = 0,004. Default: 0.0.
CIMPP::Length h2
 Head of surge tank water level with respect to the level of penstock (H2). Unit = km. Typical value = 0,040. Default: 0.0.
CIMPP::Length hn
 Rated hydraulic head (Hn). Unit = km. Typical value = 0,250. Default: 0.0.
CIMPP::PU kc
 Penstock loss coefficient (due to friction) (Kc). Typical value = 0,025. Default: 0.0.
CIMPP::PU kg
 Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical value = 0,025. Default: 0.0.
CIMPP::PU kt
 Washout gain (Kt). Typical value = 0,25. Default: 0.0.
CIMPP::PU qc0
 No-load turbine flow at nominal head (Qc0). Typical value = 0,1. Default: 0.0.
CIMPP::VolumeFlowRate qn
 Rated flow (Qn). Unit = m3/s. Typical value = 250. Default: 0.0.
CIMPP::Seconds ta
 Derivative gain (Ta) (>= 0). Typical value = 3. Default: 0.0.
CIMPP::Seconds td
 Washout time constant (Td) (>= 0). Typical value = 6. Default: 0.0.
CIMPP::Seconds ts
 Gate servo time constant (Ts) (>= 0). Typical value = 0,5. Default: 0.0.
CIMPP::Seconds twnc
 Water inertia time constant (Twnc) (>= 0). Typical value = 1. Default: 0.0.
CIMPP::Seconds twng
 Water tunnel and surge chamber inertia time constant (Twng) (>= 0). Typical value = 3. Default: 0.0.
CIMPP::Seconds tx
 Derivative feedback gain (Tx) (>= 0). Typical value = 1. Default: 0.0.
CIMPP::Float va
 Maximum gate opening velocity (Va). Unit = PU / s. Typical value = 0,06. Default: 0.0.
CIMPP::PU valvmax
 Maximum gate opening (ValvMax) (> GovHydroFrancis.valvmin). Typical value = 1,1. Default: 0.0.
CIMPP::PU valvmin
 Minimum gate opening (ValvMin) (< GovHydroFrancis.valvmax). Typical value = 0. Default: 0.0.
CIMPP::Float vc
 Maximum gate closing velocity (Vc). Unit = PU / s. Typical value = -0,06. Default: 0.0.
CIMPP::Boolean waterTunnelSurgeChamberSimulation
 Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical value = false. Default: false.
CIMPP::Length zsfc
 Head of upper water level with respect to the level of penstock (Zsfc). Unit = km. Typical value = 0,025. 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 [] = "GovHydroFrancis"
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

Detailed hydro unit - Francis model. This model can be used to represent three types of governors. A schematic of the hydraulic system of detailed hydro unit models, such as Francis and Pelton, is provided in the DetailedHydroModelHydraulicSystem diagram.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ debugString()

const char * GovHydroFrancis::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getAttributeNames()

const std::list< std::string > & GovHydroFrancis::getAttributeNames ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getAttributeNamespaceUrl()

const std::string & GovHydroFrancis::getAttributeNamespaceUrl ( const std::string & attrName) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getClassNamespaceUrl()

const std::string & GovHydroFrancis::getClassNamespaceUrl ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getPossibleProfiles()

const std::list< CGMESProfile > & GovHydroFrancis::getPossibleProfiles ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & GovHydroFrancis::getPossibleProfilesIncludingAttributes ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getRecommendedProfile()

const CGMESProfile & GovHydroFrancis::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ isAssignableFrom()

bool GovHydroFrancis::isAssignableFrom ( BaseClass * otherObject) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.


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