python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor Class Reference

Inheritance diagram for python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor:

Public Member Functions
	__getattr__ (self, attr)
	__init__ (self, builder)
	withAccuracy (self, accuracy)
	withAlphaReusing (self)
	withImax (self, imax)
	withThreshold (self, threshold)

Protected Attributes
	_builder

Detailed Description

CGSolver Descriptor helps to implement fluid interface patter on python
it encapsulates functionality concerning creation of the CG-Solver

Constructor & Destructor Documentation

__init__()

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__init__	(		self,
			builder
	)

Member Function Documentation

__getattr__()

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__getattr__	(		self,
			attr
	)

Overrides built-in method
if method called is not a object method of this Descriptor, most
probably it's a method of LearnerBuilder so it tries to call the
method from our builder
@param attr: String for method name
@return: Method calling in LearnerBuilder

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor._builder, python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor._builder, python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor._builder, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor._builder, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor._builder, and python.uq.parameters.ParameterBuilder.GeneralParameterBuilder._builder.

withAccuracy()

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.withAccuracy	(		self,
			accuracy
	)

Defines the accuracy of CG-Solver
@param accuracy: float for accuracy

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

withAlphaReusing()

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.withAlphaReusing

(

self

)

The reusage of previous alpha data in the CG iteration

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

withImax()

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.withImax	(		self,
			imax
	)

Defines the maximal number of iterations in CG algorithms
@param imax: integer for maximal number of iteration in CG

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

withThreshold()

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.withThreshold	(		self,
			threshold
	)

Defines the maximal accuracy. If the norm of the residuum
falls below this threshold, stop the CG iterations.
@param threshold: float maximal accuracy

References python.learner.LearnerBuilder.LearnerBuilder.CGSolverDescriptor.__solver, and python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__solver.

Member Data Documentation

_builder

python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor._builder

protected

Referenced by python.uq.learner.builder.CGSolverDescriptor.CGSolverDescriptor.__getattr__(), python.uq.learner.builder.InterpolantSpecificationDescriptor.InterpolantSpecificationDescriptor.__getattr__(), python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__getattr__(), python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.create(), python.uq.parameters.ParameterBuilder.GeneralParameterBuilder.getDescriptor(), python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withRefinement(), python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.withStartingIterationNumber(), and python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.withStopPolicy().

---

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

• datadriven/python/uq/learner/builder/CGSolverDescriptor.py