SG++-Doxygen-Documentation
python.uq.uq_setting.UQSpecification.UQSpecification Class Reference
Inheritance diagram for python.uq.uq_setting.UQSpecification.UQSpecification:

Public Member Functions

def __init__ (self)
 
def getEndTime (self)
 
def getFilename (self)
 
def getInterpolationFunction (self, p, ts, results)
 
def getPostprocessor (self)
 
def getPreprocessor (self)
 
def getSaveAfterEachRun (self, n)
 
def getSimulation (self)
 
def getStartTime (self)
 
def getTimeStep (self)
 
def hasInterpolationFunction (self)
 
def reachesSteadyState (self)
 
def setEndTime (self, tn)
 
def setFilename (self, filename)
 
def setInterpolationFunction (self, interp1d)
 
def setPostprocessor (self, postprocessor)
 
def setPreprocessor (self, preprocessor)
 
def setReachesSteadyState (self, reachesSteadyState)
 
def setSaveAfterEachRun (self, save)
 
def setSimulation (self, simulation)
 
def setStartTime (self, t0)
 
def setTimeStep (self, dt)
 

Detailed Description

UQ specification object

Constructor & Destructor Documentation

◆ __init__()

def python.uq.uq_setting.UQSpecification.UQSpecification.__init__ (   self)
Constructor

References python.uq.uq_setting.UQSpecification.UQSpecification.__dt, python.uq.uq_setting.UQSpecification.UQSpecification.__filename, python.uq.uq_setting.UQBuilder.UQBuilder.__filename, python.uq.uq_setting.UQSpecification.UQSpecification.__interp1d, python.uq.uq_setting.UQSpecification.UQSpecification.__interpolants, python.uq.uq_setting.UQSpecification.UQSpecification.__postprocessor, python.uq.uq_setting.UQSpecification.UQSpecification.__preprocessor, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__reachesSteadyState, python.uq.uq_setting.UQSpecification.UQSpecification.__reachesSteadyState, python.uq.uq_setting.UQSpecification.UQSpecification.__save, python.uq.uq_setting.UQSpecification.UQSpecification.__simulation, python.uq.uq_setting.UQSpecification.UQSpecification.__t0, and python.uq.uq_setting.UQSpecification.UQSpecification.__tn.

Member Function Documentation

◆ getEndTime()

def python.uq.uq_setting.UQSpecification.UQSpecification.getEndTime (   self)
Get end time of the simulation

References python.uq.uq_setting.UQSpecification.UQSpecification.__tn.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.findEquivalent(), python.uq.uq_setting.UQSetting.UQSetting.getTimeSetting(), and python.uq.uq_setting.UQSetting.UQSetting.merge().

◆ getFilename()

def python.uq.uq_setting.UQSpecification.UQSpecification.getFilename (   self)

References python.uq.uq_setting.UQSpecification.UQSpecification.__filename, and python.uq.uq_setting.UQBuilder.UQBuilder.__filename.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), and python.uq.uq_setting.UQSetting.UQSetting.writeToFile().

◆ getInterpolationFunction()

def python.uq.uq_setting.UQSpecification.UQSpecification.getInterpolationFunction (   self,
  p,
  ts,
  results 
)

References python.uq.uq_setting.UQSpecification.UQSpecification.__interp1d, and python.uq.uq_setting.UQSpecification.UQSpecification.__interpolants.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.getResult().

◆ getPostprocessor()

def python.uq.uq_setting.UQSpecification.UQSpecification.getPostprocessor (   self)
Get post-processor

References python.uq.uq_setting.UQSpecification.UQSpecification.__postprocessor.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.findEquivalent().

◆ getPreprocessor()

def python.uq.uq_setting.UQSpecification.UQSpecification.getPreprocessor (   self)
Get the pre-processor

References python.uq.uq_setting.UQSpecification.UQSpecification.__preprocessor.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.findEquivalent().

◆ getSaveAfterEachRun()

def python.uq.uq_setting.UQSpecification.UQSpecification.getSaveAfterEachRun (   self,
  n 
)

References python.uq.uq_setting.UQSpecification.UQSpecification.__save.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution().

◆ getSimulation()

def python.uq.uq_setting.UQSpecification.UQSpecification.getSimulation (   self)
Get simulation function

