Package net.simplace.usermodules.gk.learning

Class SpringPendulumRK

java.lang.Object

net.simplace.sim.model.FWSimComponent

net.simplace.usermodules.gk.learning.SpringPendulumRK

All Implemented Interfaces:

net.simplace.sim.util.FWSimFieldContainer

public class SpringPendulumRK
extends net.simplace.sim.model.FWSimComponent

Author:

Gunther Krauss

Component Variables

Content Type	Name	Description	Data Type	Unit	Min Value	Max Value	Default Value
constant	cInitialDistortion	-	DOUBLE		-	-	1.0
constant	cInitialVelocity	-	DOUBLE		-	-	0.0
constant	cIntegrationMethod	-	CHAR	Integration methods: one of 'euler', 'midpoint', 'heun2','rk3', 'rk4'	-	-
constant	cMass	-	DOUBLE		-	-	5.0
constant	cSpringConstant	-	DOUBLE		-	-	0.3
constant	cStepsPerDay	-	INT		-	-	1
state	sDistortion	-	DOUBLE		-	-	0.0
state	sVelocity	-	DOUBLE		-	-	0.0
rate	rDistortionRate	-	DOUBLE		-	-	0.0
rate	rVelocityRate	-	DOUBLE		-	-	0.0
out	SystemEnergy	-	DOUBLE		-	-	-

Nested Class Summary

Nested classes/interfaces inherited from class net.simplace.sim.model.FWSimComponent

net.simplace.sim.model.FWSimComponent.TEST_STATE

Field Summary

Fields inherited from class net.simplace.sim.model.FWSimComponent

iFieldMap, iFrequence, iInputMap, iJexlRule, iMasterComponentGroup, iName, iOrderNumber, isComponentGroup, iSimComponentElement, iSimModel, iVarMap

Constructor Summary

Constructors

Constructor	Description
SpringPendulumRK()	Empty constructor used by class.forName()
SpringPendulumRK(String aName, HashMap<String,net.simplace.sim.util.FWSimVariable<?>> aFieldMap, HashMap<String,String> aInputMap, org.jdom2.Element aSimComponentElement, net.simplace.sim.util.FWSimVarMap aVarMap, int aOrderNumber)

Method Summary

Modifier and Type	Method	Description
protected double[]	calculateRates(double time, double[] states, double[] params)
protected net.simplace.sim.model.FWSimComponent	clone(net.simplace.sim.util.FWSimVarMap aVarMap)	creates a clone from this SimComponent for use in other threads
HashMap<String,net.simplace.sim.util.FWSimVariable<?>>	createVariables()
HashMap<String,net.simplace.sim.util.FWSimVariable<?>>	fillTestVariables(int aParamIndex, net.simplace.sim.model.FWSimComponent.TEST_STATE aDefineOrCheck)	called for single component test to check the components algorithm.
protected void	init()
protected void	process()

Methods inherited from class net.simplace.sim.model.FWSimComponent

addVariable, bind, checkCondition, createSimComponent, createSimComponent, createSimComponent, createSimComponent, doProcess, getConstantVariables, getContentType, getCreateFormXML, getDescription, getEditFormXML, getFieldMap, getFrequence, getFrequenceRuleScript, getInputs, getInputVariables, getMasterComponentGroup, getName, getOrderNumber, getOutputVariables, getVariable, getVariableField, getVarMap, initialize, isConditionCheck, isVariableAvailable, performLinks, performLinks, readInputs, removeVariable, reset, runComponentTest, setVariablesDefault, toComponentLinkingXML, toDocXML, toGroupXML, toOutputDefinitionXML, toResourcesDataXML, toResourcesDefinitionXML, toString, toXML, writeVarInfos

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SpringPendulumRK

public SpringPendulumRK(String aName,
 HashMap<String,net.simplace.sim.util.FWSimVariable<?>> aFieldMap,
 HashMap<String,String> aInputMap,
 org.jdom2.Element aSimComponentElement,
 net.simplace.sim.util.FWSimVarMap aVarMap,
 int aOrderNumber)

Parameters:

aName -

aFieldMap -

aInputMap -

aSimComponentElement -

aVarMap -

aOrderNumber -

SpringPendulumRK

public SpringPendulumRK()

Empty constructor used by class.forName()

Method Details

createVariables

public HashMap<String,net.simplace.sim.util.FWSimVariable<?>> createVariables()

Specified by:

createVariables in interface net.simplace.sim.util.FWSimFieldContainer

Specified by:

createVariables in class net.simplace.sim.model.FWSimComponent

See Also:

• FWSimComponent.createVariables()

init

protected void init()

Specified by:

init in class net.simplace.sim.model.FWSimComponent

See Also:

• FWSimComponent.init()

calculateRates

protected double[] calculateRates(double time,
 double[] states,
 double[] params)

process

protected void process()

Specified by:

process in class net.simplace.sim.model.FWSimComponent

See Also:

• FWSimComponent.process()

fillTestVariables

public HashMap<String,net.simplace.sim.util.FWSimVariable<?>> fillTestVariables(int aParamIndex,
 net.simplace.sim.model.FWSimComponent.TEST_STATE aDefineOrCheck)

called for single component test to check the components algorithm.

Specified by:

fillTestVariables in class net.simplace.sim.model.FWSimComponent

See Also:

• net.simplace.sim.util.FWSimFieldContainer#fillTestVariables(int aParamIndex, TEST_STATE aDefineOrCheck)

clone

protected net.simplace.sim.model.FWSimComponent clone(net.simplace.sim.util.FWSimVarMap aVarMap)

creates a clone from this SimComponent for use in other threads

Specified by:

clone in class net.simplace.sim.model.FWSimComponent

See Also:

• FWSimComponent.clone(net.simplace.sim.util.FWSimVarMap)