com.interpss.dstab.algo

Interface DynamicSimuAlgorithm

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, NameTag, NetworkRef<BaseDStabNetwork<?,?>>, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

DynamicSimuAlgorithmImpl

public interface DynamicSimuAlgorithm
extends NetworkRef<BaseDStabNetwork<?,?>>

A representation of the model object 'Dynamic Simu Algorithm'. DStab simulation algorithm. It holds parameters for the simulation. The actual implementation is done in the IDStabSolver object.

The following features are supported:

• Total Simu Time Sec
• Simu Step Sec
• Simu Method
• Output Per Steps
• Output Filtered
• Output Var Id List
• Disable Dynamic Event
• Ref Machine
• Aclf Algorithm
• Simu Output Handler
• Script Output Handler
• Dynamic Event Handler

See Also:

DstabAlgorithmPackage.getDynamicSimuAlgorithm()

Method Summary

Modifier and Type	Method and Description
boolean	createBranchFault(java.lang.String fromBusId, java.lang.String toBusId, java.lang.String circuitId, double startTime, double fromClearTime, double toClearTime, SimpleFaultCode faultCode, org.apache.commons.math3.complex.Complex zLG, org.apache.commons.math3.complex.Complex zLL) create a BranchFault dynamic event and add to the DStabNetwork.dynamicEventList
boolean	createBusFault(java.lang.String faultBusId, double startTime, double durationTime, SimpleFaultCode faultCode, org.apache.commons.math3.complex.Complex Zlg, org.apache.commons.math3.complex.Complex Zll) Create a bus fault and add it as a dynamic event to the dstab network Required information: fault bus id, start time in sec, duration time in sec, fault code to specify the fault type, as well as fault impedance
LoadflowAlgorithm	getAclfAlgorithm() Returns the value of the 'Aclf Algorithm' containment reference.
IpssMsgListener	getDynamicEventHandler() Returns the value of the 'Dynamic Event Handler' attribute.
int	getOutputPerSteps() Returns the value of the 'Output Per Steps' attribute.
int	getOutPutPerSteps()
java.lang.String[]	getOutputVarIdList() Returns the value of the 'Output Var Id List' attribute.
Machine	getRefMachine() Returns the value of the 'Ref Machine' reference.
IDStabSimuOutputHandler	getScriptOutputHandler() Returns the value of the 'Script Output Handler' attribute.
DynamicSimuMethod	getSimuMethod() Returns the value of the 'Simu Method' attribute.
IDStabSimuOutputHandler	getSimuOutputHandler() Returns the value of the 'Simu Output Handler' attribute.
double	getSimuStepSec() Returns the value of the 'Simu Step Sec' attribute.
double	getSimuTime() get current simulation time
double	getTotalSimuTimeSec() Returns the value of the 'Total Simu Time Sec' attribute.
boolean	initialization() perform initialization before the dynamic simulation
boolean	isDisableDynamicEvent() Returns the value of the 'Disable Dynamic Event' attribute.
boolean	isOutputFiltered() Returns the value of the 'Output Filtered' attribute.
boolean	performSimulation() perform dynamic simulation of the DStabNet object
boolean	performSimulationTo(double toTimeSec) perform dynamic simulation of the DStabNet object from the current time to the toTimeSec
void	setAclfAlgorithm(LoadflowAlgorithm value) Sets the value of the 'Aclf Algorithm' containment reference.
void	setDisableDynamicEvent(boolean value) Sets the value of the 'Disable Dynamic Event' attribute.
void	setDynamicEventHandler(IpssMsgListener value) Sets the value of the 'Dynamic Event Handler' attribute.
void	setOutputFiltered(boolean value) Sets the value of the 'Output Filtered' attribute.
void	setOutputPerSteps(int value) Sets the value of the 'Output Per Steps' attribute.
void	setOutPutPerSteps(int outPerSteps)
void	setOutputVarIdList(java.lang.String[] value) Sets the value of the 'Output Var Id List' attribute.
void	setRefMachine(Machine value) Sets the value of the 'Ref Machine' reference.
void	setScriptOutputHandler(IDStabSimuOutputHandler value) Sets the value of the 'Script Output Handler' attribute.
void	setSimuMethod(DynamicSimuMethod value) Sets the value of the 'Simu Method' attribute.
void	setSimuOutputHandler(IDStabSimuOutputHandler value) Sets the value of the 'Simu Output Handler' attribute.
void	setSimuStepSec(double value) Sets the value of the 'Simu Step Sec' attribute.
void	setSimuTime(double t) Set current simulation time
void	setSolver(IDStabSolver solver) set the DStab solver
void	setTotalSimuTimeSec(double value) Sets the value of the 'Total Simu Time Sec' attribute.
boolean	solveDEqnStep(boolean updateTime) perform one step of dynamic simulation of the DStabNet object

