2. Programmers reference

• 2.1. Domains
  • 2.1.1. Create a rectangular domain
    • RectangularDomain
      • RectangularDomain.cell_ids
      • RectangularDomain.facet_ids
  • 2.1.2. Load domain from a mesh file
    • FileDomain
      • FileDomain.cell_ids
      • FileDomain.facet_ids
      • FileDomain.mesh
• 2.2. Problems
  • 2.2.1. Steady shallow water
    • SteadySWProblem
      • SteadySWProblem.default_parameters()
    • SteadySWProblemParameters
  • 2.2.2. Multi steady shallow water
    • MultiSteadySWProblem
      • MultiSteadySWProblem.default_parameters()
    • MultiSteadySWProblemParameters
  • 2.2.3. Time-dependent shallow water
    • SWProblem
      • SWProblem.default_parameters()
    • SWProblemParameters
  • 2.2.4. Common options
    • 2.2.4.1. Boundary conditions
      • BoundaryConditionSet
    • 2.2.4.2. Tidal forcing and bathymetry
      • BathymetryDepthExpression
      • TidalForcing
  • 2.2.5. Advanced options
    • 2.2.5.1. Finite element pairs
      • bdfmp1dg()
      • bdmp0()
      • bdmp1dg()
      • mini()
      • p0p1()
      • p1dgp2()
      • p2p1()
      • rt0()
• 2.3. Solvers
  • 2.3.1. Coupled shallow water solver
    • CoupledSWSolver
      • CoupledSWSolver.default_parameters()
      • CoupledSWSolver.solve()
    • CoupledSWSolverParameters
  • 2.3.2. Pressure-correction shallow water solver
    • IPCSSWSolver
      • IPCSSWSolver.default_parameters()
      • IPCSSWSolver.solve()
    • IPCSSWSolverParameters
• 2.4. Turbines
  • 2.4.1. Turbines
    • 2.4.1.1. Bump turbine
      • BumpTurbine
    • 2.4.1.2. Thrust turbine
      • ThrustTurbine
      • ImplicitThrustTurbine
    • 2.4.1.3. The base turbine
      • BaseTurbine
    • 2.4.1.4. Controls
      • Controls
• 2.5. Turbine farms
  • Farm
  • RectangularFarm
    • RectangularFarm.add_lhs_turbine_layout()
    • RectangularFarm.add_regular_turbine_layout()
    • RectangularFarm.add_staggered_turbine_layout()
    • RectangularFarm.site_boundary_constraints()
    • RectangularFarm.site_x_end
    • RectangularFarm.site_x_start
    • RectangularFarm.site_y_end
    • RectangularFarm.site_y_start
  • 2.5.1. Create a rectangular farm
    • RectangularFarm
      • RectangularFarm.add_lhs_turbine_layout()
      • RectangularFarm.add_regular_turbine_layout()
      • RectangularFarm.add_staggered_turbine_layout()
      • RectangularFarm.site_boundary_constraints()
      • RectangularFarm.site_x_end
      • RectangularFarm.site_x_start
      • RectangularFarm.site_y_end
      • RectangularFarm.site_y_start
  • 2.5.2. Create a base farm
    • BaseFarm
      • BaseFarm.add_turbine()
      • BaseFarm.control_array
      • BaseFarm.control_array_global
      • BaseFarm.minimum_distance_constraints()
      • BaseFarm.number_of_turbines
      • BaseFarm.set_turbine_positions()
      • BaseFarm.site_boundary_constraints()
      • BaseFarm.turbine_frictions
      • BaseFarm.turbine_positions
• 2.6. Functionals
  • 2.6.1. Power Functionals
    • PowerFunctional
      • PowerFunctional.Jt()
      • PowerFunctional.Jt_individual()
      • PowerFunctional.force()
      • PowerFunctional.force_individual()
      • PowerFunctional.power()
  • 2.6.2. Cost Functionals
    • CostFunctional
      • CostFunctional.Jt()
      • CostFunctional.Jt_individual()
  • 2.6.3. Prototype Functional
• 2.7. Reduced functional
  • ReducedFunctional
    • ReducedFunctional.default_parameters()
    • ReducedFunctional.derivative()
    • ReducedFunctional.derivative_with_check()
    • ReducedFunctional.evaluate()
  • ReducedFunctionalParameters
  • TurbineFarmControl
• 2.8. Optimization
  • 2.8.1. Site constraints
  • 2.8.2. Minimum distance constraints
    • ConvexPolygonSiteConstraint
      • ConvexPolygonSiteConstraint.function()
      • ConvexPolygonSiteConstraint.jacobian()
      • ConvexPolygonSiteConstraint.length()
      • ConvexPolygonSiteConstraint.output_workspace()
    • DomainRestrictionConstraints
      • DomainRestrictionConstraints.function()
      • DomainRestrictionConstraints.jacobian()
      • DomainRestrictionConstraints.length()
    • MinimumDistanceConstraints
      • MinimumDistanceConstraints.function()
      • MinimumDistanceConstraints.jacobian()
      • MinimumDistanceConstraints.length()
    • MinimumDistanceConstraintsLargeArrays
      • MinimumDistanceConstraintsLargeArrays.function()
      • MinimumDistanceConstraintsLargeArrays.jacobian()
      • MinimumDistanceConstraintsLargeArrays.length()
    • friction_constraints()
    • get_distance_function()
    • get_domain_constraints()
    • position_constraints()
• 2.9. Internal classes
  • MemoizeMutable
  • TimeIntegrator
    • TimeIntegrator.add()
    • TimeIntegrator.dolfin_adjoint_functional()
    • TimeIntegrator.integrate()
  • FrozenClass
  • OutputWriter
    • OutputWriter.individual_turbine_power()
  • StateWriter
    • StateWriter.output_files()
    • StateWriter.p_output_projector()
    • StateWriter.u_output_projector()
    • StateWriter.write()
  • cpu0only()
  • function_eval()
  • get_rank()
  • norm_approx()
  • smooth_uflmin()
  • test_gradient_array()
  • LES
    • LES.solve()
• 2.10. Useful scripts
  • 2.10.1. FVCOM to OpenTidalFarm converter