Package parasol :: Module parasol_main :: Class ParametricSoln
[hide private]
[frames] | no frames]

Class ParametricSoln

source code


a parametric solution object for running a parametric model

Instance Methods [hide private]
 
getVersion(self) source code
 
__getitem__(self, name)
return the value of design or result variable with name
source code
 
__setitem__(self, name, val)
set the value of design or result variable with name
source code
 
__call__(self, *varNames)
return the values of design and result variables in varNames list
source code
 
__init__(self, subtaskName='simple model', taskName='System Study', controlRoutine=None, author='', constraintTolerance=0.001, renderControlRoutine=None, probDesc=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__del__(self) source code
 
close(self) source code
 
setDesignVar(self, dvStr, val) source code
 
getDesignVar(self, dvStr) source code
 
getDesVars(self, *dvItems)
handle either single design var or list of design vars
source code
 
getDesignVarAxisLabel(self, dvStr) source code
 
getControlDesVarStr(self, key) source code
 
getDesVarShortSummary(self, *omitList) source code
 
getDesVarSummary(self, *omitList) source code
 
getHTMLDesVarSummary(self, *omitList) source code
 
getHTMLResultVarSummary(self) source code
 
saveDesVarSummary(self) source code
 
setControlRoutine(self, controlRoutine) source code
 
setRenderControlRoutine(self, renderControlRoutine) source code
 
hasDesignVar(self, dvStr) source code
 
addDesignVariable(self, name='desvar', InitialVal=0.0, minVal=-1e+300, maxVal=1e+300, NSteps=10, units='', desc='', step=None, linear=1) source code
 
addDesVars(self, *dvLists) source code
 
hasFeasibleResultVar(self, fvStr) source code
 
hasFeasibleControlVar(self, fvCVStr) source code
 
getFeasibleVarWithResultVar(self, fvStr) source code
 
getFeasibleVarWithControlVar(self, fvCVStr) source code
 
makeFeasiblePair(self, outName='feasvar', feasibleVal=0.0, inpName='inpvar', tolerance=1e-006, maxLoops=40, failValue=None) source code
 
hasMinMaxVar(self, mmvStr) source code
 
hasMinMaxControlVar(self, mmvCVStr) source code
 
getMinMaxVar(self, mmvStr) source code
 
getMinMaxVarWithControlVar(self, mmvCVStr) source code
 
makeMinMaxPair(self, outName='feasvar', findmin=0, inpName='inpvar', tolerance=1e-006, maxLoops=400, failValue=None) source code
 
setResultVariableLimits(self, name='resultvar', loLimit=-1e+300, hiLimit=1e+300) source code
 
addResultVariable(self, name='resultvar', units='', desc='', loLimit=-1e+300, hiLimit=1e+300) source code
 
addResultVars(self, *rvLists) source code
 
hasResultVar(self, rvStr) source code
 
setResultVar(self, rvStr, val) source code
 
getResultVar(self, rvStr) source code
 
getAxisLabel(self, key, var) source code
 
getResultVarAxisLabel(self, rvStr) source code
 
getResultVarSummary(self) source code
 
saveResultVarSummary(self) source code
 
violatesResultConstraint(self) source code
 
firstEvaluateIfReqd(self) source code
 
evaluate(self) source code
 
reCalc(self) source code
 
addAssumption(self, label='generic param') source code
 
addInput(self, label='generic param', value=0.0, units='xxx', format='%g') source code
 
addOutput(self, label='generic param', value=0.0, units='xxx', format='%g') source code
 
getAssumptions(self) source code
 
getSummary(self) source code
 
saveSummary(self) source code
 
getShortSummary(self) source code
 
getShortHTMLSummary(self) source code
 
saveShortSummary(self) source code
 
getFullSummary(self) source code
 
getFullHTMLSummary(self) source code
 
saveFullSummary(self) source code
 
saveComment(self, comment='') source code
 
putImageInPPT(self, filename, title) source code
 
putImageInWord(self, filename) source code
 
render(self, view='front', ortho=0, width=480, height=360, makeHTML=1, clockX=None, clockY=None, clockZ=None, background='Black', viewMargin=1.06, lookAtOffset=None) source code
 
pickleParametricSoln(self) source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  __firstParametricSoln = None
use to keep track of 1st instance of ParametricSoln
  __numPOVRenders = 0
count number of render commands
Instance Variables [hide private]
  desVarDict
dictionary of design Variables in system
  resultVarDict
dict of result variables in system
  feasibleVarList
list of Feasible Pairs
  minmaxVarList
list of MinMax Pairs
  constraintList
Optimize.optimize might initialize
  controlRoutine
will be called to set component design params
  optimizeHistoryL
holds any optimization summary info as [title, summStr]
  renderControlRoutine
will be called to make POV drawing, returns List
  NumEvaluations
count number of times the evaluate method is called
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, subtaskName='simple model', taskName='System Study', controlRoutine=None, author='', constraintTolerance=0.001, renderControlRoutine=None, probDesc=None)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)