DPsim::MNAStateSpaceContributor Class Reference

#include <MNAStateSpaceContributor.h>

Public Types
using	Ptr = std::shared_ptr<MNAStateSpaceContributor>
using	List = std::vector<Ptr>

Public Member Functions
virtual	~MNAStateSpaceContributor ()=default
virtual UInt	getStateCount () const =0
	Number of local extraction states contributed by this component.
virtual Bool	contributesToUpdatedMatrices () const
	Whether this contributor belongs to the updated matrix group.
virtual Bool	requiresUpdate () const
	Whether this contributor requests its matrices to be refreshed.
virtual CPS::AttributeBase::List	getAttributeDependencies () const
	Attributes that must be up to date before this contribution is stamped.
virtual void	stamp (Matrix &AdLocal, Matrix &BdMna, Matrix &CdMna, UInt stateOffset, UInt mnaVectorSize) const =0
	Stamp this component's current local state-space contribution.
virtual void	contributeMetadata (StateSpaceMetadata &metadata, UInt stateOffset) const

Detailed Description

Live adapter that contributes one component's local state-space blocks to the MNA-coupled state-space extraction.

The extracted system is assembled as:

x[k+1] = AdLocal x[k] + BdMna xMNA[k+1] Y xMNA[k+1] = CdMna x[k]

where x is the extraction-state vector and xMNA is the full MNA unknown vector. CdMna maps extraction states to MNA current injections.

Definition at line 46 of file MNAStateSpaceContributor.h.

Member Typedef Documentation

List

using DPsim::MNAStateSpaceContributor::List = std::vector<Ptr>

Definition at line 49 of file MNAStateSpaceContributor.h.

Ptr

using DPsim::MNAStateSpaceContributor::Ptr = std::shared_ptr<MNAStateSpaceContributor>

Definition at line 48 of file MNAStateSpaceContributor.h.

Constructor & Destructor Documentation

~MNAStateSpaceContributor()

virtual DPsim::MNAStateSpaceContributor::~MNAStateSpaceContributor ( )

virtualdefault

Member Function Documentation

contributeMetadata()

virtual void DPsim::MNAStateSpaceContributor::contributeMetadata ( StateSpaceMetadata & metadata, UInt stateOffset ) const

inlinevirtual

Contribute metadata for this component's extracted states.

stateOffset is the first global extracted-state index of this contributor. The default implementation contributes no metadata.

Definition at line 75 of file MNAStateSpaceContributor.h.

contributesToUpdatedMatrices()

virtual Bool DPsim::MNAStateSpaceContributor::contributesToUpdatedMatrices ( ) const

inlinevirtual

Whether this contributor belongs to the updated matrix group.

Definition at line 57 of file MNAStateSpaceContributor.h.

getAttributeDependencies()

virtual CPS::AttributeBase::List DPsim::MNAStateSpaceContributor::getAttributeDependencies ( ) const

inlinevirtual

Attributes that must be up to date before this contribution is stamped.

Definition at line 63 of file MNAStateSpaceContributor.h.

getStateCount()

virtual UInt DPsim::MNAStateSpaceContributor::getStateCount ( ) const

pure virtual

Number of local extraction states contributed by this component.

requiresUpdate()

virtual Bool DPsim::MNAStateSpaceContributor::requiresUpdate ( ) const

inlinevirtual

Whether this contributor requests its matrices to be refreshed.

Definition at line 60 of file MNAStateSpaceContributor.h.

stamp()

virtual void DPsim::MNAStateSpaceContributor::stamp ( Matrix & AdLocal, Matrix & BdMna, Matrix & CdMna, UInt stateOffset, UInt mnaVectorSize ) const

pure virtual

Stamp this component's current local state-space contribution.

---

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

• /__w/dpsim/dpsim/dpsim/include/dpsim/MNAStateSpaceContributor.h