7.4. Module pyActivity

7.4.1. Overview

7.4.2. Classes

daeSimulation
daeOptimization
class pyActivity.daeSimulation

Bases: pyActivity.daeSimulation_t

Initialization methods

__init__((object)self) → None
Initialize((daeSimulation)self, (object)daeSolver, (daeDataReporter_t)dataReporter, (daeLog_t)log[, (bool)calculateSensitivities=False[, (str)jsonRuntimeSettings='']]) → None
SolveInitial((daeSimulation)self) → None
m
model
Model
DAESolver
Log
DataReporter
AbsoluteTolerances
RelativeTolerance
TotalNumberOfVariables
NumberOfEquations

Loading/storing the initialization data

LoadInitializationValues((daeSimulation)self, (str)filename) → None
StoreInitializationValues((daeSimulation)self, (str)filename) → None

Clean up methods

CleanUpSetupData((daeSimulation)self) → None
Finalize((daeSimulation)self) → None

Simulation setup methods

SetUpParametersAndDomains((daeSimulation)self) → None
SetUpVariables((daeSimulation)self) → None

Optimization setup methods

SetUpOptimization((daeSimulation)self) → None
CreateInequalityConstraint((daeSimulation)self, (str)description) → daeOptimizationConstraint
CreateEqualityConstraint((daeSimulation)self, (str)description) → daeOptimizationConstraint
SetContinuousOptimizationVariable((daeSimulation)self, (daeVariable)variable, (float)lowerBound, (float)upperBound, (float)defaultValue) → daeOptimizationVariable

SetContinuousOptimizationVariable( (daeSimulation)self, (daeVariable)variable, (object)qlowerBound, (object)qupperBound, (object)qdefaultValue) -> daeOptimizationVariable

SetContinuousOptimizationVariable( (daeSimulation)self, (adouble)ad, (float)lowerBound, (float)upperBound, (float)defaultValue) -> daeOptimizationVariable

SetContinuousOptimizationVariable( (daeSimulation)self, (adouble)ad, (float)qlowerBound, (float)qupperBound, (float)qdefaultValue) -> daeOptimizationVariable

SetIntegerOptimizationVariable((daeSimulation)self, (daeVariable)variable, (int)lowerBound, (int)upperBound, (int)defaultValue) → daeOptimizationVariable

SetIntegerOptimizationVariable( (daeSimulation)self, (adouble)ad, (int)lowerBound, (int)upperBound, (int)defaultValue) -> daeOptimizationVariable

SetBinaryOptimizationVariable((daeSimulation)self, (daeVariable)variable, (bool)defaultValue) → daeOptimizationVariable

SetBinaryOptimizationVariable( (daeSimulation)self, (adouble)ad, (bool)defaultValue) -> daeOptimizationVariable

OptimizationVariables
Constraints
ObjectiveFunction

Parameter estimation setup methods

SetUpParameterEstimation((daeSimulation)self) → None
SetMeasuredVariable((daeSimulation)self, (daeVariable)variable) → daeMeasuredVariable

SetMeasuredVariable( (daeSimulation)self, (adouble)ad) -> daeMeasuredVariable

SetInputVariable((daeSimulation)self, (daeVariable)variable) → daeVariableWrapper

SetInputVariable( (daeSimulation)self, (adouble)ad) -> daeVariableWrapper

SetModelParameter((daeSimulation)self, (daeVariable)variable, (float)lowerBound, (float)upperBound, (float)defaultValue) → daeOptimizationVariable

SetModelParameter( (daeSimulation)self, (adouble)ad, (float)lowerBound, (float)upperBound, (float)defaultValue) -> daeOptimizationVariable

InputVariables
MeasuredVariables
ModelParameters

Parameter estimation setup methods

SetUpSensitivityAnalysis((daeSimulation)self) → None

Operating procedures methods

Run((daeSimulation)self) → None
ReRun((daeSimulation)self) → None
Pause((daeSimulation)self) → None
Resume((daeSimulation)self) → None
ActivityAction
Integrate((daeSimulation)self, (daeeStopCriterion)stopCriterion[, (bool)reportDataAroundDiscontinuities=True]) → float
IntegrateForTimeInterval((daeSimulation)self, (float)timeInterval, (daeeStopCriterion)stopCriterion[, (bool)reportDataAroundDiscontinuities=True]) → float
IntegrateUntilTime((daeSimulation)self, (float)time, (daeeStopCriterion)stopCriterion[, (bool)reportDataAroundDiscontinuities=True]) → float
Reinitialize((daeSimulation)self) → None
Reset((daeSimulation)self) → None
CurrentTime
TimeHorizon
ReportingInterval
NextReportingTime
ReportingTimes

Data reporting methods

RegisterData((daeSimulation)self, (str)iteration) → None
ReportData((daeSimulation)self, (float)currentTime) → None

Various information

IndexMappings
InitialConditionMode
SimulationMode
VariableTypes
CalculateSensitivities
DoDataPartitioning((daeSimulation)self, (daeEquationsIndexes)equationsOverallIndexes, (map_ulong_ulong)mapOverallBlockIndexes) → None

DoDataPartitioning( (daeSimulation)self, (daeEquationsIndexes)equationsOverallIndexes, (map_ulong_ulong)mapOverallBlockIndexes) -> None

EquationExecutionInfos
IsInitialized
IsSolveInitial
JSONRuntimeSettings
LastSatisfiedCondition
TimeDerivatives
Values
class pyActivity.daeOptimization

Bases: pyActivity.daeOptimization_t

__init__((object)self) → None
Initialize((daeOptimization)self, (daeSimulation_t)simulation, (daeNLPSolver_t)nlpSolver, (object)daeSolver, (daeDataReporter_t)dataReporter, (daeLog_t)log[, (str)initializationFile='']) → None
Run((daeOptimization)self) → None
Finalize((daeOptimization)self) → None
EndIterationRun((daeOptimization)self, (int)iteration) → None

EndIterationRun( (daeOptimization)self, (int)iteration) -> None

Simulation
StartIterationRun((daeOptimization)self, (int)iteration) → None

StartIterationRun( (daeOptimization)self, (int)iteration) -> None

7.4.3. Enumerations

daeeStopCriterion
daeeActivityAction
daeeSimulationMode
class pyActivity.daeeStopCriterion

Bases: Boost.Python.enum

eDoNotStopAtDiscontinuity = pyActivity.daeeStopCriterion.eDoNotStopAtDiscontinuity
eStopAtModelDiscontinuity = pyActivity.daeeStopCriterion.eStopAtModelDiscontinuity
class pyActivity.daeeActivityAction

Bases: Boost.Python.enum

eAAUnknown = pyActivity.daeeActivityAction.eAAUnknown
ePauseActivity = pyActivity.daeeActivityAction.ePauseActivity
eRunActivity = pyActivity.daeeActivityAction.eRunActivity
class pyActivity.daeeSimulationMode

Bases: Boost.Python.enum

eOptimization = pyActivity.daeeSimulationMode.eOptimization
eParameterEstimation = pyActivity.daeeSimulationMode.eParameterEstimation
eSimulation = pyActivity.daeeSimulationMode.eSimulation