Overview of the modules

matrices

Depends on: none.

This module contains classes describing block matrices, block Toeplitz matrices (stored sparsely in memory) and low-rank matrices. All block matrices can nested to build hierarchical matrices.

• capytaine.matrices.block module
  • BlockMatrix
    • BlockMatrix.all()
    • BlockMatrix.all_blocks
    • BlockMatrix.any()
    • BlockMatrix.astype()
    • BlockMatrix.block_shapes
    • BlockMatrix.density
    • BlockMatrix.display_color
    • BlockMatrix.dtype
    • BlockMatrix.fft_of_list()
    • BlockMatrix.full_matrix()
    • BlockMatrix.matmat()
    • BlockMatrix.matvec()
    • BlockMatrix.max()
    • BlockMatrix.min()
    • BlockMatrix.ndim
    • BlockMatrix.no_toeplitz()
    • BlockMatrix.plot_shape()
    • BlockMatrix.rmatvec()
    • BlockMatrix.sparcity
    • BlockMatrix.stored_data_size
    • BlockMatrix.str_shape
• capytaine.matrices.block_toeplitz module
  • BlockCirculantMatrix
    • BlockCirculantMatrix.block_diagonalize()
    • BlockCirculantMatrix.matvec()
    • BlockCirculantMatrix.rmatvec()
  • BlockSymmetricToeplitzMatrix
    • BlockSymmetricToeplitzMatrix.circulant_super_matrix
  • BlockToeplitzMatrix
    • BlockToeplitzMatrix.all_blocks
    • BlockToeplitzMatrix.block_shape
    • BlockToeplitzMatrix.block_shapes
    • BlockToeplitzMatrix.circulant_super_matrix
    • BlockToeplitzMatrix.matvec()
    • BlockToeplitzMatrix.rmatvec()
  • EvenBlockSymmetricCirculantMatrix
  • OddBlockSymmetricCirculantMatrix
• capytaine.matrices.builders module
  • cut_matrix()
  • full_like()
  • identity_like()
  • ones_like()
  • random_block_matrix()
  • zeros_like()
• capytaine.matrices.linear_solvers module
  • Counter
  • LUSolverWithCache
    • LUSolverWithCache.cached_lu_decomp()
    • LUSolverWithCache.lu_decomp()
    • LUSolverWithCache.solve()
    • LUSolverWithCache.solve_with_decomp()
  • gmres_no_fft()
  • solve_directly()
  • solve_gmres()
• capytaine.matrices.low_rank module
  • LowRankMatrix
    • LowRankMatrix.astype()
    • LowRankMatrix.density
    • LowRankMatrix.from_full_matrix_with_ACA()
    • LowRankMatrix.from_full_matrix_with_SVD()
    • LowRankMatrix.from_function_with_ACA()
    • LowRankMatrix.from_rows_and_cols_functions_with_ACA()
    • LowRankMatrix.from_rows_and_cols_functions_with_multi_ACA()
    • LowRankMatrix.full_matrix()
    • LowRankMatrix.ndim
    • LowRankMatrix.recompress()
    • LowRankMatrix.sparcity
    • LowRankMatrix.stored_data_size
  • NoConvergenceOfACA

meshes

Depends on: none.

This module contains classes describing the mesh of a floating body. Several variants, including collections of meshes and symmetric meshes are also available. Most of this module comes from the meshmagick package by François Rongère.

• capytaine.meshes.clipper module
  • clip()
• capytaine.meshes.collections module
  • CollectionOfMeshes
    • CollectionOfMeshes.axis_aligned_bbox
    • CollectionOfMeshes.center_of_mass_of_nodes
    • CollectionOfMeshes.clip()
    • CollectionOfMeshes.clipped()
    • CollectionOfMeshes.compute_quadrature()
    • CollectionOfMeshes.copy()
    • CollectionOfMeshes.diameter_of_nodes
    • CollectionOfMeshes.extract_faces()
    • CollectionOfMeshes.extract_one_face()
    • CollectionOfMeshes.faces
    • CollectionOfMeshes.faces_areas
    • CollectionOfMeshes.faces_centers
    • CollectionOfMeshes.faces_normals
    • CollectionOfMeshes.faces_radiuses
    • CollectionOfMeshes.heal_mesh()
    • CollectionOfMeshes.immersed_part()
    • CollectionOfMeshes.indices_of_mesh()
    • CollectionOfMeshes.keep_immersed_part()
    • CollectionOfMeshes.merged()
    • CollectionOfMeshes.mirror()
    • CollectionOfMeshes.nb_faces
    • CollectionOfMeshes.nb_submeshes
    • CollectionOfMeshes.nb_vertices
    • CollectionOfMeshes.prune_empty_meshes()
    • CollectionOfMeshes.quadrature_method
    • CollectionOfMeshes.quadrature_points
    • CollectionOfMeshes.rotate()
    • CollectionOfMeshes.show()
    • CollectionOfMeshes.show_matplotlib()
    • CollectionOfMeshes.sliced_by_plane()
    • CollectionOfMeshes.submesh_containing_face()
    • CollectionOfMeshes.symmetrized()
    • CollectionOfMeshes.translate()
    • CollectionOfMeshes.tree_view()
    • CollectionOfMeshes.vertices
    • CollectionOfMeshes.volume
• capytaine.meshes.geometry module
  • Abstract3DObject
    • Abstract3DObject.mirror()
    • Abstract3DObject.mirrored()
    • Abstract3DObject.rotate()
    • Abstract3DObject.rotate_around_center_to_align_vectors()
    • Abstract3DObject.rotate_x()
    • Abstract3DObject.rotate_y()
    • Abstract3DObject.rotate_z()
    • Abstract3DObject.rotated()
    • Abstract3DObject.rotated_around_center_to_align_vectors()
    • Abstract3DObject.rotated_x()
    • Abstract3DObject.rotated_y()
    • Abstract3DObject.rotated_z()
    • Abstract3DObject.translate()
    • Abstract3DObject.translate_point_to_point()
    • Abstract3DObject.translate_x()
    • Abstract3DObject.translate_y()
    • Abstract3DObject.translate_z()
    • Abstract3DObject.translated()
    • Abstract3DObject.translated_point_to_point()
    • Abstract3DObject.translated_x()
    • Abstract3DObject.translated_y()
    • Abstract3DObject.translated_z()
  • Axis
    • Axis.angle_with_respect_to()
    • Axis.copy()
    • Axis.is_orthogonal_to()
    • Axis.is_parallel_to()
    • Axis.mirror()
    • Axis.rotate()
    • Axis.rotate_points()
    • Axis.rotate_vectors()
    • Axis.rotation_matrix()
    • Axis.translate()
  • Plane
    • Plane.c
    • Plane.copy()
    • Plane.distance_to_point()
    • Plane.get_edge_intersection()
    • Plane.is_orthogonal_to()
    • Plane.mirror()
    • Plane.rotate()
    • Plane.translate()
  • inplace_transformation()
  • orthogonal_vectors()
  • parallel_vectors()
  • parallel_vectors_with_same_direction()
• capytaine.meshes.meshes module
  • Mesh
    • Mesh.as_set_of_faces()
    • Mesh.axis_aligned_bbox
    • Mesh.boundaries
    • Mesh.center_of_mass_of_nodes
    • Mesh.clip()
    • Mesh.clipped()
    • Mesh.compute_quadrature()
    • Mesh.copy()
    • Mesh.diameter_of_nodes
    • Mesh.extract_faces()
    • Mesh.extract_one_face()
    • Mesh.faces
    • Mesh.faces_areas
    • Mesh.faces_centers
    • Mesh.faces_normals
    • Mesh.faces_radiuses
    • Mesh.ff
    • Mesh.flip_normals()
    • Mesh.from_set_of_faces()
    • Mesh.get_face()
    • Mesh.get_surface_integrals()
    • Mesh.heal_mesh()
    • Mesh.heal_normals()
    • Mesh.heal_triangles()
    • Mesh.immersed_part()
    • Mesh.is_triangle()
    • Mesh.join_meshes()
    • Mesh.keep_immersed_part()
    • Mesh.max_edge_length
    • Mesh.mean_edge_length
    • Mesh.merge_duplicates()
    • Mesh.merged()
    • Mesh.min_edge_length
    • Mesh.mirror()
    • Mesh.nb_boundaries
    • Mesh.nb_faces
    • Mesh.nb_quadrangles
    • Mesh.nb_triangles
    • Mesh.nb_vertices
    • Mesh.quadrangles_ids
    • Mesh.quadrature_method
    • Mesh.quadrature_points
    • Mesh.remove_degenerated_faces()
    • Mesh.remove_unused_vertices()
    • Mesh.rotate()
    • Mesh.show()
    • Mesh.show_matplotlib()
    • Mesh.show_vtk()
    • Mesh.sliced_by_plane()
    • Mesh.squared_axis_aligned_bbox
    • Mesh.symmetrized()
    • Mesh.to_meshmagick()
    • Mesh.translate()
    • Mesh.tree_view()
    • Mesh.triangles_ids
    • Mesh.triangulate_quadrangles()
    • Mesh.vertices
    • Mesh.vf
    • Mesh.volume
    • Mesh.vv
  • SingleFace
    • SingleFace.name
• capytaine.meshes.properties module
  • compute_connectivity()
  • compute_faces_properties()
  • compute_radiuses()
• capytaine.meshes.quality module
  • merge_duplicate_rows()
  • merge_duplicates()
  • print_quality()
• capytaine.meshes.surface_integrals module
  • SurfaceIntegralsMixin
    • SurfaceIntegralsMixin.center_of_buoyancy
    • SurfaceIntegralsMixin.disp_mass()
    • SurfaceIntegralsMixin.surface_integral()
    • SurfaceIntegralsMixin.volume
    • SurfaceIntegralsMixin.volumes
    • SurfaceIntegralsMixin.waterplane_area
    • SurfaceIntegralsMixin.waterplane_center
    • SurfaceIntegralsMixin.waterplane_integral()
    • SurfaceIntegralsMixin.wet_surface_area
  • compute_faces_integrals()
• capytaine.meshes.symmetric module
  • AxialSymmetricMesh
    • AxialSymmetricMesh.first_slice
    • AxialSymmetricMesh.from_profile()
    • AxialSymmetricMesh.join_meshes()
    • AxialSymmetricMesh.mirror()
    • AxialSymmetricMesh.rotate()
    • AxialSymmetricMesh.translate()
    • AxialSymmetricMesh.tree_view()
  • ReflectionSymmetricMesh
    • ReflectionSymmetricMesh.half
    • ReflectionSymmetricMesh.join_meshes()
    • ReflectionSymmetricMesh.mirror()
    • ReflectionSymmetricMesh.rotate()
    • ReflectionSymmetricMesh.translate()
    • ReflectionSymmetricMesh.tree_view()
  • SymmetricMesh
  • TranslationalSymmetricMesh
    • TranslationalSymmetricMesh.first_slice
    • TranslationalSymmetricMesh.join_meshes()
    • TranslationalSymmetricMesh.mirror()
    • TranslationalSymmetricMesh.rotate()
    • TranslationalSymmetricMesh.translate()
    • TranslationalSymmetricMesh.tree_view()
  • build_regular_array_of_meshes()

bodies

Depends on: meshes.

This module contains a class describing a floating body, that is the reunion of a mesh and some degrees of freedom. It also contains some tools to generate new bodies of simple geometrical shapes.

