python.uq.uq_setting.UQBuilder.UQBuilder Class Reference

Inheritance diagram for python.uq.uq_setting.UQBuilder.UQBuilder:

Public Member Functions
def	__init__ (self)
def	andGetResult (self)
def	fromFile (self, filename)
def	interpolateTimeDependentResults (self, kind='linear')
def	reachesSteadyState (self)
def	saveAfterEachRun (self, n=1)
def	verbose (self)
def	withEndTime (self, tn)
def	withoutTime (self)
def	withPostprocessor (self, postprocessor)
def	withPreprocessor (self, transformation)
def	withSimulation (self, simulation)
def	withStartTime (self, t0)
def	withTimestep (self, dt)

Detailed Description

Builder class for UQSetting.

Constructor & Destructor Documentation

__init__()

def python.uq.uq_setting.UQBuilder.UQBuilder.__init__

(

self

)

Constructor

References python.uq.uq_setting.UQBuilder.UQBuilder.__filename, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__verbose, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__verbose, and python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__verbose.

Member Function Documentation

andGetResult()

def python.uq.uq_setting.UQBuilder.UQBuilder.andGetResult

(

self

)

Generates a UQSetting object specified by the builder and
returns it to the user.

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__verbose, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__verbose, and python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__verbose.

fromFile()

def python.uq.uq_setting.UQBuilder.UQBuilder.fromFile	(		self,
			filename
	)

If the given file name exists, then the informations it
contains is recycled for the coming runs. If not, then it
specifies where the serialized UQSetting is going to be
stored.
@param filename: path to file containing a UQSetting
          serialization string

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

interpolateTimeDependentResults()

def python.uq.uq_setting.UQBuilder.UQBuilder.interpolateTimeDependentResults	(		self,
			kind = 'linear'
	)

Interpolate the result for one simulation path over time.
@param kind: string, type of interpolation

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

reachesSteadyState()

def python.uq.uq_setting.UQBuilder.UQBuilder.reachesSteadyState

(

self

)

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

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

saveAfterEachRun()

def python.uq.uq_setting.UQBuilder.UQBuilder.saveAfterEachRun	(		self,
			n = 1
	)

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

verbose()

def python.uq.uq_setting.UQBuilder.UQBuilder.verbose

(

self

)

References python.uq.uq_setting.UQBuilder.UQBuilder.__verbose, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__verbose, and python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__verbose.

Referenced by python.uq.operations.forcePositivity.findIntersections.IntersectionCandidates.findIntersections().

withEndTime()

def python.uq.uq_setting.UQBuilder.UQBuilder.withEndTime	(		self,
			tn
	)

Set the end time of the simulation
@param tn: end time

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withoutTime()

def python.uq.uq_setting.UQBuilder.UQBuilder.withoutTime

(

self

)

No time parameter used for the given simulation

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withPostprocessor()

def python.uq.uq_setting.UQBuilder.UQBuilder.withPostprocessor	(		self,
			postprocessor
	)

Sets the post-processor function which transforms the
simulation outcome to some quantitiy of interest
@param postprocessor: post-processor function

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withPreprocessor()

def python.uq.uq_setting.UQBuilder.UQBuilder.withPreprocessor	(		self,
			transformation
	)

Sets the transformation function for the input parameter
@param transformation: transformation function

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withSimulation()

def python.uq.uq_setting.UQBuilder.UQBuilder.withSimulation	(		self,
			simulation
	)

Sets the simulation function which is used as black box in the
UQ process.
@param simulation: simulation function

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withStartTime()

def python.uq.uq_setting.UQBuilder.UQBuilder.withStartTime	(		self,
			t0
	)

Set the start time of the simulation
@param t0: start time

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

withTimestep()

def python.uq.uq_setting.UQBuilder.UQBuilder.withTimestep	(		self,
			dt
	)

Set the time step of the simulation
@param dt: time step

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

---

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

• datadriven/python/uq/uq_setting/UQBuilder.py