tutorial.py

Go to the documentation of this file.

 
import sys
import os
 
import conoptpy
import adolc
 
sys.path.append('../../common/')
import std
 
class TutModelData(conoptpy.ModelData):
   def __init__(self):
      self.Al   = 0.16
      self.Ak   = 2.0
      self.Ainp = 0.16
      self.Rho  = 1.0
      self.K    = 4.0
      super().__init__()
 
   def buildModel(self):
      """
      adding the variables and constraints to the model
      @ingroup PYTHON1THREAD_AD_TUTORIAL
      """
      # adding the variables to the model
      self.addVariable(0.1, conoptpy.CONOPT_INF, 0.5)
      self.addVariable(0.1, conoptpy.CONOPT_INF, 0.5)
      self.addVariable(0.0, conoptpy.CONOPT_INF)
      self.addVariable(0.0, conoptpy.CONOPT_INF)
 
      # adding the constraints to the model
      self.addConstraint(conoptpy.ConstraintType_Free, -0.1, [0, 1, 2, 3],
                    [-1, -1, 0, 0], [0, 0, 1, 1])
      self.addConstraint(conoptpy.ConstraintType_Eq, 0.0, [0, 1, 2], [0, 0, -1],
                    [1, 1, 0])
      self.addConstraint(conoptpy.ConstraintType_Eq, 4.0, [2, 3], [1, 2],
                    [0, 0])
 
      # setting the objective constraint
      self.setObjectiveElement(conoptpy.ObjectiveElement_Constraint, 0)
 
      # setting the optimisation direction
      self.setOptimizationSense(conoptpy.Sense_Maximize)
 
      # initialising the automatic differentiation
      self.initialiseAutoDiff()
 
 
   def tapeFunction(self, x, rowno):
      """
      @ingroup PYTHON1THREAD_AD_TUTORIAL
      evaluates the nonlinear function and records a tape is necessary
 
      @param x       current point to be evaluated
      @param rowno   the index of the constraint. This is also used for the trace tag.
      """
      if rowno == 2:
         return
 
      adolc.trace_on(rowno)
      ax = adolc.as_adouble(x)
 
      # marking the x variables as independent
      for item in iter(ax):
         item.declareIndependent()
 
      L   = ax[0]
      Inp = ax[1]
      Out = ax[2]
      P   = ax[3]
 
      if rowno == 0:
         ay = P * Out
      elif rowno == 1:
         hold1 = (self.Al*pow(L,(-self.Rho)) + self.Ak*pow(self.K,(-self.Rho)) + self.Ainp*pow(Inp,(-self.Rho)))
         hold2 = pow(hold1,( -1./self.Rho ))
 
         ay = hold2
 
      ay.declareDependent()
      adolc.trace_off()
 
 
   def initialiseAutoDiff(self):
      """
      @ingroup PYTHON1THREAD_AD_TUTORIAL
      initialises the automatic differentiation
      """
      x = []
      for v in range(self.numVar()):
         x.append(self.getVariable(v).curr)
 
      for c in range(self.numCons()):
         self.tapeFunction(x, c)
 
 
   def evaluateNonlinearTerm(self, x, rowno, ignerr, thread):
      """
      @ingroup PYTHON1THREAD_AD_TUTORIAL
      """
      try:
         g = adolc.function(rowno, x)[0]
      except adolc.BranchException:
         self.tapeFunction(x, rowno)
         g = adolc.function(rowno, x)[0]
 
      return g
 
 
   def evaluateNonlinearJacobian(self, x, rowno, jacnum, ignerr, thread):
      """
      @ingroup PYTHON1THREAD_AD_TUTORIAL
      """
      jac = []
      try:
         jacres = adolc.gradient(rowno, x)
      except adolc.BranchException:
         self.tapeFunction(x, rowno)
         jacres = adolc.gradient(rowno, x)
 
      for i in jacnum:
         jac.append(jacres[i])
 
      return jac
 
 
if __name__ == "__main__":
   name = os.path.basename(__file__)[:-3]
 
   conopt = conoptpy.Conopt(name)
   model = TutModelData()
   msghdlr = std.TutMessageHandler(name)
 
   model.buildModel()
 
   conopt.loadModel(model)
   conopt.setMessageHandler(msghdlr)
 
   # getting the license variables
   license_int_1 = os.environ.get('CONOPT_LICENSE_INT_1', None)
   license_int_2 = os.environ.get('CONOPT_LICENSE_INT_2', None)
   license_int_3 = os.environ.get('CONOPT_LICENSE_INT_3', None)
   license_text = os.environ.get('CONOPT_LICENSE_TEXT', None)
   if license_int_1 is not None and license_int_2 is not None \
         and license_int_3 is not None and license_text is not None:
      conopt.setLicense(int(license_int_1), int(license_int_2),
                        int(license_int_3), license_text)
 
   coi_error = conopt.solve()
 
   retcode = std.checkSolve(conopt, 0.572943, coi_error)
 
   sys.exit(retcode)