soupy package

Submodules

• soupy.modeling
  • soupy.modeling.PDEControlProblem
    • PDEVariationalControlProblem
      • PDEVariationalControlProblem.apply_ij()
      • PDEVariationalControlProblem.apply_ijk()
      • PDEVariationalControlProblem.evalGradientControl()
      • PDEVariationalControlProblem.evalGradientParameter()
      • PDEVariationalControlProblem.generate_control()
      • PDEVariationalControlProblem.generate_parameter()
      • PDEVariationalControlProblem.generate_state()
      • PDEVariationalControlProblem.init_control()
      • PDEVariationalControlProblem.init_parameter()
      • PDEVariationalControlProblem.setLinearizationPoint()
      • PDEVariationalControlProblem.set_nonlinear_solver_parameters()
      • PDEVariationalControlProblem.solveAdj()
      • PDEVariationalControlProblem.solveFwd()
      • PDEVariationalControlProblem.solveIncremental()
  • soupy.modeling.controlModel
    • ControlModel
      • ControlModel.applyC()
      • ControlModel.applyCt()
      • ControlModel.applyCz()
      • ControlModel.applyCzt()
      • ControlModel.applyWmm()
      • ControlModel.applyWmu()
      • ControlModel.applyWum()
      • ControlModel.applyWuu()
      • ControlModel.applyWuz()
      • ControlModel.applyWzu()
      • ControlModel.applyWzz()
      • ControlModel.apply_ij()
      • ControlModel.cost()
      • ControlModel.evalGradientControl()
      • ControlModel.evalGradientParameter()
      • ControlModel.generate_vector()
      • ControlModel.init_control()
      • ControlModel.init_parameter()
      • ControlModel.setLinearizationPoint()
      • ControlModel.solveAdj()
      • ControlModel.solveAdjIncremental()
      • ControlModel.solveFwd()
      • ControlModel.solveFwdIncremental()
  • soupy.modeling.controlQoI
    • ControlQoI
      • ControlQoI.apply_ij()
      • ControlQoI.cost()
      • ControlQoI.grad()
      • ControlQoI.setLinearizationPoint()
    • L2MisfitControlQoI
      • L2MisfitControlQoI.adj_rhs()
      • L2MisfitControlQoI.apply_ij()
      • L2MisfitControlQoI.apply_ijk()
      • L2MisfitControlQoI.cost()
      • L2MisfitControlQoI.grad()
      • L2MisfitControlQoI.setLinearizationPoint()
    • L2MisfitVarfHandler
    • VariationalControlQoI
      • VariationalControlQoI.adj_rhs()
      • VariationalControlQoI.apply_ij()
      • VariationalControlQoI.apply_ijk()
      • VariationalControlQoI.cost()
      • VariationalControlQoI.grad()
      • VariationalControlQoI.setLinearizationPoint()
  • soupy.modeling.controlModelHessian
    • ControlModelHessian
      • ControlModelHessian.init_vector()
      • ControlModelHessian.mult()
  • soupy.modeling.controlCostFunctional
    • ControlCostFunctional
      • ControlCostFunctional.cost()
      • ControlCostFunctional.generate_vector()
      • ControlCostFunctional.grad()
      • ControlCostFunctional.hessian()
    • DeterministicControlCostFunctional
      • DeterministicControlCostFunctional.computeComponents()
      • DeterministicControlCostFunctional.cost()
      • DeterministicControlCostFunctional.generate_vector()
      • DeterministicControlCostFunctional.grad()
      • DeterministicControlCostFunctional.hessian()
      • DeterministicControlCostFunctional.objective()
    • PenalizationControlCostFunctional
      • PenalizationControlCostFunctional.cost()
      • PenalizationControlCostFunctional.generate_vector()
      • PenalizationControlCostFunctional.grad()
      • PenalizationControlCostFunctional.hessian()
    • RiskMeasureControlCostFunctional
      • RiskMeasureControlCostFunctional.cost()
      • RiskMeasureControlCostFunctional.generate_vector()
      • RiskMeasureControlCostFunctional.grad()
      • RiskMeasureControlCostFunctional.hessian()
  • soupy.modeling.controlCostHessian
    • ControlCostHessian
      • ControlCostHessian.inner()
      • ControlCostHessian.mult()
      • ControlCostHessian.ncalls
  • soupy.modeling.riskMeasure
    • RiskMeasure
      • RiskMeasure.computeComponents()
      • RiskMeasure.cost()
      • RiskMeasure.generate_vector()
      • RiskMeasure.grad()
      • RiskMeasure.hessian()
  • soupy.modeling.meanVarRiskMeasureStochastic
    • MeanVarRiskMeasureStochastic
      • MeanVarRiskMeasureStochastic.computeComponents()
      • MeanVarRiskMeasureStochastic.cost()
      • MeanVarRiskMeasureStochastic.generate_vector()
      • MeanVarRiskMeasureStochastic.grad()
      • MeanVarRiskMeasureStochastic.hessian()
    • meanVarRiskMeasureStochasticSettings()
  • soupy.modeling.meanVarRiskMeasureSAA
    • MeanVarRiskMeasureSAA
      • MeanVarRiskMeasureSAA.computeComponents()
      • MeanVarRiskMeasureSAA.cost()
      • MeanVarRiskMeasureSAA.gather_samples()
      • MeanVarRiskMeasureSAA.generate_vector()
      • MeanVarRiskMeasureSAA.grad()
      • MeanVarRiskMeasureSAA.hessian()
    • meanVarRiskMeasureSAASettings()
  • soupy.modeling.augmentedVector
    • AugmentedVector
      • AugmentedVector.add_local()
      • AugmentedVector.apply()
      • AugmentedVector.axpy()
      • AugmentedVector.copy()
      • AugmentedVector.get_local()
      • AugmentedVector.get_scalar()
      • AugmentedVector.get_vector()
      • AugmentedVector.inner()
      • AugmentedVector.set_local()
      • AugmentedVector.set_scalar()
      • AugmentedVector.set_vector()
      • AugmentedVector.zero()
  • soupy.modeling.superquantileRiskMeasureSAA
    • SuperquantileRiskMeasureSAA
      • SuperquantileRiskMeasureSAA.computeComponents()
      • SuperquantileRiskMeasureSAA.cost()
      • SuperquantileRiskMeasureSAA.gather_samples()
      • SuperquantileRiskMeasureSAA.generate_vector()
      • SuperquantileRiskMeasureSAA.grad()
      • SuperquantileRiskMeasureSAA.hessian()
      • SuperquantileRiskMeasureSAA.superquantile()
    • sample_superquantile()
    • sample_superquantile_by_minimization()
    • superquantileRiskMeasureSAASettings()
  • soupy.modeling.transformedMeanRiskMeasureSAA
    • FunctionWrapper
      • FunctionWrapper.grad()
      • FunctionWrapper.hessian()
    • IdentityFunction
      • IdentityFunction.grad()
      • IdentityFunction.hessian()
    • TransformedMeanRiskMeasureSAA
      • TransformedMeanRiskMeasureSAA.computeComponents()
      • TransformedMeanRiskMeasureSAA.cost()
      • TransformedMeanRiskMeasureSAA.gather_samples()
      • TransformedMeanRiskMeasureSAA.generate_vector()
      • TransformedMeanRiskMeasureSAA.grad()
      • TransformedMeanRiskMeasureSAA.hessian()
    • transformedMeanRiskMeasureSAASettings()
  • soupy.modeling.penalization
    • L2Penalization
      • L2Penalization.cost()
      • L2Penalization.grad()
      • L2Penalization.hessian()
      • L2Penalization.init_vector()
    • MultiPenalization
      • MultiPenalization.cost()
      • MultiPenalization.grad()
      • MultiPenalization.hessian()
      • MultiPenalization.init_vector()
    • Penalization
      • Penalization.cost()
      • Penalization.grad()
      • Penalization.hessian()
      • Penalization.init_vector()
    • VariationalPenalization
      • VariationalPenalization.cost()
      • VariationalPenalization.grad()
      • VariationalPenalization.hessian()
      • VariationalPenalization.init_vector()
    • WeightedL2Penalization
      • WeightedL2Penalization.cost()
      • WeightedL2Penalization.grad()
      • WeightedL2Penalization.hessian()
      • WeightedL2Penalization.init_vector()
  • soupy.modeling.variables
• soupy.optimization
  • soupy.optimization.bfgs
    • BFGS
      • BFGS.solve()
      • BFGS.termination_reasons
    • BFGS_ParameterList()
    • BFGS_operator
      • BFGS_operator.set_H0inv()
      • BFGS_operator.solve()
      • BFGS_operator.update()
    • BFGSoperator_ParameterList()
    • RescaledIdentity
      • RescaledIdentity.init_vector()
      • RescaledIdentity.solve()
  • soupy.optimization.inexactNewtonCG
    • InexactNewtonCG
      • InexactNewtonCG.solve()
      • InexactNewtonCG.termination_reasons
    • InexactNewtonCG_ParameterList()
    • LS_ParameterList()
    • TR_ParameterList()
  • soupy.optimization.steepestDescent
    • SteepestDescent
      • SteepestDescent.solve()
      • SteepestDescent.termination_reasons
    • SteepestDescent_ParameterList()
  • soupy.optimization.sgd
    • SGD
      • SGD.solve()
      • SGD.termination_reasons
    • SGD_ParameterList()
  • soupy.optimization.projectableConstraint
    • InnerProductEqualityConstraint
      • InnerProductEqualityConstraint.cost()
      • InnerProductEqualityConstraint.project()
    • ProjectableConstraint
      • ProjectableConstraint.cost()
      • ProjectableConstraint.project()
  • soupy.optimization.cgSolverSteihaug
    • CGSolverSteihaug
      • CGSolverSteihaug.reason
      • CGSolverSteihaug.set_TR()
      • CGSolverSteihaug.set_operator()
      • CGSolverSteihaug.set_preconditioner()
      • CGSolverSteihaug.solve()
      • CGSolverSteihaug.update_x_with_TR()
      • CGSolverSteihaug.update_x_without_TR()
    • CGSolverSteihaug_ParameterList()
    • IdentityOperator
      • IdentityOperator.mult()
      • IdentityOperator.solve()
• soupy.solver module
  • soupy.solver.nonlinearVariationalSolver
    • NonlinearVariationalSolver
      • NonlinearVariationalSolver.solve()
  • soupy.solver.newtonBacktrackSolver
    • NewtonBacktrackSolver
      • NewtonBacktrackSolver.solve()
      • NewtonBacktrackSolver.termination_reasons
    • apply_BC()
    • homogenize_BC()
  • soupy.solver.PETScLUSolver
    • PETScLUSolver
      • PETScLUSolver.set_operator()
      • PETScLUSolver.solve()
      • PETScLUSolver.solve_transpose()
• soupy.collectives
  • soupy.collectives.collective
    • MultipleSamePartitioningPDEsCollective
      • MultipleSamePartitioningPDEsCollective.allReduce()
      • MultipleSamePartitioningPDEsCollective.bcast()
      • MultipleSamePartitioningPDEsCollective.rank()
      • MultipleSamePartitioningPDEsCollective.size()
    • MultipleSerialPDEsCollective()
    • NullCollective
      • NullCollective.allReduce()
      • NullCollective.bcast()
      • NullCollective.rank()
      • NullCollective.size()
  • soupy.collectives.mpiUtils
    • allgather_vector_as_numpy()
    • allocate_process_sample_sizes()
    • get_global()
    • set_local_from_global()
• soupy.utils module
  • soupy.utils.penalizationFiniteDifference
    • penalizationFiniteDifference()
  • soupy.utils.qoiFiniteDifference
    • qoiFiniteDifference()
  • soupy.utils.stochasticCostFiniteDifference
    • SAACostFiniteDifference()
    • stochasticCostFiniteDifference()
  • soupy.utils.scipyCostWrapper module
    • ScipyCostWrapper
      • ScipyCostWrapper.cost()
      • ScipyCostWrapper.function()
      • ScipyCostWrapper.grad()
      • ScipyCostWrapper.hessian()
      • ScipyCostWrapper.hessp()
      • ScipyCostWrapper.jac()

Module contents