SG++-Doxygen-Documentation
python.uq.sampler.asgc.ASGCSampler.ASGCSampler Class Reference
Inheritance diagram for python.uq.sampler.asgc.ASGCSampler.ASGCSampler:

Public Member Functions

def __init__ (self, params, grid, refinementManager=None, stopPolicy=None)
 
def __str__ (self)
 
def createMemento (self)
 
def fromJson (cls, jsonObject)
 
def getCollocationNodes (self)
 
def getCurrentIterationNumber (self)
 
def getGrid (self)
 
def getSize (self)
 
def hasMoreSamples (self)
 
def nextSamples (self, knowledge=None, qoi="_", refinets=[0])
 
def refineGrid (self, knowledge, qoi="_", refinets=[0])
 
def setGrid (self, grid)
 
def setMemento (self, memento)
 
def toJson (self)
 

Public Attributes

 samples
 

Detailed Description

The ASGC sampler class

Constructor & Destructor Documentation

◆ __init__()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__init__ (   self,
  params,
  grid,
  refinementManager = None,
  stopPolicy = None 
)

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__grid, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid, python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.__iteration, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__iteration, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__params, python.uq.estimators.SparseGridEstimator.SparseGridEstimator.__params, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__params, python.uq.manager.ASGCUQManager.ASGCUQManager.__params, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__params, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__params, python.uq.parameters.ParameterSet.ParameterSet.__params, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__params, python.uq.parameters.ParameterSet.ParameterSetIterator.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__refinementManager, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__samples, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__samples, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__stopPolicy, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__verbose, and python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__verbose.

Member Function Documentation

◆ __str__()

◆ createMemento()

◆ fromJson()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.fromJson (   cls,
  jsonObject 
)
Restores the ASGCSampler object from the json object with its
attributes.
@param jsonObject: json object
@return: the restored ASGCSampler object

Referenced by python.uq.sampler.asgc.ASGCSampler.ASGCSampler.setMemento(), and python.uq.uq_setting.UQSetting.UQSetting.setMemento().

◆ getCollocationNodes()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getCollocationNodes (   self)
Create a set of all collocation nodes

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__grid, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid.

◆ getCurrentIterationNumber()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getCurrentIterationNumber (   self)

References python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.__iteration, and python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__iteration.

◆ getGrid()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getGrid (   self)

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__grid, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid.

◆ getSize()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getSize (   self)

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__grid, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.convert(), python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.refineGrid(), python.uq.uq_setting.UQSetting.UQSetting.runSamples(), and python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution().

◆ hasMoreSamples()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.hasMoreSamples (   self)

References python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.__iteration, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__iteration, and python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__stopPolicy.

◆ nextSamples()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.nextSamples (   self,
  knowledge = None,
  qoi = "_",
  refinets = [0] 
)
Generate the next samples with respect to the current knowledge
@return: Samples, set of new samples

References python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.__iteration, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__iteration, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__params, python.uq.estimators.SparseGridEstimator.SparseGridEstimator.__params, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__params, python.uq.manager.ASGCUQManager.ASGCUQManager.__params, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__params, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__params, python.uq.parameters.ParameterSet.ParameterSet.__params, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__params, and python.uq.parameters.ParameterSet.ParameterSetIterator.__params.

◆ refineGrid()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.refineGrid (   self,
  knowledge,
  qoi = "_",
  refinets = [0] 
)

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__grid, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid, python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.__iteration, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__iteration, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__params, python.uq.estimators.SparseGridEstimator.SparseGridEstimator.__params, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__params, python.uq.manager.ASGCUQManager.ASGCUQManager.__params, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__params, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__params, python.uq.parameters.ParameterSet.ParameterSet.__params, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__params, python.uq.parameters.ParameterSet.ParameterSetIterator.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__refinementManager, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__verbose, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__verbose, and python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getSize().

◆ setGrid()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.setGrid (   self,
  grid 
)

References python.uq.learner.builder.GridDescriptor.GridDescriptor.__grid, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__grid, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__grid.

◆ setMemento()

def python.uq.sampler.asgc.ASGCSampler.ASGCSampler.setMemento (   self,
  memento 
)

◆ toJson()

Member Data Documentation

◆ samples

python.uq.sampler.asgc.ASGCSampler.ASGCSampler.samples

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