python.SurrogateModel.SurrogateFunction Class Reference

Inheritance diagram for python.SurrogateModel.SurrogateFunction:

Public Member Functions
def	__init__ (self, args, kwargs)
	Constructor.
def	initKwargs (self, kwargs)
	Method that is overwritten by children. More...
def	indexSet (self, name)
	Method returning index for a specie in IndexSet. More...
def	checkVariableName (self, name)
	Method checking whether 'name' exists in the 'IndexSet'.
def	inputs_iterAll (self)
	Method returning an iterator over the SurrogateFunction inputs. More...
def	inputs_size (self)
	Method calculating the size of the input vector. More...
def	exceptionLoad (self, surrogateFunctionId)
	Method raising exception when a surrogate function is not instantiated.
def	load (self, surrogateFunctionId)
	Method loading a surrogate function from the database. More...

Static Public Attributes
	name = StringField(primary_key=True)
	inputs = MapField(EmbeddedDocumentField(MinMaxArgPosOpt))
	outputs = MapField(EmbeddedDocumentField(MinMaxArgPos))
	parameters = MapField(EmbeddedDocumentField(MinMaxArgPos))
	functionName = StringField(required=True)
	libraryName = StringField(required=True)
	indices = MapField(ReferenceField(IndexSet))
dictionary	meta = {'allow_inheritance': True}

Detailed Description

Definition at line 372 of file SurrogateModel.py.

Member Function Documentation

indexSet()

def python.SurrogateModel.SurrogateFunction.indexSet	(		self,
			name
	)

Method returning index for a specie in IndexSet.

Parameters

name	(str) Name of a specie in 'IndexSet'.

Returns

index (int) of specie 'name'.

Definition at line 453 of file SurrogateModel.py.

initKwargs()

def python.SurrogateModel.SurrogateFunction.initKwargs	(		self,
			kwargs
	)

Method that is overwritten by children.

Definition at line 444 of file SurrogateModel.py.

inputs_iterAll()

def python.SurrogateModel.SurrogateFunction.inputs_iterAll

(

self

)

Method returning an iterator over the SurrogateFunction inputs.

Definition at line 467 of file SurrogateModel.py.

inputs_size()

def python.SurrogateModel.SurrogateFunction.inputs_size

(

self

)

Method calculating the size of the input vector.

Definition at line 478 of file SurrogateModel.py.

load()

def python.SurrogateModel.SurrogateFunction.load	(		self,
			surrogateFunctionId
	)

Method loading a surrogate function from the database.

Parameters

surrogateFunctionId

(str) name ('_id') of a surrogate function.

Returns

instance of surrogate function

Definition at line 505 of file SurrogateModel.py.

---

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

• src/python/SurrogateModel.py