SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor Class Reference
Inheritance diagram for python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor:

Public Member Functions

 __init__ (self, builder)
 
 withAdaptPoints (self, value)
 
 withAdaptRate (self, value)
 
 withAdaptThreshold (self, value)
 
 withParameters (self, params)
 
 withQoI (self, qoi)
 
 withRefinement (self)
 
 withStartingIterationNumber (self, iteration)
 
 withTimeStepsOfInterest (self, ts)
 
 withTypesOfKnowledge (self, knowledgeTypes)
 

Protected Attributes

 _builder
 

Detailed Description

Specification descriptor for ASGCSampler

Constructor & Destructor Documentation

◆ __init__()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__init__ (   self,
  builder 
)

Member Function Documentation

◆ withAdaptPoints()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withAdaptPoints (   self,
  value 
)
Specifies number of points, which have to be refined in refinement step
@param value: integer for number of points to refine

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.

◆ withAdaptRate()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withAdaptRate (   self,
  value 
)
Specifies rate from total number of points on grid, which should be
refined.
@param value: float for rate

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.

◆ withAdaptThreshold()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withAdaptThreshold (   self,
  value 
)
Specifies refinement threshold
@param value: float for refinement threshold

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.

◆ withParameters()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withParameters (   self,
  params 
)
Set the parameter setting
@param params: ParameterSet

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.

◆ withQoI()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withQoI (   self,
  qoi 
)
Define, which quantity of interest we study.
@param qoi: string quantity of interest

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.

◆ withRefinement()

◆ withStartingIterationNumber()

◆ withTimeStepsOfInterest()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withTimeStepsOfInterest (   self,
  ts 
)
Define the time steps in which we are interested in. The learner
just learns those, which are specified here. Moreover, it considers
just this time steps for refinement.
@param ts: list of floats, time steps

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.

◆ withTypesOfKnowledge()

python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withTypesOfKnowledge (   self,
  knowledgeTypes 
)
Define for which type of functions the hierarchical coefficients are
computed using the specified learner.
@param knowledgeTypes: list of KnowledgetTypes

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.

Member Data Documentation

◆ _builder


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