CPS::SP::Ph1::Shunt Class Reference

Inheritance diagram for CPS::SP::Ph1::Shunt:

Collaboration diagram for CPS::SP::Ph1::Shunt:

Public Member Functions
	Shunt (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	Defines UID, name, component parameters and logging level.
	Shunt (String name, Logger::Level logLevel=Logger::Level::off)
	Defines name and logging level.
void	setParameters (Real conductance, Real susceptance)
	Set shunt specific parameters.
void	setBaseVoltage (Real baseVoltage)
	Set base voltage.
void	calculatePerUnitParameters (Real baseApparentPower, Real baseOmega)
	Initializes component from power flow data.
void	pfApplyAdmittanceMatrixStamp (SparseMatrixCompRow &Y)
	Stamps admittance matrix.
Public Member Functions inherited from CPS::SimPowerComp< Complex >
	SimPowerComp (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes UID, name and log level.
	SimPowerComp (String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes name and log level and sets the UID to name as well.
virtual	~SimPowerComp ()
	Destructor - does not do anything.
virtual SimPowerComp< Complex >::Ptr	clone (String name)
	Returns a modified copy of the component with the given suffix added to the name and without.
UInt	terminalNumber ()
	Returns nominal number of Terminals for this component type.
UInt	terminalNumberConnected ()
	Returns the number of connected Terminals.
Bool	hasUnconnectedTerminals ()
void	checkForUnconnectedTerminals ()
SimTerminal< Complex >::List	terminals ()
	Return list of Terminal pointers.
SimTerminal< Complex >::Ptr	terminal (UInt index)
	Get pointer to Terminal.
TopologicalTerminal::List	topologicalTerminals ()
	Returns the list of terminals as TopologicalTerminal pointers.
void	setTerminalNumber (UInt num)
void	setTerminals (typename SimTerminal< Complex >::List terminals)
void	setTerminalAt (typename SimTerminal< Complex >::Ptr terminal, UInt terminalPosition)
	Sets Terminal at index terminalPosition.
void	updateMatrixNodeIndices ()
	Update the "cached" mMatrixNodeIndices and mMatrixNodeIndexIsGround members.
UInt	nodeNumber ()
	Returns the actual number of Nodes / Terminals that are already set to valid Nodes.
SimNode< Complex >::Ptr	node (UInt index)
	Get pointer to node.
UInt	matrixNodeIndex (UInt nodeIndex)
UInt	matrixNodeIndex (UInt nodeIndex, UInt phaseIndex)
std::vector< UInt >	matrixNodeIndices (UInt index)
	TODO replace with access to mMatrixNodeIndices.
TopologicalNode::List	topologicalNodes ()
	Get nodes as base type TopologicalNode.
UInt	virtualNodesNumber ()
	Returns nominal number of virtual nodes for this component type.
Bool	hasVirtualNodes ()
	Returns true if virtual node number is greater than zero.
Bool	hasSubComponents ()
	Returns true if subcomponents included in this component.
SimPowerComp< Complex >::List	subComponents ()
	Get list of subcomponents.
SimNode< Complex >::List &	virtualNodes ()
SimNode< Complex >::Ptr	virtualNode (UInt index)
	Get pointer to virtual node.
std::vector< UInt >	virtualMatrixNodeIndices (UInt index)
	Get vector of simulation node numbers from virtual Node.
UInt	virtualSimNode (UInt nodeIndex, UInt phaseIndex=0)
	Get simulation node number from virtual node.
const MatrixVar< Complex > &	intfCurrent ()
const MatrixVar< Complex > &	intfVoltage ()
MatrixComp	initialVoltage (UInt index)
Complex	initialSingleVoltage (UInt index)
Bool	terminalNotGrounded (UInt index)
void	setIntfCurrent (MatrixVar< Complex > current)
void	setIntfVoltage (MatrixVar< Complex > voltage)
void	setVirtualNodeNumber (UInt num)
void	setVirtualNodeAt (typename SimNode< Complex >::Ptr virtualNode, UInt nodeNum)
	Sets the virtual node at index nodeNum.
void	connect (typename SimNode< Complex >::List nodes)
	Sets all nodes and checks for nominal number of Nodes for this Component.
virtual void	initialize (Matrix frequencies)
	Initialize components with correct network frequencies.
virtual void	initializeFromNodesAndTerminals (Real frequency)
	Initializes Component variables according to power flow data stored in Nodes.
Public Member Functions inherited from CPS::TopologicalPowerComp
	TopologicalPowerComp (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes UID, name and log level.
	TopologicalPowerComp (String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes name and log level and sets the UID to name as well.
virtual	~TopologicalPowerComp ()
	Destructor - does not do anything.
void	setBehaviour (Behaviour behaviour)
	Set behavior of component, e.g. initialization.
Public Member Functions inherited from CPS::IdentifiedObject
	IdentifiedObject (const String &uid, const String &name)
	IdentifiedObject (const String &name)
AttributeBase::Ptr	attribute (const String &name) const
	Return pointer to an attribute.
template<typename T>
Attribute< T >::Ptr	attributeTyped (const String &name) const
	Return pointer to an attribute.
const AttributeBase::Map &	attributes () const
String	name ()
String	uid ()
	Returns unique id.
String	type ()
	Get component type (cross-platform)
virtual String	description ()

Public Attributes
const Attribute< Real >::Ptr	mConductance
	Conductance [S].
const Attribute< Real >::Ptr	mSusceptance
	Susceptance [S].
const Attribute< Real >::Ptr	mConductancePerUnit
	Conductance [pu].
const Attribute< Real >::Ptr	mSusceptancePerUnit
	Susceptance [pu].
Public Attributes inherited from CPS::SimPowerComp< Complex >
const Attribute< MatrixVar< Complex > >::Ptr	mIntfVoltage
	Voltage between terminals.
const Attribute< MatrixVar< Complex > >::Ptr	mIntfCurrent
	Current through component.
Public Attributes inherited from CPS::IdentifiedObject
const Attribute< String >::Ptr	mName
	Human readable name.
const Attribute< String >::Ptr	mUID
	Unique identifier.

Additional Inherited Members
Public Types inherited from CPS::SimPowerComp< Complex >
typedef Complex	Type
typedef std::shared_ptr< SimPowerComp< Complex > >	Ptr
typedef std::vector< Ptr >	List
Public Types inherited from CPS::TopologicalPowerComp
enum	Behaviour { Initialization , MNASimulation , PFSimulation }
typedef std::shared_ptr< TopologicalPowerComp >	Ptr
typedef std::vector< Ptr >	List
Public Types inherited from CPS::IdentifiedObject
typedef std::shared_ptr< IdentifiedObject >	Ptr
typedef std::vector< Ptr >	List
Static Public Member Functions inherited from SharedFactory< Shunt >
static std::shared_ptr< Shunt >	make (Args &&...args)
Protected Attributes inherited from CPS::SimPowerComp< Complex >
SimTerminal< Complex >::List	mTerminals
	List of Terminals.
SimNode< Complex >::List	mVirtualNodes
	List of virtual nodes.
Matrix	mFrequencies
	List of considered network frequencies.
UInt	mNumFreqs
	Number of network frequencies.
PhaseType	mPhaseType
std::vector< std::shared_ptr< SimPowerComp< Complex > > >	mSubComponents
std::vector< UInt >	mMatrixNodeIndices
	"Cached" list of simulation nodes (to avoid shared_ptr accesses during simulation)
std::vector< bool >	mMatrixNodeIndexIsGround
	"Cached" flags for whether the connected nodes are grounded
Protected Attributes inherited from CPS::TopologicalPowerComp
UInt	mNumTerminals = 0
	Determines the number of Terminals which can be connected to network Nodes.
UInt	mNumVirtualNodes = 0
	Determines the number of virtual or internal Nodes.
Logger::Log	mSLog
	Component logger.
Logger::Level	mLogLevel
	Component logger control for internal variables.
Behaviour	mBehaviour = Behaviour::MNASimulation
bool	mParametersSet = false
	Flag indicating that parameters are set via setParameters() function.
Protected Attributes inherited from CPS::IdentifiedObject
AttributeList::Ptr	mAttributes = AttributeList::make()
	Attribute List.

Detailed Description

Definition at line 18 of file SP_Ph1_Shunt.h.

Constructor & Destructor Documentation

Shunt() [1/2]

SP::Ph1::Shunt::Shunt	(	String	uid,
		String	name,
		Logger::Level	logLevel = Logger::Level::off )

Defines UID, name, component parameters and logging level.

Definition at line 13 of file SP_Ph1_Shunt.cpp.

Shunt() [2/2]

CPS::SP::Ph1::Shunt::Shunt ( String name, Logger::Level logLevel = Logger::Level::off )

inline

Defines name and logging level.

Definition at line 40 of file SP_Ph1_Shunt.h.

Member Function Documentation

calculatePerUnitParameters()

void SP::Ph1::Shunt::calculatePerUnitParameters	(	Real	baseApparentPower,
		Real	baseOmega )

Initializes component from power flow data.

Definition at line 37 of file SP_Ph1_Shunt.cpp.

pfApplyAdmittanceMatrixStamp()

void SP::Ph1::Shunt::pfApplyAdmittanceMatrixStamp ( SparseMatrixCompRow & Y )

virtual

Stamps admittance matrix.

Implements CPS::PFSolverInterfaceBranch.

Definition at line 55 of file SP_Ph1_Shunt.cpp.

setBaseVoltage()

void SP::Ph1::Shunt::setBaseVoltage

(

Real

baseVoltage

)

Set base voltage.

Definition at line 33 of file SP_Ph1_Shunt.cpp.

setParameters()

void SP::Ph1::Shunt::setParameters	(	Real	conductance,
		Real	susceptance )

Set shunt specific parameters.

Definition at line 24 of file SP_Ph1_Shunt.cpp.

Member Data Documentation

mConductance

const Attribute<Real>::Ptr CPS::SP::Ph1::Shunt::mConductance

Conductance [S].

Definition at line 23 of file SP_Ph1_Shunt.h.

mConductancePerUnit

const Attribute<Real>::Ptr CPS::SP::Ph1::Shunt::mConductancePerUnit

Conductance [pu].

Definition at line 27 of file SP_Ph1_Shunt.h.

mSusceptance

const Attribute<Real>::Ptr CPS::SP::Ph1::Shunt::mSusceptance

Susceptance [S].

Definition at line 25 of file SP_Ph1_Shunt.h.

mSusceptancePerUnit

const Attribute<Real>::Ptr CPS::SP::Ph1::Shunt::mSusceptancePerUnit

Susceptance [pu].

Definition at line 29 of file SP_Ph1_Shunt.h.

---

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

• /__w/dpsim/dpsim/dpsim-models/include/dpsim-models/SP/SP_Ph1_Shunt.h
• /__w/dpsim/dpsim/dpsim-models/src/SP/SP_Ph1_Shunt.cpp