capytaine package

Subpackages

• capytaine.bem package
  • Submodules
    • capytaine.bem.airy_waves module
      • airy_waves_free_surface_elevation()
      • airy_waves_potential()
      • airy_waves_pressure()
      • airy_waves_velocity()
      • froude_krylov_force()
    • capytaine.bem.engines module
      • Counter
      • DefaultMatrixEngine
      • MatrixEngine
      • check_if_nan_in_matrix()
      • solve_gmres()
    • capytaine.bem.problems_and_results module
      • DiffractionProblem
      • DiffractionResult
      • FailedDiffractionResult
      • FailedLinearPotentialFlowResult
      • FailedRadiationResult
      • LinearPotentialFlowProblem
      • LinearPotentialFlowResult
      • RadiationProblem
      • RadiationResult
    • capytaine.bem.problems_checks module
    • capytaine.bem.solver module
      • BEMSolver
  • Module contents
• capytaine.bodies package
  • Submodules
    • capytaine.bodies.abstract_bodies module
      • AbstractBody
    • capytaine.bodies.bodies module
      • FloatingBody
    • capytaine.bodies.dofs module
      • AbstractDof
      • DofOnSubmesh
      • RotationDof
      • TranslationDof
      • add_dofs_labels_to_matrix()
      • add_dofs_labels_to_vector()
      • is_rigid_body_dof()
      • normalize_name()
      • rigid_body_dofs()
    • capytaine.bodies.hydrostatics module
    • capytaine.bodies.multibodies module
      • Multibody
    • capytaine.bodies.visualization module
      • BodyPyVistaViewer
      • show_3d()
      • show_matplotlib()
      • show_pyvista()
  • Module contents
• capytaine.green_functions package
  • Submodules
    • capytaine.green_functions.abstract_green_function module
      • AbstractGreenFunction
      • GreenFunctionEvaluationError
    • capytaine.green_functions.delhommeau module
      • Delhommeau
      • XieDelhommeau
    • capytaine.green_functions.hams module
      • FinGreen3D
      • HAMS_GF
      • LiangWuNoblesseGF
  • Module contents
• capytaine.io package
  • Submodules
    • capytaine.io.bemio module
      • dataframe_from_bemio()
    • capytaine.io.legacy module
      • export_hydrostatics()
      • export_hydrostatics_from_dataset()
      • import_cal_file()
      • run_cal_file()
      • write_dataset_as_tecplot_files()
    • capytaine.io.wamit module
      • check_dataset_ready_for_export()
      • export_to_wamit()
      • export_wamit_1()
      • export_wamit_3()
      • export_wamit_3fk()
      • export_wamit_3sc()
      • export_wamit_8()
      • export_wamit_hst()
      • get_dof_index_and_k()
      • identify_frequency_axis()
    • capytaine.io.xarray module
      • assemble_dataframe()
      • assemble_dataset()
      • assemble_matrices()
      • compute_hydrostatics_dataset()
      • export_dataset()
      • kochin_data_array()
      • merge_complex_values()
      • problems_from_dataset()
      • save_dataset_as_netcdf()
      • separate_complex_values()
  • Module contents