Methods inherited from interface com.interpss.core.net.ref.NetworkRef

getNetwork, setNetwork

Methods inherited from interface com.interpss.core.net.NameTag

checkData, checkData, getDesc, getId, getName, getNumber, getStatusChangeInfo, hzCopy, isActive, isStatus, jsonCopy, setDesc, setId, setName, setNumber, setStatus, setStatusChangeInfo

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Method Detail

getTotalSimuTimeSec

double getTotalSimuTimeSec()

Returns the value of the 'Total Simu Time Sec' attribute.

If the meaning of the 'Total Simu Time Sec' attribute isn't clear, there really should be more of a description here...

Total simulation time in sec

Returns:

the value of the 'Total Simu Time Sec' attribute.

See Also:

setTotalSimuTimeSec(double), DstabAlgorithmPackage.getDynamicSimuAlgorithm_TotalSimuTimeSec()

setTotalSimuTimeSec

void setTotalSimuTimeSec(double value)

Sets the value of the 'Total Simu Time Sec' attribute.

Parameters:

value - the new value of the 'Total Simu Time Sec' attribute.

See Also:

getTotalSimuTimeSec()

getSimuStepSec

double getSimuStepSec()

Returns the value of the 'Simu Step Sec' attribute.

If the meaning of the 'Simu Step Sec' attribute isn't clear, there really should be more of a description here...

simulation time step length in sec

Returns:

the value of the 'Simu Step Sec' attribute.

See Also:

setSimuStepSec(double), DstabAlgorithmPackage.getDynamicSimuAlgorithm_SimuStepSec()

setSimuStepSec

void setSimuStepSec(double value)

Sets the value of the 'Simu Step Sec' attribute.

Parameters:

value - the new value of the 'Simu Step Sec' attribute.

See Also:

getSimuStepSec()

getSimuMethod

DynamicSimuMethod getSimuMethod()

Returns the value of the 'Simu Method' attribute. The default value is "ModifiedEuler". The literals are from the enumeration DynamicSimuMethod.

If the meaning of the 'Simu Method' attribute isn't clear, there really should be more of a description here...

Simulation method

Returns:

the value of the 'Simu Method' attribute.

See Also:

DynamicSimuMethod, setSimuMethod(DynamicSimuMethod), DstabAlgorithmPackage.getDynamicSimuAlgorithm_SimuMethod()

setSimuMethod

void setSimuMethod(DynamicSimuMethod value)

Sets the value of the 'Simu Method' attribute.

Parameters:

value - the new value of the 'Simu Method' attribute.

See Also:

DynamicSimuMethod, getSimuMethod()

getOutputPerSteps

int getOutputPerSteps()

Returns the value of the 'Output Per Steps' attribute.

Returns:

the value of the 'Output Per Steps' attribute.

See Also:

setOutputPerSteps(int), DstabAlgorithmPackage.getDynamicSimuAlgorithm_OutputPerSteps()

setOutputPerSteps

void setOutputPerSteps(int value)

Sets the value of the 'Output Per Steps' attribute.

Parameters:

value - the new value of the 'Output Per Steps' attribute.

