DPsim
Loading...
Searching...
No Matches
CPS::MNASyncGenInterface Class Referenceabstract

Interface to be used by synchronous generators. More...

#include <MNASyncGenInterface.h>

Inheritance diagram for CPS::MNASyncGenInterface:
[legend]
Collaboration diagram for CPS::MNASyncGenInterface:
[legend]

Public Types

typedef std::shared_ptr< MNASyncGenInterfacePtr
 
typedef std::vector< Ptr > List
 

Public Member Functions

virtual void correctorStep ()=0
 
virtual void updateVoltage (const Matrix &leftVector)=0
 
virtual bool requiresIteration ()
 
void setMaxIterations (Int maxIterations)
 
void setTolerance (Real Tolerance)
 

Protected Member Functions

 MNASyncGenInterface ()
 Constructor.
 

Protected Attributes

Attribute< Int >::Ptr mNumIter
 
Int mMaxIter = 25
 
Real mTolerance = 1e-6
 

Detailed Description

Interface to be used by synchronous generators.

Definition at line 17 of file MNASyncGenInterface.h.

Member Typedef Documentation

◆ List

typedef std::vector<Ptr> CPS::MNASyncGenInterface::List

Definition at line 28 of file MNASyncGenInterface.h.

◆ Ptr

typedef std::shared_ptr<MNASyncGenInterface> CPS::MNASyncGenInterface::Ptr

Definition at line 27 of file MNASyncGenInterface.h.

Constructor & Destructor Documentation

◆ ~MNASyncGenInterface()

virtual CPS::MNASyncGenInterface::~MNASyncGenInterface ( )
inlinevirtual

Definition at line 30 of file MNASyncGenInterface.h.

◆ MNASyncGenInterface()

CPS::MNASyncGenInterface::MNASyncGenInterface ( )
inlineprotected

Constructor.

Definition at line 48 of file MNASyncGenInterface.h.

Member Function Documentation

◆ requiresIteration()

virtual bool CPS::MNASyncGenInterface::requiresIteration ( )
inlinevirtual

Definition at line 38 of file MNASyncGenInterface.h.

◆ setMaxIterations()

void CPS::MNASyncGenInterface::setMaxIterations ( Int maxIterations)
inline

Setters

Definition at line 42 of file MNASyncGenInterface.h.

◆ setTolerance()

void CPS::MNASyncGenInterface::setTolerance ( Real Tolerance)
inline

Definition at line 44 of file MNASyncGenInterface.h.

Member Data Documentation

◆ mMaxIter

Int CPS::MNASyncGenInterface::mMaxIter = 25
protected

Definition at line 22 of file MNASyncGenInterface.h.

◆ mNumIter

Attribute<Int>::Ptr CPS::MNASyncGenInterface::mNumIter
protected

Definition at line 20 of file MNASyncGenInterface.h.

◆ mTolerance

Real CPS::MNASyncGenInterface::mTolerance = 1e-6
protected

Definition at line 24 of file MNASyncGenInterface.h.


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