-
Notifications
You must be signed in to change notification settings - Fork 109
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #63 from Kenneth-T-Moore/user_termination
User termination
- Loading branch information
Showing
5 changed files
with
150 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| """ | ||
| Tests that pyoptsparse allows a objective or gradient function to return a "2" as its fail status. | ||
| This status is passed to pySNOPT, which returns a -2 fail status, indicating that termination has | ||
| been requested by the user. | ||
| """ | ||
| from __future__ import print_function | ||
| import unittest | ||
|
|
||
| import numpy as np | ||
|
|
||
| from pyoptsparse import Optimization, SNOPT | ||
|
|
||
|
|
||
| class TerminateComp(object): | ||
|
|
||
| def __init__(self, max_obj=1000, max_sens=1000): | ||
| self.max_obj = max_obj | ||
| self.max_sens = max_sens | ||
| self.obj_count = 0 | ||
| self.sens_count = 0 | ||
|
|
||
| def objfunc(self, xdict): | ||
| """ Evaluates the equation f(x,y) = (x-3)^2 + xy + (y+4)^2 - 3 """ | ||
| x = xdict['x'] | ||
| y = xdict['y'] | ||
| funcs = {} | ||
|
|
||
| funcs['obj'] = (x-3.0)**2 + x*y + (y+4.0)**2 - 3.0 | ||
| conval = -x + y | ||
| funcs['con'] = conval | ||
|
|
||
| if self.obj_count > self.max_obj: | ||
| fail = 2 | ||
| else: | ||
| self.obj_count += 1 | ||
| fail = False | ||
|
|
||
| return funcs, fail | ||
|
|
||
| def sens(self, xdict, funcs): | ||
| """f(x,y) = (x-3)^2 + xy + (y+4)^2 - 3 | ||
| """ | ||
| x = xdict['x'] | ||
| y = xdict['y'] | ||
| funcsSens = {} | ||
|
|
||
| funcsSens['obj', 'x'] = 2.0*x - 6.0 + y | ||
| funcsSens['obj', 'y'] = 2.0*y + 8.0 + x | ||
|
|
||
| if self.sens_count > self.max_sens: | ||
| fail = 2 | ||
| else: | ||
| self.sens_count += 1 | ||
| fail = False | ||
|
|
||
| return funcsSens, fail | ||
|
|
||
|
|
||
| con_jac = {} | ||
| con_jac['x'] = np.array(-1.0) | ||
| con_jac['y'] = np.array(1.0) | ||
|
|
||
| class TestUserTerminationStatus(unittest.TestCase): | ||
|
|
||
| def test_obj(self): | ||
| termcomp = TerminateComp(max_obj=2) | ||
| optProb = Optimization('Paraboloid', termcomp.objfunc) | ||
|
|
||
| optProb.addVarGroup('x', 1, type='c', lower=-50.0, upper=50.0, value=0.0) | ||
| optProb.addVarGroup('y', 1, type='c', lower=-50.0, upper=50.0, value=0.0) | ||
| optProb.finalizeDesignVariables() | ||
|
|
||
| optProb.addObj('obj') | ||
|
|
||
| optProb.addConGroup('con', 1, lower=-15.0, upper=-15.0, wrt=['x', 'y'], linear=True, jac=con_jac) | ||
|
|
||
| try: | ||
| opt = SNOPT() | ||
| except: | ||
| raise unittest.SkipTest('Optimizer not available: SNOPT') | ||
|
|
||
| sol = opt(optProb, sens=termcomp.sens) | ||
|
|
||
| self.assertEqual(termcomp.obj_count, 3) | ||
|
|
||
| # Exit code for user requested termination. | ||
| self.assertEqual(sol.optInform['value'][0], 71) | ||
|
|
||
| def test_sens(self): | ||
| termcomp = TerminateComp(max_sens=3) | ||
| optProb = Optimization('Paraboloid', termcomp.objfunc) | ||
|
|
||
| optProb.addVarGroup('x', 1, type='c', lower=-50.0, upper=50.0, value=0.0) | ||
| optProb.addVarGroup('y', 1, type='c', lower=-50.0, upper=50.0, value=0.0) | ||
| optProb.finalizeDesignVariables() | ||
|
|
||
| optProb.addObj('obj') | ||
|
|
||
| optProb.addConGroup('con', 1, lower=-15.0, upper=-15.0, wrt=['x', 'y'], linear=True, jac=con_jac) | ||
|
|
||
| try: | ||
| opt = SNOPT() | ||
| except: | ||
| raise unittest.SkipTest('Optimizer not available: SNOPT') | ||
|
|
||
| sol = opt(optProb, sens=termcomp.sens) | ||
|
|
||
| self.assertEqual(termcomp.sens_count, 4) | ||
|
|
||
| # Exit code for user requested termination. | ||
| self.assertEqual(sol.optInform['value'][0], 71) | ||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |