cashocs.ShapeOptimizationProblem
================================

.. currentmodule:: cashocs

.. autoclass:: ShapeOptimizationProblem

   
   

   
   
   
   
   
   
   
   

   
   .. rubric:: Methods Summary

   .. autosummary::
   
      ~ShapeOptimizationProblem.compute_adjoint_variables
      ~ShapeOptimizationProblem.compute_shape_gradient
      ~ShapeOptimizationProblem.compute_state_variables
      ~ShapeOptimizationProblem.get_vector_field
      ~ShapeOptimizationProblem.gradient_test
      ~ShapeOptimizationProblem.initialize_solve_parameters
      ~ShapeOptimizationProblem.inject_post_callback
      ~ShapeOptimizationProblem.inject_pre_callback
      ~ShapeOptimizationProblem.inject_pre_post_callback
      ~ShapeOptimizationProblem.shift_cost_functional
      ~ShapeOptimizationProblem.solve
      ~ShapeOptimizationProblem.supply_adjoint_forms
      ~ShapeOptimizationProblem.supply_custom_forms
      ~ShapeOptimizationProblem.supply_shape_derivative
   
   

   
   
   .. rubric:: Attributes Summary

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

   
   
   .. rubric:: Methods Documentation
   
   .. automethod:: compute_adjoint_variables
   
   .. automethod:: compute_shape_gradient
   
   .. automethod:: compute_state_variables
   
   .. automethod:: get_vector_field
   
   .. 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_shape_derivative
   
   
   

   
   
   .. 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