custEM package

Subpackages

• custEM.core package
  • Submodules
  • custEM.core.model_base module
    • MOD
      • MOD.handle_exception()
      • MOD.init_default_model_parameters()
      • MOD.init_instances()
      • MOD.init_third_party_parameters()
      • MOD.solve_main_problem()
  • custEM.core.post_proc_fd module
    • PostProcessingFD
      • PostProcessingFD.convert_H_to_E()
      • PostProcessingFD.convert_results()
      • PostProcessingFD.dc_post_proc()
      • PostProcessingFD.export_A_fields()
      • PostProcessingFD.export_E_fields()
      • PostProcessingFD.export_H_fields()
      • PostProcessingFD.export_all_results()
      • PostProcessingFD.save_field()
  • custEM.core.post_proc_td module
    • PostProcessingTD
      • PostProcessingTD.convert_results()
      • PostProcessingTD.export_td_data()
      • PostProcessingTD.interpolate_frequency_solutions()
      • PostProcessingTD.merge_td_results()
      • PostProcessingTD.reorder_results()
  • custEM.core.pre_proc module
    • PreProcessing
      • PreProcessing.import_all_results()
      • PreProcessing.import_selected_results()
      • PreProcessing.load()
      • PreProcessing.read_h5()
  • custEM.core.solvers module
    • Solver
      • Solver.build_PRESB_Jacobian()
      • Solver.call_mumps()
      • Solver.solve_PRESB_Jacobian()
      • Solver.solve_system_default()
      • Solver.solve_system_iter_BD()
      • Solver.solve_system_iter_Hfield()
      • Solver.solve_system_iter_PRESB()
      • Solver.solve_system_mumps()
      • Solver.solve_var_form_default()
      • Solver.solve_var_form_iter()
  • Module contents
    • core
• custEM.fem package
  • Submodules
  • custEM.fem.assembly module
    • MTAssembler
      • MTAssembler.assemble()
    • SecondaryFieldAssembler
      • SecondaryFieldAssembler.assemble()
    • TotalFieldAssembler
      • TotalFieldAssembler.add_topo()
      • TotalFieldAssembler.append_lists()
      • TotalFieldAssembler.assemble()
      • TotalFieldAssembler.eval_target_dir()
      • TotalFieldAssembler.find_and_fill_start_stop_dof()
      • TotalFieldAssembler.find_cells()
      • TotalFieldAssembler.find_directions()
      • TotalFieldAssembler.find_dof_coords()
      • TotalFieldAssembler.find_for_hed()
      • TotalFieldAssembler.find_for_line()
      • TotalFieldAssembler.find_for_loop_r()
      • TotalFieldAssembler.find_for_path()
      • TotalFieldAssembler.find_for_vmd()
      • TotalFieldAssembler.test_An_total()
  • custEM.fem.calc_primary_boundary_fields module
    • Pyhed_calc
      • Pyhed_calc.calc_fields()
      • Pyhed_calc.convertCoordinates()
      • Pyhed_calc.read_h5()
      • Pyhed_calc.read_serial_calculation_parameters()
      • Pyhed_calc.write_h5()
  • custEM.fem.calc_primary_fields module
    • Pyhed_calc
      • Pyhed_calc.calc_fields()
      • Pyhed_calc.convertCoordinates()
      • Pyhed_calc.read_h5()
      • Pyhed_calc.read_serial_calculation_parameters()
      • Pyhed_calc.write_h5()
  • custEM.fem.fem_base module
    • Domains
      • Domains.add_anomaly()
    • FunctionSpaces
      • FunctionSpaces.add_dirichlet_bc()
      • FunctionSpaces.add_inner_dirichlet_bc()
      • FunctionSpaces.add_primary_fields()
      • FunctionSpaces.build_complex_sigma_func()
      • FunctionSpaces.build_dg_func()
      • FunctionSpaces.build_dg_tensor_func()
      • FunctionSpaces.init_mesh()
    • ModelParameters
      • ModelParameters.build_dg_parameter_functions()
      • ModelParameters.calc_delta_sigma()
      • ModelParameters.check_parameter_dx_conformity()
      • ModelParameters.load_mesh_parameters()
      • ModelParameters.print_model_parameters()
      • ModelParameters.update_model_parameters()
  • custEM.fem.fem_utils module
    • ApproachBaseFD
      • ApproachBaseFD.update_fem_parameters()
      • ApproachBaseFD.update_tx_parameters()
    • ApproachBaseTD
      • ApproachBaseTD.biot_savart()
      • ApproachBaseTD.calc_dc_field()
      • ApproachBaseTD.calc_static_magnetic_field()
      • ApproachBaseTD.export_interpolation_data()
      • ApproachBaseTD.interpolate_dc()
      • ApproachBaseTD.interpolate_static()
      • ApproachBaseTD.update_fem_parameters()
      • ApproachBaseTD.update_tx_parameters()
    • DC
      • DC.build_var_form()
      • DC.calc_dc_field()
      • DC.calc_primary_potential()
      • DC.lhs_form()
      • DC.rhs_form_secondary()
      • DC.rhs_form_total()
    • add_sigma_vals_to_list()
    • check_sigma_vals()
    • check_source()
  • custEM.fem.frequency_domain_approaches module
    • A_V_mixed
      • A_V_mixed.build_var_form()
      • A_V_mixed.lhs_forms()
      • A_V_mixed.rhs_form_secondary()
      • A_V_mixed.rhs_form_total()
    • A_V_nodal
      • A_V_nodal.build_var_form()
      • A_V_nodal.lhs_form()
      • A_V_nodal.rhs_form_secondary()
      • A_V_nodal.rhs_form_total()
    • E_vector
      • E_vector.build_var_form()
      • E_vector.lhs_forms()
      • E_vector.lhs_forms_full()
      • E_vector.rhs_form_secondary()
      • E_vector.rhs_form_total()
    • F_U_mixed
      • F_U_mixed.build_var_form()
      • F_U_mixed.lhs_forms()
      • F_U_mixed.rhs_form_secondary()
      • F_U_mixed.rhs_form_total()
    • F_U_nodal
    • H_vector
      • H_vector.build_var_form()
      • H_vector.lhs_form_full()
      • H_vector.lhs_forms()
      • H_vector.rhs_form_secondary()
      • H_vector.rhs_form_total()
  • custEM.fem.primary_fields module
    • PrimaryField
      • PrimaryField.calc_hed_fullspace_field()
      • PrimaryField.calc_layered_earth_field()
      • PrimaryField.calc_mt_fullspace_field()
      • PrimaryField.calc_vmd_fullspace_field()
      • PrimaryField.export_primary_fields()
      • PrimaryField.init_primary_field_name()
      • PrimaryField.load_primary_fields()
      • PrimaryField.write_serial_calculation_parameters()
  • custEM.fem.time_domain_approaches module
    • FourierTransformBased
      • FourierTransformBased.build_var_form()
      • FourierTransformBased.calc_frequency_solutions()
      • FourierTransformBased.fht_hanstein_80()
      • FourierTransformBased.initalize_frequencies()
      • FourierTransformBased.transform_to_time_domain()
    • ImplicitEuler
      • ImplicitEuler.build_var_form()
      • ImplicitEuler.first_order_IE()
      • ImplicitEuler.first_order_IE_full()
      • ImplicitEuler.gaussian()
      • ImplicitEuler.init_initial_condition()
      • ImplicitEuler.init_times()
      • ImplicitEuler.print_stepping_info()
      • ImplicitEuler.second_order_IE()
      • ImplicitEuler.time_stepping()
    • RationalArnoldi
      • RationalArnoldi.build_krylov_subspace_basis()
      • RationalArnoldi.build_var_form()
      • RationalArnoldi.expm_ra()
      • RationalArnoldi.get_poles_from_table()
      • RationalArnoldi.project_solution()
      • RationalArnoldi.rational_arnoldi()
  • Module contents
    • fem