• capytaine.bodies.bodies module
  • FloatingBody
    • FloatingBody.add_all_rigid_body_dofs()
    • FloatingBody.add_dofs_labels_to_matrix()
    • FloatingBody.add_dofs_labels_to_vector()
    • FloatingBody.add_rotation_dof()
    • FloatingBody.add_translation_dof()
    • FloatingBody.animate()
    • FloatingBody.assemble_arbitrary_array()
    • FloatingBody.assemble_regular_array()
    • FloatingBody.center_of_buoyancy
    • FloatingBody.clip()
    • FloatingBody.clipped()
    • FloatingBody.combine_dofs()
    • FloatingBody.compute_hydrostatic_stiffness()
    • FloatingBody.compute_hydrostatics()
    • FloatingBody.compute_rigid_body_inertia()
    • FloatingBody.copy()
    • FloatingBody.disp_mass()
    • FloatingBody.dof_normals()
    • FloatingBody.each_hydrostatic_stiffness()
    • FloatingBody.extract_faces()
    • FloatingBody.from_file()
    • FloatingBody.from_meshio()
    • FloatingBody.immersed_part()
    • FloatingBody.integrate_pressure()
    • FloatingBody.join_bodies()
    • FloatingBody.keep_immersed_part()
    • FloatingBody.keep_only_dofs()
    • FloatingBody.longitudinal_metacentric_height
    • FloatingBody.longitudinal_metacentric_radius
    • FloatingBody.minced()
    • FloatingBody.mirror()
    • FloatingBody.nb_dofs
    • FloatingBody.rotate()
    • FloatingBody.show()
    • FloatingBody.show_matplotlib()
    • FloatingBody.sliced_by_plane()
    • FloatingBody.surface_integral()
    • FloatingBody.translate()
    • FloatingBody.transversal_metacentric_height
    • FloatingBody.transversal_metacentric_radius
    • FloatingBody.volume
    • FloatingBody.volumes
    • FloatingBody.waterplane_area
    • FloatingBody.waterplane_center
    • FloatingBody.waterplane_integral()
    • FloatingBody.wet_surface_area
• capytaine.bodies.predefined.spheres module
  • Sphere
• capytaine.bodies.predefined.cylinders module
  • Disk
  • HorizontalCylinder
  • VerticalCylinder
• capytaine.bodies.predefined.rectangles module
  • OpenRectangularParallelepiped
  • Rectangle
  • RectangularParallelepiped

tools

Depends on: none.

Unsorted tools.

• capytaine.tools.prony_decomposition module
  • error_exponential_decomposition()
  • exponential_decomposition()

green_functions

Depends on: tools.

This module contains the routine to evaluate the Green function.

• capytaine.green_functions.abstract_green_function module
  • AbstractGreenFunction
    • AbstractGreenFunction.evaluate()
• capytaine.green_functions.delhommeau module
  • Delhommeau
    • Delhommeau.evaluate()
    • Delhommeau.find_best_exponential_decomposition()
    • Delhommeau.fortran_core_basename
  • XieDelhommeau
    • XieDelhommeau.fortran_core_basename

bem

Depends on: meshes, bodies, matrices, green_functions, io.xarray.

The module is the core of the code. It contains the routines to assemble the matrices and solve the BEM problem.

• capytaine.bem.airy_waves module
  • airy_waves_potential()
  • airy_waves_velocity()
  • froude_krylov_force()
• capytaine.bem.engines module
  • BasicMatrixEngine
    • BasicMatrixEngine.available_linear_solvers
    • BasicMatrixEngine.build_matrices()
  • HierarchicalToeplitzMatrixEngine
    • HierarchicalToeplitzMatrixEngine.build_matrices()
  • MatrixEngine
    • MatrixEngine.build_S_matrix()
    • MatrixEngine.build_matrices()
• capytaine.bem.solver module
  • BEMSolver
    • BEMSolver.fill_dataset()
    • BEMSolver.from_exported_settings()
    • BEMSolver.get_free_surface_elevation()
    • BEMSolver.get_potential_on_mesh()
    • BEMSolver.solve()
    • BEMSolver.solve_all()
  • Nemoh
    • Nemoh.build_matrices()
