OpenTidalFarm
1. Installation
1.1. Quick install
1.2. Dependencies
2. Features
3. Examples
1. Sinusoidal wave in a channel
2. Tidal simulation in the Orkney island
3. Farm layout optimization
4. Sensitivity Analysis
4. Programmers reference
4.1. Domains
4.2. Problems
4.3. Solvers
4.4. Functionals
4.5. Turbine farms
4.6. Reduced functional
4.7. Optimization
4.8. Internal classes
5. Contributing to OpenTidalFarm
5.1. Style Guide
5.2. Language Rules
5.3. Logging using dolfin.log
5.4. Adding documented examples
6. Developers
7. Citing
7.1. Posters and presentations
OpenTidalFarm
Docs
»
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
A
add() (opentidalfarm.functionals.time_integrator.TimeIntegrator method)
add_bc() (opentidalfarm.boundary_conditions.BoundaryConditionSet method)
add_regular_turbine_layout() (opentidalfarm.farm.rectangular_farm.RectangularFarm method)
(opentidalfarm.farm.RectangularFarm method)
add_staggered_turbine_layout() (opentidalfarm.farm.rectangular_farm.RectangularFarm method)
(opentidalfarm.farm.RectangularFarm method)
add_turbine() (opentidalfarm.farm.base_farm.BaseFarm method)
B
BaseFarm (class in opentidalfarm.farm.base_farm)
BathymetryDepthExpression (class in opentidalfarm.tidal)
bdfmp1dg() (in module opentidalfarm.finite_elements)
bdmp0() (in module opentidalfarm.finite_elements)
bdmp1dg() (in module opentidalfarm.finite_elements)
BoundaryConditionSet (class in opentidalfarm.boundary_conditions)
C
cell_ids (opentidalfarm.domains.file_domain.FileDomain attribute)
(opentidalfarm.domains.rectangle_domain.RectangularDomain attribute)
ContinuumFarm (class in opentidalfarm.farm)
control_array (opentidalfarm.farm.base_farm.BaseFarm attribute)
ConvexPolygonSiteConstraint (class in opentidalfarm.optimisation_helpers)
CoupledSWSolver (class in opentidalfarm.solvers.coupled_sw_solver)
CoupledSWSolverParameters (class in opentidalfarm.solvers.coupled_sw_solver)
cpu0only() (in module opentidalfarm.helpers)
D
default_parameters() (opentidalfarm.problems.multi_steady_sw.MultiSteadySWProblem static method)
(opentidalfarm.problems.steady_sw.SteadySWProblem static method)
(opentidalfarm.problems.sw.SWProblem static method)
(opentidalfarm.reduced_functional.ReducedFunctional static method)
(opentidalfarm.solvers.coupled_sw_solver.CoupledSWSolver static method)
derivative() (opentidalfarm.reduced_functional.ReducedFunctional method)
dolfin_adjoint_functional() (opentidalfarm.functionals.time_integrator.TimeIntegrator method)
DomainRestrictionConstraints (class in opentidalfarm.optimisation_helpers)
E
eval() (opentidalfarm.tidal.BathymetryDepthExpression method)
(opentidalfarm.tidal.TidalForcing method)
evaluate() (opentidalfarm.reduced_functional.ReducedFunctional method)
F
facet_ids (opentidalfarm.domains.file_domain.FileDomain attribute)
(opentidalfarm.domains.rectangle_domain.RectangularDomain attribute)
Farm (class in opentidalfarm.farm)
(module)
FileDomain (class in opentidalfarm.domains.file_domain)
filter() (opentidalfarm.boundary_conditions.BoundaryConditionSet method)
force() (opentidalfarm.functionals.power_functionals.PowerFunctional method)
force_individual() (opentidalfarm.functionals.power_functionals.PowerFunctional method)
friction_constraints() (in module opentidalfarm.optimisation_helpers)
friction_function (opentidalfarm.farm.base_farm.BaseFarm attribute)
(opentidalfarm.farm.ContinuumFarm attribute)
FrozenClass (class in opentidalfarm.helpers)
function() (opentidalfarm.optimisation_helpers.ConvexPolygonSiteConstraint method)
(opentidalfarm.optimisation_helpers.DomainRestrictionConstraints method)
function_eval() (in module opentidalfarm.helpers)
G
get_distance_function() (in module opentidalfarm.optimisation_helpers)
get_domain_constraints() (in module opentidalfarm.optimisation_helpers)
get_rank() (in module opentidalfarm.helpers)
I
individual_turbine_power() (opentidalfarm.helpers.OutputWriter method)
integrate() (opentidalfarm.functionals.time_integrator.TimeIntegrator method)
IPCSSWSolver (class in opentidalfarm.solvers.ipcs_sw_solver)
IPCSSWSolverParameters (class in opentidalfarm.solvers.ipcs_sw_solver)
J
jacobian() (opentidalfarm.optimisation_helpers.ConvexPolygonSiteConstraint method)
(opentidalfarm.optimisation_helpers.DomainRestrictionConstraints method)
Jt() (opentidalfarm.functionals.power_functionals.PowerFunctional method)
Jt_individual() (opentidalfarm.functionals.power_functionals.PowerFunctional method)
L
length() (opentidalfarm.optimisation_helpers.ConvexPolygonSiteConstraint method)
(opentidalfarm.optimisation_helpers.DomainRestrictionConstraints method)
LES (class in opentidalfarm.solvers.les)
M
MemoizeMutable (class in opentidalfarm.memoize)
mesh (opentidalfarm.domains.file_domain.FileDomain attribute)
(opentidalfarm.domains.rectangle_domain.RectangularDomain attribute)
mini() (in module opentidalfarm.finite_elements)
minimum_distance_constraints() (opentidalfarm.farm.base_farm.BaseFarm method)
MultiSteadySWProblem (class in opentidalfarm.problems.multi_steady_sw)
MultiSteadySWProblemParameters (class in opentidalfarm.problems.multi_steady_sw)
N
norm_approx() (in module opentidalfarm.helpers)
number_of_turbines (opentidalfarm.farm.base_farm.BaseFarm attribute)
O
opentidalfarm (module)
opentidalfarm.boundary_conditions (module)
opentidalfarm.domains (module)
opentidalfarm.domains.file_domain (module)
opentidalfarm.domains.rectangle_domain (module)
opentidalfarm.farm (module)
opentidalfarm.farm.base_farm (module)
opentidalfarm.farm.rectangular_farm (module)
opentidalfarm.finite_elements (module)
opentidalfarm.functionals (module)
opentidalfarm.functionals.power_functionals (module)
opentidalfarm.functionals.time_integrator (module)
opentidalfarm.helpers (module)
opentidalfarm.memoize (module)
opentidalfarm.optimisation_helpers (module)
opentidalfarm.problems (module)
opentidalfarm.problems.multi_steady_sw (module)
opentidalfarm.problems.steady_sw (module)
opentidalfarm.problems.sw (module)
opentidalfarm.reduced_functional (module)
opentidalfarm.solvers (module)
opentidalfarm.solvers.coupled_sw_solver (module)
opentidalfarm.solvers.ipcs_sw_solver (module)
opentidalfarm.solvers.les (module)
opentidalfarm.tidal (module)
output_files() (opentidalfarm.helpers.StateWriter method)
output_workspace() (opentidalfarm.optimisation_helpers.ConvexPolygonSiteConstraint method)
OutputWriter (class in opentidalfarm.helpers)
P
p0p1() (in module opentidalfarm.finite_elements)
p1dgp2() (in module opentidalfarm.finite_elements)
p2p1() (in module opentidalfarm.finite_elements)
p_output_projector() (opentidalfarm.helpers.StateWriter method)
position_constraints() (in module opentidalfarm.optimisation_helpers)
power() (opentidalfarm.functionals.power_functionals.PowerFunctional method)
PowerCurveFunctional (class in opentidalfarm.functionals.power_functionals)
PowerFunctional (class in opentidalfarm.functionals.power_functionals)
R
RectangularDomain (class in opentidalfarm.domains.rectangle_domain)
RectangularFarm (class in opentidalfarm.farm)
(class in opentidalfarm.farm.rectangular_farm)
ReducedFunctional (class in opentidalfarm.reduced_functional)
ReducedFunctionalParameters (class in opentidalfarm.reduced_functional)
rt0() (in module opentidalfarm.finite_elements)
S
set_turbine_positions() (opentidalfarm.farm.base_farm.BaseFarm method)
site_boundary_constraints() (opentidalfarm.farm.base_farm.BaseFarm method)
(opentidalfarm.farm.RectangularFarm method)
(opentidalfarm.farm.rectangular_farm.RectangularFarm method)
site_x_end (opentidalfarm.farm.rectangular_farm.RectangularFarm attribute)
(opentidalfarm.farm.RectangularFarm attribute)
site_x_start (opentidalfarm.farm.rectangular_farm.RectangularFarm attribute)
(opentidalfarm.farm.RectangularFarm attribute)
site_y_end (opentidalfarm.farm.rectangular_farm.RectangularFarm attribute)
(opentidalfarm.farm.RectangularFarm attribute)
site_y_start (opentidalfarm.farm.rectangular_farm.RectangularFarm attribute)
(opentidalfarm.farm.RectangularFarm attribute)
smooth_uflmin() (in module opentidalfarm.helpers)
solve() (opentidalfarm.solvers.coupled_sw_solver.CoupledSWSolver method)
(opentidalfarm.solvers.ipcs_sw_solver.IPCSSWSolver method)
(opentidalfarm.solvers.les.LES method)
StateWriter (class in opentidalfarm.helpers)
SteadySWProblem (class in opentidalfarm.problems.steady_sw)
SteadySWProblemParameters (class in opentidalfarm.problems.steady_sw)
SWProblem (class in opentidalfarm.problems.sw)
SWProblemParameters (class in opentidalfarm.problems.sw)
T
test_gradient_array() (in module opentidalfarm.helpers)
TidalForcing (class in opentidalfarm.tidal)
TimeIntegrator (class in opentidalfarm.functionals.time_integrator)
turbine_frictions (opentidalfarm.farm.base_farm.BaseFarm attribute)
turbine_positions (opentidalfarm.farm.base_farm.BaseFarm attribute)
turbine_specification (opentidalfarm.farm.base_farm.BaseFarm attribute)
TurbineFarmControl (class in opentidalfarm.reduced_functional)
U
u_output_projector() (opentidalfarm.helpers.StateWriter method)
update() (opentidalfarm.farm.base_farm.BaseFarm method)
(opentidalfarm.farm.ContinuumFarm method)
update_time() (opentidalfarm.boundary_conditions.BoundaryConditionSet method)
W
write() (opentidalfarm.helpers.StateWriter method)
Read the Docs
v: opentidalfarm-1.5
Versions
latest
opentidalfarm-1.5
opentidalfarm-1.4
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.