• custEM.meshgen package
  • Submodules
  • custEM.meshgen.bathy_tools module
    • Bathy
      • Bathy.add_point_to_coast_line()
      • Bathy.add_point_towards_east()
      • Bathy.add_point_towards_north()
      • Bathy.add_point_towards_south()
      • Bathy.add_point_towards_west()
      • Bathy.build_closing_frame()
      • Bathy.check_distance()
      • Bathy.check_neighbours()
      • Bathy.eval_coast_line()
      • Bathy.find_direction()
      • Bathy.find_last_dir()
      • Bathy.find_start_point()
      • Bathy.go_clockwise()
      • Bathy.go_counter_clockwise()
      • Bathy.loadASC()
      • Bathy.loadTXT()
      • Bathy.translate()
  • custEM.meshgen.dem_interpolator module
    • DEM
      • DEM.loadASC()
      • DEM.loadTXT()
      • DEM.show()
      • DEM.translate()
  • custEM.meshgen.invmesh_tools module
    • PrismWorld
      • PrismWorld.add_prisms()
      • PrismWorld.add_triangles()
      • PrismWorld.create_2d_mesh()
      • PrismWorld.create_surface_rectangles()
      • PrismWorld.sort_surface_node_ids()
  • custEM.meshgen.mesh_convert module
    • mesh2xml2h5()
    • write_cell_interval()
    • write_cell_tetrahedron()
    • write_cell_triangle()
    • write_domain_marker()
    • write_footer_cells()
    • write_footer_domains()
    • write_footer_edges()
    • write_footer_graph()
    • write_footer_mesh()
    • write_footer_vertices()
    • write_graph_edge()
    • write_graph_vertex()
    • write_header_cells()
    • write_header_domains()
    • write_header_edges()
    • write_header_graph()
    • write_header_mesh()
    • write_header_vertices()
    • write_vertex()
    • write_xml_domain_file()
    • xml_to_hdf5()
  • custEM.meshgen.meshgen_tools module
    • BlankWorld
      • BlankWorld.add_air_tri()
      • BlankWorld.add_area_marker()
      • BlankWorld.add_brick()
      • BlankWorld.add_cylinder()
      • BlankWorld.add_hollow_cylinder()
      • BlankWorld.add_interface()
      • BlankWorld.add_intersecting_anomaly()
      • BlankWorld.add_inv_domains()
      • BlankWorld.add_marker()
      • BlankWorld.add_paths()
      • BlankWorld.add_plate()
      • BlankWorld.add_points()
      • BlankWorld.add_prism()
      • BlankWorld.add_quadrangle_face()
      • BlankWorld.add_refinement_area()
      • BlankWorld.add_rx()
      • BlankWorld.add_surface_anomaly()
      • BlankWorld.add_topo()
      • BlankWorld.add_tx()
      • BlankWorld.build_fullspace_mesh()
      • BlankWorld.build_halfspace_mesh()
      • BlankWorld.build_layered_earth_mesh()
      • BlankWorld.build_surface()
      • BlankWorld.call_tetgen()
      • BlankWorld.create_box()
      • BlankWorld.create_interface_mesh()
      • BlankWorld.eval_unique_markers()
      • BlankWorld.extend_anomaly_outcrops()
      • BlankWorld.extend_intersecting_anomaly()
      • BlankWorld.extend_world()
      • BlankWorld.get_topo_vals()
      • BlankWorld.init_dem()
      • BlankWorld.print_region_info()
      • BlankWorld.remove_duplicate_poly_faces()
      • BlankWorld.there_is_always_a_bigger_world()
      • BlankWorld.update_kwargs()
      • BlankWorld.write_mesh_parameters()
  • custEM.meshgen.meshgen_utils module
    • add_edges()
    • assign_topography()
    • closest_node()
    • create_circle()
    • create_ellipse()
    • export_tetgen_edge_file()
    • export_tetgen_node_file()
    • export_tetgen_poly_file()
    • find_closest()
    • find_edge_node_ids()
    • find_nodes_on_segment()
    • find_on_frame()
    • get_closest()
    • get_intersect()
    • get_unique_poly_ids()
    • inside_poly()
    • is_between()
    • is_between_1D()
    • is_between_2D()
    • is_between_2D_exact()
    • is_between_2Dvert()
    • line()
    • line_x()
    • line_y()
    • line_z()
    • loop_c()
    • loop_e()
    • loop_r()
    • npoly_to_triangles()
    • order_list()
    • pointset()
    • poly_area()
    • poly_peri()
    • refine_adaptive()
    • refine_adaptive2()
    • refine_path()
    • refine_rx()
    • resolve_rx_overlaps()
    • rotate()
    • rotate_around_point()
    • rx_grid()
    • translate()
    • write_synth_topo_to_asc()
    • write_synth_topo_to_xyz()
  • custEM.meshgen.vtk_convert module
    • vtk2xml2h5()
    • write_cell_tetrahedron()
    • write_domain_marker()
    • write_footer_cells()
    • write_footer_domains()
    • write_footer_mesh()
    • write_footer_vertices()
    • write_header_cells()
    • write_header_domains()
    • write_header_mesh()
    • write_header_vertices()
    • write_vertex()
    • write_xml_domain_file()
    • xml_to_hdf5()
  • Module contents
    • meshgen