• capytaine.bem.problems_and_results module
  • DiffractionProblem
    • DiffractionProblem.make_results_container()
  • DiffractionResult
    • DiffractionResult.records
    • DiffractionResult.store_force()
  • LinearPotentialFlowProblem
    • LinearPotentialFlowProblem.body_name
    • LinearPotentialFlowProblem.depth
    • LinearPotentialFlowProblem.dimensionless_omega
    • LinearPotentialFlowProblem.dimensionless_wavenumber
    • LinearPotentialFlowProblem.influenced_dofs
    • LinearPotentialFlowProblem.make_results_container()
    • LinearPotentialFlowProblem.period
    • LinearPotentialFlowProblem.water_depth
    • LinearPotentialFlowProblem.wavelength
    • LinearPotentialFlowProblem.wavenumber
  • LinearPotentialFlowResult
    • LinearPotentialFlowResult.store_force()
  • RadiationProblem
    • RadiationProblem.make_results_container()
  • RadiationResult
    • RadiationResult.records
    • RadiationResult.store_force()

io.xarray

Depends on: bem.

This submodule contains the code used to read and write the xarray datasets that are the standard output of the code. It is interlaced with capytaine.bem and might be merged with it in the future.

• capytaine.io.xarray module
  • assemble_dataset()
  • collect_records()
  • hydrostatics_dataset()
  • kochin_data_array()
  • merge_complex_values()
  • problems_from_dataset()
  • separate_complex_values()
  • wavenumber_data_array()

post_pro

Depends on: meshes, bodies, bem, io.xarray.

This module contains various tools for the post-processing of the results of the BEM problem.

• capytaine.post_pro.free_surfaces module
  • FreeSurface
    • FreeSurface.area
    • FreeSurface.incoming_waves()
• capytaine.post_pro.kochin module
  • compute_kochin()
• capytaine.post_pro.impedance module
  • impedance()
  • rao_transfer_function()
• capytaine.post_pro.rao module
  • rao()

ui.vtk

Depends on: meshes, bodies and post_pro.

This module contains the calls to VTK used for the 3D display of the meshes and the animation of the free surface.

• capytaine.ui.vtk.animation module
  • Animation
    • Animation.add_body()
    • Animation.add_free_surface()
    • Animation.embed_in_notebook()
    • Animation.run()
    • Animation.save()
• capytaine.ui.vtk.body_viewer module
  • FloatingBodyViewer
    • FloatingBodyViewer.add_body()
• capytaine.ui.vtk.helpers module
  • compute_node_data()
  • compute_vtk_polydata()
• capytaine.ui.vtk.mesh_viewer module
  • MeshViewer
    • MeshViewer.add_line()
    • MeshViewer.add_mesh()
    • MeshViewer.add_oxy_plane()
    • MeshViewer.add_plane()
    • MeshViewer.add_point()
    • MeshViewer.add_polydata()
    • MeshViewer.add_vector()
    • MeshViewer.finalize()
    • MeshViewer.on_key_press()
    • MeshViewer.save()
    • MeshViewer.screenshot()
    • MeshViewer.show()
    • MeshViewer.show_axes()
    • MeshViewer.show_normals()

io

Depends on: meshes, bodies, bem.

This module contains various tools for inputs and outputs of the code.

• capytaine.io.legacy module
  • export_as_Nemoh_directory()
  • import_cal_file()
  • write_dataset_as_tecplot_files()
• capytaine.io.mesh_loaders module
  • load_DAT()
  • load_GDF()
  • load_HST()
  • load_INP()
  • load_MAR()
  • load_MED()
  • load_MSH()
  • load_NAT()
  • load_NEM()
  • load_RAD()
  • load_STL()
  • load_TEC()
  • load_VTK()
  • load_VTP()
  • load_VTU()
  • load_WRL()
  • load_mesh()
• capytaine.io.mesh_writers module
  • write_DAT()
  • write_GDF()
  • write_HST()
  • write_INP()
  • write_MAR()
  • write_MED()
  • write_MSH()
  • write_NAT()
  • write_NEM()
  • write_RAD()
  • write_STL()
  • write_TEC()
  • write_VTK()
  • write_VTP()
  • write_VTU()
  • write_WRL()
  • write_mesh()

ui.cli

Depends on: io, bem.

This module contains the command-line interface of the code.

• capytaine.ui.cli module
  • main()