See Also:

getOutputPerSteps()

isOutputFiltered

boolean isOutputFiltered()

Returns the value of the 'Output Filtered' attribute.

If the meaning of the 'Output Filtered' attribute isn't clear, there really should be more of a description here...

option to control simulation output

Returns:

the value of the 'Output Filtered' attribute.

See Also:

setOutputFiltered(boolean), DstabAlgorithmPackage.getDynamicSimuAlgorithm_OutputFiltered()

setOutputFiltered

void setOutputFiltered(boolean value)

Sets the value of the 'Output Filtered' attribute.

Parameters:

value - the new value of the 'Output Filtered' attribute.

See Also:

isOutputFiltered()

getOutputVarIdList

java.lang.String[] getOutputVarIdList()

Returns the value of the 'Output Var Id List' attribute.

If the meaning of the 'Output Var Id List' attribute isn't clear, there really should be more of a description here...

filtered simulation output variable list

Returns:

the value of the 'Output Var Id List' attribute.

See Also:

setOutputVarIdList(String[]), DstabAlgorithmPackage.getDynamicSimuAlgorithm_OutputVarIdList()

setOutputVarIdList

void setOutputVarIdList(java.lang.String[] value)

Sets the value of the 'Output Var Id List' attribute.

Parameters:

value - the new value of the 'Output Var Id List' attribute.

See Also:

getOutputVarIdList()

getSimuOutputHandler

IDStabSimuOutputHandler getSimuOutputHandler()

Returns the value of the 'Simu Output Handler' attribute.

If the meaning of the 'Simu Output Handler' attribute isn't clear, there really should be more of a description here...

Simulation output event handler, it could be bound to a different handler implementation.

Returns:

the value of the 'Simu Output Handler' attribute.

See Also:

setSimuOutputHandler(IDStabSimuOutputHandler), DstabAlgorithmPackage.getDynamicSimuAlgorithm_SimuOutputHandler()

setSimuOutputHandler

void setSimuOutputHandler(IDStabSimuOutputHandler value)

Sets the value of the 'Simu Output Handler' attribute.

Parameters:

value - the new value of the 'Simu Output Handler' attribute.

See Also:

getSimuOutputHandler()

getScriptOutputHandler

IDStabSimuOutputHandler getScriptOutputHandler()

Returns the value of the 'Script Output Handler' attribute. Simulation output event handler, it could be bound to a different handler implementation.

Returns:

the value of the 'Script Output Handler' attribute.

See Also:

setScriptOutputHandler(IDStabSimuOutputHandler), DstabAlgorithmPackage.getDynamicSimuAlgorithm_ScriptOutputHandler()

setScriptOutputHandler

void setScriptOutputHandler(IDStabSimuOutputHandler value)

Sets the value of the 'Script Output Handler' attribute.

Parameters:

value - the new value of the 'Script Output Handler' attribute.

See Also:

getScriptOutputHandler()

getDynamicEventHandler

IpssMsgListener getDynamicEventHandler()

Returns the value of the 'Dynamic Event Handler' attribute.

If the meaning of the 'Dynaic Event Handler' attribute isn't clear, there really should be more of a description here...

Dynimic Event handler for handling dynamic event. It will modify the DStab object when applying the dynamic event. Also, it could be bound to a different handler implementation.

Returns:

the value of the 'Dynamic Event Handler' attribute.

See Also:

setDynamicEventHandler(IpssMsgListener), DstabAlgorithmPackage.getDynamicSimuAlgorithm_DynamicEventHandler()

setDynamicEventHandler

void setDynamicEventHandler(IpssMsgListener value)

Sets the value of the 'Dynamic Event Handler' attribute.

Parameters:

value - the new value of the 'Dynamic Event Handler' attribute.

See Also:

getDynamicEventHandler()

isDisableDynamicEvent

boolean isDisableDynamicEvent()

Returns the value of the 'Disable Dynamic Event' attribute.

