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

Public Member Functions
	__init__ (self)

	andGetResult (self)

	fromFile (self, filename)

	interpolateTimeDependentResults (self, kind='linear')

	reachesSteadyState (self)

	saveAfterEachRun (self, n=1)

	verbose (self)

	withEndTime (self, tn)

	withoutTime (self)

	withPostprocessor (self, postprocessor)

	withPreprocessor (self, transformation)

	withSimulation (self, simulation)

	withStartTime (self, t0)

	withTimestep (self, dt)

Detailed Description

Builder class for UQSetting.

Constructor & Destructor Documentation

◆ init()

python.uq.uq_setting.UQBuilder.UQBuilder.__init__ ( self )

Constructor

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

Member Function Documentation

◆ andGetResult()

python.uq.uq_setting.UQBuilder.UQBuilder.andGetResult ( self )

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

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

◆ fromFile()

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.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ interpolateTimeDependentResults()

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.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ reachesSteadyState()

python.uq.uq_setting.UQBuilder.UQBuilder.reachesSteadyState ( self )

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

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

◆ saveAfterEachRun()

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

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

◆ verbose()

python.uq.uq_setting.UQBuilder.UQBuilder.verbose ( self )

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

Referenced by python.uq.operations.forcePositivity.operationMakePositiveFast.OperationMakePositiveFast.addFullGridPoints(), python.uq.refinement.RefinementManager.RefinementManager.candidates(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGridCandidates.computeCandidates(), python.uq.operations.forcePositivity.findIntersections.IntersectionCandidates.findIntersections(), python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGridCandidates.getLocalMaxLevel(), python.uq.manager.ASGCUQManager.ASGCUQManager.learnDataWithoutTest(), python.uq.manager.ASGCUQManager.ASGCUQManager.learnDataWithTest(), python.uq.operations.forcePositivity.operationMakePositive.OperationMakePositive.makeCurrentNodalValuesPositive(), python.uq.operations.forcePositivity.operationMakePositive.OperationMakePositive.makePositive(), python.uq.operations.forcePositivity.operationMakePositiveFast.OperationMakePositiveFast.makePositive(), python.uq.manager.ASGCUQManager.ASGCUQManager.recomputeStats(), python.uq.refinement.RefinementManager.RefinementManager.refineGrid(), and python.uq.operations.forcePositivity.localFullGridSearch.LocalFullGridCandidates.splitFullGrids().

◆ withEndTime()

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

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

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

◆ withoutTime()

python.uq.uq_setting.UQBuilder.UQBuilder.withoutTime ( self )

No time parameter used for the given simulation

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

◆ withPostprocessor()

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.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withPreprocessor()

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

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

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

◆ withSimulation()

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.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, and python.uq.uq_setting.UQSetting.UQSetting.__specification.

◆ withStartTime()

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

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

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

◆ withTimestep()

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

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

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

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

datadriven/python/uq/uq_setting/UQBuilder.py

Public Member Functions