References python.uq.uq_setting.UQSpecification.UQSpecification.__simulation.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.findEquivalent().

◆ getStartTime()

def python.uq.uq_setting.UQSpecification.UQSpecification.getStartTime (   self)
Get start time of the simulation

References python.uq.uq_setting.UQSpecification.UQSpecification.__t0.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.findEquivalent(), python.uq.uq_setting.UQSetting.UQSetting.getTimeSetting(), and python.uq.uq_setting.UQSetting.UQSetting.merge().

◆ getTimeStep()

def python.uq.uq_setting.UQSpecification.UQSpecification.getTimeStep (   self)
Get time step of the simulation

References python.uq.uq_setting.UQSpecification.UQSpecification.__dt.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.findEquivalent(), python.uq.uq_setting.UQSetting.UQSetting.getTimeSetting(), and python.uq.uq_setting.UQSetting.UQSetting.merge().

◆ hasInterpolationFunction()

def python.uq.uq_setting.UQSpecification.UQSpecification.hasInterpolationFunction (   self)

References python.uq.uq_setting.UQSpecification.UQSpecification.__interp1d.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.getResult().

◆ reachesSteadyState()

def python.uq.uq_setting.UQSpecification.UQSpecification.reachesSteadyState (   self)

References python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__reachesSteadyState, and python.uq.uq_setting.UQSpecification.UQSpecification.__reachesSteadyState.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.getResult().

◆ setEndTime()

def python.uq.uq_setting.UQSpecification.UQSpecification.setEndTime (   self,
  tn 
)
Set end time of the simulation
@param tn: numeric end time

References python.uq.uq_setting.UQSpecification.UQSpecification.__tn.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.merge().

◆ setFilename()

def python.uq.uq_setting.UQSpecification.UQSpecification.setFilename (   self,
  filename 
)

References python.uq.uq_setting.UQSpecification.UQSpecification.__filename, and python.uq.uq_setting.UQBuilder.UQBuilder.__filename.

◆ setInterpolationFunction()

def python.uq.uq_setting.UQSpecification.UQSpecification.setInterpolationFunction (   self,
  interp1d 
)

References python.uq.uq_setting.UQSpecification.UQSpecification.__interp1d.

◆ setPostprocessor()

def python.uq.uq_setting.UQSpecification.UQSpecification.setPostprocessor (   self,
  postprocessor 
)
Set the post-processor function of the UQ Setting
@param postprocessor: post-processor function

References python.uq.uq_setting.UQSpecification.UQSpecification.__postprocessor.

◆ setPreprocessor()

def python.uq.uq_setting.UQSpecification.UQSpecification.setPreprocessor (   self,
  preprocessor 
)
Set the pre-processor function of the UQ setting
@param preprocessor: pre-processor

References python.uq.uq_setting.UQSpecification.UQSpecification.__preprocessor.

◆ setReachesSteadyState()

def python.uq.uq_setting.UQSpecification.UQSpecification.setReachesSteadyState (   self,
  reachesSteadyState 
)

References python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__reachesSteadyState, and python.uq.uq_setting.UQSpecification.UQSpecification.__reachesSteadyState.

◆ setSaveAfterEachRun()

def python.uq.uq_setting.UQSpecification.UQSpecification.setSaveAfterEachRun (   self,
  save 
)

References python.uq.uq_setting.UQSpecification.UQSpecification.__save.

◆ setSimulation()

def python.uq.uq_setting.UQSpecification.UQSpecification.setSimulation (   self,
  simulation 
)
Set the simulation function
@param simulation: simulation function

References python.uq.uq_setting.UQSpecification.UQSpecification.__simulation.

◆ setStartTime()

def python.uq.uq_setting.UQSpecification.UQSpecification.setStartTime (   self,
  t0 
)
Set start time of the simulation
@param t0: numeric start time

References python.uq.uq_setting.UQSpecification.UQSpecification.__t0.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.merge().

◆ setTimeStep()

def python.uq.uq_setting.UQSpecification.UQSpecification.setTimeStep (   self,
  dt 
)
Set time step of the simulation
@param dt: numeric time step

References python.uq.uq_setting.UQSpecification.UQSpecification.__dt.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.merge().


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