If the meaning of the 'Disable Dynamic Event' attribute isn't clear, there really should be more of a description here...

option to disable all dynamic event. Usually for testing purpose.

Returns:

the value of the 'Disable Dynamic Event' attribute.

See Also:

setDisableDynamicEvent(boolean), DstabAlgorithmPackage.getDynamicSimuAlgorithm_DisableDynamicEvent()

setDisableDynamicEvent

void setDisableDynamicEvent(boolean value)

Sets the value of the 'Disable Dynamic Event' attribute.

Parameters:

value - the new value of the 'Disable Dynamic Event' attribute.

See Also:

isDisableDynamicEvent()

getRefMachine

Machine getRefMachine()

Returns the value of the 'Ref Machine' reference.

If the meaning of the 'Ref Machine' containment reference list isn't clear, there really should be more of a description here...

Reference machine for the simulaiton

Returns:

the value of the 'Ref Machine' reference.

See Also:

setRefMachine(Machine), DstabAlgorithmPackage.getDynamicSimuAlgorithm_RefMachine()

setRefMachine

void setRefMachine(Machine value)

Sets the value of the 'Ref Machine' reference.

Parameters:

value - the new value of the 'Ref Machine' reference.

See Also:

getRefMachine()

getAclfAlgorithm

LoadflowAlgorithm getAclfAlgorithm()

Returns the value of the 'Aclf Algorithm' containment reference.

If the meaning of the 'Aclf Algorithm' containment reference isn't clear, there really should be more of a description here...

reference to Aclf algorithm for establish the initial condition for the simulation.

Returns:

the value of the 'Aclf Algorithm' containment reference.

See Also:

setAclfAlgorithm(LoadflowAlgorithm), DstabAlgorithmPackage.getDynamicSimuAlgorithm_AclfAlgorithm()

setAclfAlgorithm

void setAclfAlgorithm(LoadflowAlgorithm value)

Sets the value of the 'Aclf Algorithm' containment reference.

Parameters:

value - the new value of the 'Aclf Algorithm' containment reference.

See Also:

getAclfAlgorithm()

setSolver

void setSolver(IDStabSolver solver)

set the DStab solver

performSimulation

boolean performSimulation()

perform dynamic simulation of the DStabNet object

performSimulationTo

boolean performSimulationTo(double toTimeSec)

perform dynamic simulation of the DStabNet object from the current time to the toTimeSec

initialization

boolean initialization()

perform initialization before the dynamic simulation

solveDEqnStep

boolean solveDEqnStep(boolean updateTime)

perform one step of dynamic simulation of the DStabNet object

getSimuTime

double getSimuTime()

get current simulation time

Returns:

current simulation time

setSimuTime

void setSimuTime(double t)

Set current simulation time

getOutPutPerSteps

int getOutPutPerSteps()

setOutPutPerSteps

void setOutPutPerSteps(int outPerSteps)

Parameters:

outPerSteps -

createBusFault

boolean createBusFault(java.lang.String faultBusId,
                       double startTime,
                       double durationTime,
                       SimpleFaultCode faultCode,
                       org.apache.commons.math3.complex.Complex Zlg,
                       org.apache.commons.math3.complex.Complex Zll)

Create a bus fault and add it as a dynamic event to the dstab network Required information: fault bus id, start time in sec, duration time in sec, fault code to specify the fault type, as well as fault impedance

Parameters:

faultBusId -

startTime -

durationTime -

faultCode -

Zlg - : line to ground impedance

Zll - : line to line impedance

Returns:

createBranchFault

boolean createBranchFault(java.lang.String fromBusId,
                          java.lang.String toBusId,
                          java.lang.String circuitId,
                          double startTime,
                          double fromClearTime,
                          double toClearTime,
                          SimpleFaultCode faultCode,
                          org.apache.commons.math3.complex.Complex zLG,
                          org.apache.commons.math3.complex.Complex zLL)

create a BranchFault dynamic event and add to the DStabNetwork.dynamicEventList