cashocs.OptimalControlProblem
=============================

.. currentmodule:: cashocs

.. autoclass:: OptimalControlProblem

   
   

   
   
   
   
   
   
   
   

   
   .. rubric:: Methods Summary

   .. autosummary::
   
      ~OptimalControlProblem.compute_adjoint_variables
      ~OptimalControlProblem.compute_gradient
      ~OptimalControlProblem.compute_state_variables
      ~OptimalControlProblem.gradient_test
      ~OptimalControlProblem.initialize_solve_parameters
      ~OptimalControlProblem.inject_post_callback
      ~OptimalControlProblem.inject_pre_callback
      ~OptimalControlProblem.inject_pre_post_callback
      ~OptimalControlProblem.shift_cost_functional
      ~OptimalControlProblem.solve
      ~OptimalControlProblem.supply_adjoint_forms
      ~OptimalControlProblem.supply_custom_forms
      ~OptimalControlProblem.supply_derivatives
   
   

   
   
   .. rubric:: Attributes Summary

   .. autosummary::
   
      ~OptimalControlProblem.uses_custom_scalar_product
      ~OptimalControlProblem.gradient
      ~OptimalControlProblem.reduced_cost_functional
      ~OptimalControlProblem.gradient_problem
      ~OptimalControlProblem.output_manager
      ~OptimalControlProblem.form_handler
      ~OptimalControlProblem.optimization_variable_abstractions
      ~OptimalControlProblem.adjoint_problem
      ~OptimalControlProblem.state_problem
      ~OptimalControlProblem.line_search
      ~OptimalControlProblem.hessian_problem
      ~OptimalControlProblem.solver
      ~OptimalControlProblem.config
      ~OptimalControlProblem.initial_guess
      ~OptimalControlProblem.cost_functional_list
      ~OptimalControlProblem.is_feasible
   
   

   
   
   .. rubric:: Methods Documentation
   
   .. automethod:: compute_adjoint_variables
   
   .. automethod:: compute_gradient
   
   .. automethod:: compute_state_variables
   
   .. automethod:: gradient_test
   
   .. automethod:: initialize_solve_parameters
   
   .. automethod:: inject_post_callback
   
   .. automethod:: inject_pre_callback
   
   .. automethod:: inject_pre_post_callback
   
   .. automethod:: shift_cost_functional
   
   .. automethod:: solve
   
   .. automethod:: supply_adjoint_forms
   
   .. automethod:: supply_custom_forms
   
   .. automethod:: supply_derivatives
   
   
   

   
   
   .. rubric:: Attributes Documentation
   
   .. autoattribute:: uses_custom_scalar_product
   
   .. autoattribute:: gradient
   
   .. autoattribute:: reduced_cost_functional
   
   .. autoattribute:: gradient_problem
   
   .. autoattribute:: output_manager
   
   .. autoattribute:: form_handler
   
   .. autoattribute:: optimization_variable_abstractions
   
   .. autoattribute:: adjoint_problem
   
   .. autoattribute:: state_problem
   
   .. autoattribute:: line_search
   
   .. autoattribute:: hessian_problem
   
   .. autoattribute:: solver
   
   .. autoattribute:: config
   
   .. autoattribute:: initial_guess
   
   .. autoattribute:: cost_functional_list
   
   .. autoattribute:: is_feasible