python.SurrogateModel.ForwardMappingModel Class Reference

Class for defining 'forward mapping' models. More...

Inheritance diagram for python.SurrogateModel.ForwardMappingModel:

Public Member Functions
def	__init__ (self, args, kwargs)
def	initKwargs (self, kwargs)
def	exactTasks (self, points)
	Return an empty workflow.
Public Member Functions inherited from python.SurrogateModel.SurrogateModel
def	__init__ (self, args, kwargs)
	Constructor. More...
def	initKwargs (self, kwargs)
def	parseIndices (self, name)
	Method parsing the name of a function to determine the species, i.e. More...
def	expandIndices (self, name)
	Method expending the indexes of a function name. More...
def	expandIndicesWithName (self, name)
def	outputsToModels (self)
	Method mapping outputs to substitute models. More...
def	inputsMinMax (self)
	Method determining min and max input taking substitute models into account. More...
def	inputs_argPos (self, name)
	Method mapping input argument position.
def	outputs_argPos (self, name)
	Method mapping output argument positions. More...
def	parameters_argPos (self, name)
	Method mapping parameter argument position. More...
def	calculate_maps (self, sm)
	Method mapping outputs to inputs wrt. More...
def	minMax (self)
	Method returning min and max of input variables. More...
def	updateMinMax (self)
	Method updating min and max values.
def	error (self, cModel, kwargs)
	Method generating an iterator that yields the error of every. More...
def	__getattribute__ (self, name)
	Modified magic method. More...
def	__setattribute__ (self, name, value)
	Modified magic method. More...
def	exceptionOutOfBounds (self, oPoint)
	Method returning exception when a surrogate function is out of bounds. More...
def	exceptionLoad (self, surrogateModelId)
	Method returning exception when a surrogate function is not instantiated. More...
def	exceptionParametersNotValid (self, surrogateModelId)
	Method raising a exception when a surrogate model has no valid parameters after loading it.
def	callModel (self, inputs)
	Method for calling the surrogate function. More...
def	updateFitDataFromFwSpec (self, fw_spec)
	Method updating the parameters of the surrogate model. More...
def	initialisationStrategy (self)
	Method loading the initialisation strategy. More...
def	load (self, surrogateModelId)
	Method loading a specific surrogate model. More...
def	loadFailing (self)
	Method returning all objects that have a 'outside point' key.
def	loadFromModule (self)
	Method importing a surrogate model module. More...
def	loadParametersNotValid (self)
	Method importing a surrogate model module. More...
def	get_instances (self)
	Method returning an iterator over all SurrogateModel instances. More...
def	__repr__ (self)

Static Public Attributes
	inputs = MapField(EmbeddedDocumentField(MinMaxArgPosOpt))
	outputs = MapField(EmbeddedDocumentField(MinMaxArgPosOpt))
	substituteModels = ListField(ReferenceField(SurrogateModel))
dictionary	meta = {'allow_inheritance': True}
Static Public Attributes inherited from python.SurrogateModel.SurrogateModel
	surrogateFunction = ReferenceField(SurrogateFunction, required=True)
	parameters = ListField(FloatField())
dictionary	meta = {'allow_inheritance': True}

Additional Inherited Members
Data Fields inherited from python.SurrogateModel.SurrogateModel
	outsidePoint
	nSamples

Detailed Description

Class for defining 'forward mapping' models.

A forward mapping model can be thought of as a constitutive equation, or a scaling function.

                   f(X) => Y = 2 * X
            +---------------------+
            |                     |
          |-+---|             |---v------|
                X                        Y

Definition at line 1346 of file SurrogateModel.py.

---

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

• src/python/SurrogateModel.py