• custEM.misc package
  • Submodules
  • custEM.misc.anomaly_expressions module
    • Plate
      • Plate.inside()
  • custEM.misc.misc module
    • Air
      • Air.inside()
    • DirichletBoundary
      • DirichletBoundary.inside()
    • Ground
      • Ground.inside()
    • block_print()
    • check_approach_and_file_format()
    • check_if_model_exists()
    • dump_csr()
    • enable_print()
    • get_coordinates()
    • logger_print()
    • make_directories()
    • mpi_print()
    • petsc_transfer_function()
    • read_h5()
    • read_paths()
    • resort_coordinates()
    • root_write()
    • run_multiple_serial()
    • run_serial()
    • smape()
    • specify_td_export_strings()
    • write_h5()
  • custEM.misc.profiler module
    • current_mem()
    • export_config_file()
    • export_resource_file()
    • get_logger()
    • max_mem()
    • release_memory()
  • custEM.misc.pyhed_calculations module
    • PHC
      • PHC.calc_reference()
  • custEM.misc.synthetic_definitions module
    • almost_flat_topo()
    • anti_cone_bathy()
    • borehole_tx()
    • cone_bathy()
    • double_cone_bathy()
    • example_2_loop_tx()
    • example_3_line_tx()
    • example_4_topo_cos_sin()
    • flat_topo()
    • gaussian_topo()
    • gaussian_topo_hole()
    • pyramid_topo()
    • roof_topo()
    • sample_topo_func()
    • subtopo_func1()
    • subtopo_func2()
    • surface_anomly_outcrop_1()
    • surface_anomly_outcrop_2()
    • surface_anomly_outcrop_3()
    • topo_func1()
    • topo_func2()
    • topo_func3()
    • tx_slope()
    • valley()
  • Module contents
    • misc
• custEM.post package
  • Submodules
  • custEM.post.interp_tools_fd module
    • FrequencyDomainInterpolator
      • FrequencyDomainInterpolator.export_interpolation_data()
      • FrequencyDomainInterpolator.interpolate()
      • FrequencyDomainInterpolator.interpolate_parallel()
  • custEM.post.interp_tools_td module
    • TimeDomainInterpolator
      • TimeDomainInterpolator.eval_rx()
      • TimeDomainInterpolator.export_interpolation_data()
      • TimeDomainInterpolator.interpolate()
      • TimeDomainInterpolator.interpolate_parallel()
  • custEM.post.interpolation_base module
    • InterpolationBase
      • InterpolationBase.auto_interpolate_parallel()
      • InterpolationBase.check_interpolation_meshes()
      • InterpolationBase.convert_imp_rhoa_tipper()
      • InterpolationBase.convert_mt_data()
      • InterpolationBase.create_interpolation_matrices()
      • InterpolationBase.create_line_mesh()
      • InterpolationBase.create_path_mesh()
      • InterpolationBase.create_path_meshes()
      • InterpolationBase.create_slice_mesh()
      • InterpolationBase.export_npy()
      • InterpolationBase.find_quantity()
      • InterpolationBase.merge_tx_results()
      • InterpolationBase.update_interpolation_parameters()
  • custEM.post.interpolation_utils module
    • build_line_mesh()
    • build_path_mesh()
    • build_slice_mesh()
  • custEM.post.plot_tools_fd module
    • PlotFD
      • PlotFD.abs_angles()
      • PlotFD.abs_errors()
      • PlotFD.add_3D_slice_plot()
      • PlotFD.add_cbar()
      • PlotFD.add_errors_to_slice_plot()
      • PlotFD.add_phase_bar()
      • PlotFD.add_to_line_plot()
      • PlotFD.add_to_slice_plot()
      • PlotFD.amp_phase_comp()
      • PlotFD.amp_phase_mag()
      • PlotFD.import_line_data()
      • PlotFD.import_point_data()
      • PlotFD.import_slice_data()
      • PlotFD.load_default_line_data()
      • PlotFD.load_default_slice_data()
      • PlotFD.mean_errors()
      • PlotFD.median_errors()
      • PlotFD.plot_line_data()
      • PlotFD.plot_line_errors()
      • PlotFD.plot_magnitude_angle_misfits()
      • PlotFD.plot_point_data()
      • PlotFD.plot_point_errors()
      • PlotFD.plot_slice_data()
      • PlotFD.plot_slice_errors()
      • PlotFD.ratio()
      • PlotFD.rel_errors()
      • PlotFD.save_plot()
  • custEM.post.plot_tools_td module
    • PlotTD
      • PlotTD.import_line_data()
  • custEM.post.plot_utils module
    • PlotBase
      • PlotBase.arrange_line_data()
      • PlotBase.calc_pyhed_reference()
      • PlotBase.eval_properties()
      • PlotBase.general_import()
      • PlotBase.get_coords()
      • PlotBase.init_cmap()
      • PlotBase.init_component_integers()
      • PlotBase.init_main_parameters()
      • PlotBase.load_model_parameters()
      • PlotBase.print_import_error()
      • PlotBase.rearange_point_data()
      • PlotBase.reduce_slice_data()
    • adjust_axes()
    • adjust_log_ticks()
    • adjust_subfigure_box_axes()
    • adjust_ticks_and_labels()
    • eval_colors()
    • make_plain_subfigure_box()
    • make_subfigure_box()
  • Module contents
    • post

Module contents

@author: Rochlitz.R

custEM.run_tests()

Starting test functions for conda builds.