• capytaine.meshes package
  • Subpackages
    • capytaine.meshes.predefined package
      • Submodules
      • Module contents
  • Submodules
    • capytaine.meshes.abstract_meshes module
      • AbstractMesh
    • capytaine.meshes.clean module
      • clean_mesh()
      • clean_mesh_once()
      • merge_near_duplicate_vertices()
      • remove_duplicate_faces()
      • remove_duplicate_vertices()
      • remove_small_faces()
      • remove_unused_vertices()
    • capytaine.meshes.clip module
      • clip_faces()
      • compute_aspect_ratio()
    • capytaine.meshes.export module
      • export_mesh()
      • export_to_meshio()
      • export_to_pyvista()
      • export_to_trimesh()
      • export_to_vedo()
      • export_to_xarray()
    • capytaine.meshes.geometry module
      • clustering()
      • compute_distance_between_points()
      • compute_faces_areas()
      • compute_faces_centers()
      • compute_faces_normals()
      • compute_faces_radii()
      • compute_gauss_legendre_2_quadrature()
      • connected_components()
      • connected_components_of_waterline()
      • faces_in_group()
      • get_vertices_face()
    • capytaine.meshes.io module
      • load_mesh()
    • capytaine.meshes.meshes module
      • Mesh
    • capytaine.meshes.quality module
      • check_mesh_quality()
      • extract_face_vertices()
      • indices_of_non_convex_faces()
      • indices_of_non_coplanar_faces()
      • is_face_convex()
      • is_non_coplanar()
    • capytaine.meshes.surface_integrals module
      • SurfaceIntegralsMixin
    • capytaine.meshes.symmetric_meshes module
      • ReflectionSymmetricMesh
      • RotationSymmetricMesh
    • capytaine.meshes.visualization module
      • PyVistaViewer
      • show_3d()
      • show_matplotlib()
      • show_pyvista()
  • Module contents
    • Mesh
      • Mesh.as_array_of_faces()
      • Mesh.as_list_of_faces()
      • Mesh.clipped()
      • Mesh.copy()
      • Mesh.export()
      • Mesh.extract_faces()
      • Mesh.extract_lid()
      • Mesh.faces
      • Mesh.faces_areas
      • Mesh.faces_centers
      • Mesh.faces_normals
      • Mesh.faces_radiuses
      • Mesh.faces_vertices_centers
      • Mesh.from_list_of_faces()
      • Mesh.generate_lid()
      • Mesh.join_meshes()
      • Mesh.merged()
      • Mesh.mirrored()
      • Mesh.nb_faces
      • Mesh.nb_quads
      • Mesh.nb_triangles
      • Mesh.nb_vertices
      • Mesh.quadrature_points
      • Mesh.rotated_with_matrix()
      • Mesh.show()
      • Mesh.summary()
      • Mesh.translated()
      • Mesh.with_normal_vector_going_down()
      • Mesh.with_quadrature()
    • ReflectionSymmetricMesh
      • ReflectionSymmetricMesh.clipped()
      • ReflectionSymmetricMesh.copy()
      • ReflectionSymmetricMesh.export()
      • ReflectionSymmetricMesh.extract_faces()
      • ReflectionSymmetricMesh.extract_lid()
      • ReflectionSymmetricMesh.faces
      • ReflectionSymmetricMesh.faces_areas
      • ReflectionSymmetricMesh.faces_centers
      • ReflectionSymmetricMesh.faces_normals
      • ReflectionSymmetricMesh.faces_radiuses
      • ReflectionSymmetricMesh.generate_lid()
      • ReflectionSymmetricMesh.join_meshes()
      • ReflectionSymmetricMesh.merged()
      • ReflectionSymmetricMesh.mirrored()
      • ReflectionSymmetricMesh.nb_faces
      • ReflectionSymmetricMesh.nb_vertices
      • ReflectionSymmetricMesh.quadrature_points
      • ReflectionSymmetricMesh.rotated_with_matrix()
      • ReflectionSymmetricMesh.show()
      • ReflectionSymmetricMesh.translated()
      • ReflectionSymmetricMesh.vertices
      • ReflectionSymmetricMesh.with_normal_vector_going_down()
      • ReflectionSymmetricMesh.with_quadrature()
    • RotationSymmetricMesh
      • RotationSymmetricMesh.clipped()
      • RotationSymmetricMesh.copy()
      • RotationSymmetricMesh.export()
      • RotationSymmetricMesh.extract_faces()
      • RotationSymmetricMesh.extract_lid()
      • RotationSymmetricMesh.faces
      • RotationSymmetricMesh.faces_areas
      • RotationSymmetricMesh.faces_centers
      • RotationSymmetricMesh.faces_normals
      • RotationSymmetricMesh.faces_radiuses
      • RotationSymmetricMesh.from_profile_points()
      • RotationSymmetricMesh.generate_lid()
      • RotationSymmetricMesh.join_meshes()
      • RotationSymmetricMesh.merged()
      • RotationSymmetricMesh.mirrored()
      • RotationSymmetricMesh.nb_faces
      • RotationSymmetricMesh.nb_vertices
      • RotationSymmetricMesh.quadrature_points
      • RotationSymmetricMesh.rotated_with_matrix()
      • RotationSymmetricMesh.show()
      • RotationSymmetricMesh.translated()
      • RotationSymmetricMesh.vertices
      • RotationSymmetricMesh.with_normal_vector_going_down()
      • RotationSymmetricMesh.with_quadrature()
• capytaine.post_pro package
  • Submodules
    • capytaine.post_pro.impedance module
      • impedance()
      • rao_transfer_function()
    • capytaine.post_pro.kochin module
      • compute_kochin()
    • capytaine.post_pro.mean_drift_force module
      • far_field_mean_drift_force()
    • capytaine.post_pro.rao module
      • rao()
  • Module contents
• capytaine.tools package
  • Submodules
    • capytaine.tools.block_circulant_matrices module
      • BlockCirculantMatrix
      • BlockDiagonalMatrix
      • LUDecomposedBlockCirculantMatrix
      • LUDecomposedBlockDiagonalMatrix
      • LUDecomposedMatrix
      • NestedBlockCirculantMatrix
      • circular_permutation()
      • ending_dimensions_at_the_beginning()
      • has_been_lu_decomposed()
      • leading_dimensions_at_the_end()
      • lu_decompose()
    • capytaine.tools.cache_on_disk module
      • cache_directory()
    • capytaine.tools.deprecation_handling module
    • capytaine.tools.lazy_matrices module
      • LazyMatrix
      • slices()
    • capytaine.tools.lists_of_points module
    • capytaine.tools.memory_monitor module
      • MemoryMonitor
    • capytaine.tools.optional_imports module
      • import_optional_dependency()
      • silently_import_optional_dependency()
    • capytaine.tools.prony_decomposition module
      • PronyDecompositionFailure
      • error_exponential_decomposition()
      • exponential_decomposition()
      • find_best_exponential_decomposition()
    • capytaine.tools.symbolic_multiplication module
      • SymbolicMultiplication
      • supporting_symbolic_multiplication()
    • capytaine.tools.timer module
      • Timer
  • Module contents
• capytaine.ui package
  • Submodules
    • capytaine.ui.cli module
      • main()
    • capytaine.ui.env_vars module
      • look_for_boolean_var()
    • capytaine.ui.error_messages module
      • display_grouped_errors()
    • capytaine.ui.rich module
      • set_logging()
    • capytaine.ui.vedo_animations module
      • Animation
      • AnimationComponent
  • Module contents

Module contents