API documentation

The documentation is under development while we are restructuring the codebase. Parts the are being moved to the new structure are directly below this line.

Note

For reference, we are keeping a pinned issue on GitHub describing the restructuring process and the reasoning behind it. See Issue #190 for more details.

New structure

• specfem
  • specfem
  • specfem::assembly
    • specfem::assembly
    • specfem::assembly::assembly
    • specfem::assembly::boundaries
    • specfem::assembly::compute_source_array
    • specfem::assembly::coupled_interfaces
    • specfem::assembly::element_types
    • specfem::assembly::edge_types
    • specfem::assembly::fields
    • specfem::assembly::simulation_field
    • specfem::assembly::jacobian_matrix
    • specfem::assembly::kernels
    • specfem::assembly::mesh
    • specfem::assembly::properties
    • specfem::assembly::receivers
    • specfem::assembly::sources
  • specfem::chunk_edge
    • specfem::chunk_edge
    • specfem::chunk_edge::Index
    • specfem::chunk_edge::displacement
    • specfem::chunk_edge::velocity
    • specfem::chunk_edge::acceleration
    • specfem::chunk_edge::transfer_function_self
    • specfem::chunk_edge::transfer_function_coupled
    • specfem::chunk_edge::intersection_factor
    • specfem::chunk_edge::intersection_normal
    • specfem::chunk_edge::NonconformingAccessorPack
    • specfem::chunk_edge::coupling_terms_pack
    • specfem::chunk_edge::integral_data_pack
  • specfem::chunk_element
    • specfem::chunk_element
    • specfem::chunk_element::Index
    • specfem::chunk_element::MappedIndex
    • specfem::chunk_element::displacement
    • specfem::chunk_element::velocity
    • specfem::chunk_element::acceleration
    • specfem::chunk_element::stress_integrand
  • specfem::data_access
    • specfem::data_access
    • specfem::data_access::DataClassType
    • specfem::data_access::ContainerType
    • specfem::data_access::Container
    • specfem::data_access::AccessorType
    • specfem::data_access::Accessor
  • specfem::io
    • specfem::io
    • specfem::io::read_2d_mesh
    • specfem::io::read_3d_mesh
    • specfem::io::read_2d_sources
    • specfem::io::read_3d_sources
    • specfem::io::read_2d_receivers
    • specfem::io::read
    • specfem::io::write
    • specfem::io::wavefield_reader
    • specfem::io::wavefield_writer
    • specfem::io::seismogram_reader
    • specfem::io::seismogram_writer
    • specfem::io::property_reader
    • specfem::io::property_writer
    • specfem::io::kernel_writer
    • specfem::io::reader
    • specfem::io::writer
    • specfem::io::backends
  • specfem::jacobian
    • specfem::jacobian
    • specfem::jacobian::compute_locations
    • specfem::jacobian::compute_jacobian
  • Macros
    • FOR_EACH_IN_PRODUCT
    • SUPPRESS_TEMPORARY_REF
    • POINT_CONTAINER
    • DATA_CONTAINER
    • CONFIG_STRINGS
  • specfem::MPI
    • specfem::MPI
  • specfem::periodic_tasks
    • specfem::periodic_tasks
    • specfem::periodic_tasks::periodic_task
    • specfem::periodic_tasks::check_signal
    • specfem::periodic_tasks::plot_wavefield
    • specfem::periodic_tasks::plotter
    • specfem::periodic_tasks::wavefield_reader
    • specfem::periodic_tasks::wavefield_writer
  • specfem::point
    • specfem::point
    • specfem::point::assembly_index
    • specfem::point::boundary
    • specfem::point::conforming_interface
    • specfem::point::local_coordinates
    • specfem::point::global_coordinates
    • specfem::point::edge_index
    • specfem::point::displacement
    • specfem::point::velocity
    • specfem::point::acceleration
    • specfem::point::mass_inverse
    • specfem::point::field_derivatives
    • specfem::point::index
    • specfem::point::mapped_index
    • specfem::point::interface_index
    • specfem::point::jacobian_matrix
    • specfem::point::kernels
    • specfem::point::nonconforming_interface
    • specfem::point::properties
    • specfem::point::source
    • specfem::point::stress
    • specfem::point::stress_integrands
  • specfem::program
    • specfem::program
    • specfem::program::Context
    • specfem::program::execute
    • specfem::program::abort
  • specfem::receivers
    • specfem::receivers
    • specfem::receivers::receiver
  • specfem::solver
    • specfem::solver
    • specfem::solver::solver
    • specfem::solver::time_marching
  • specfem::source_time_functions
    • specfem::source_time_functions
    • specfem::source_time_functions::stf
    • specfem::source_time_functions::Ricker
    • specfem::source_time_functions::Gaussian
    • specfem::source_time_functions::GaussianHdur
    • specfem::source_time_functions::dGaussian
    • specfem::source_time_functions::Dirac
    • specfem::source_time_functions::Heaviside
    • specfem::source_time_functions::external
  • specfem::sources
    • specfem::sources
    • specfem::sources::source
  • specfem::shape_function
    • specfem::shape_function
    • specfem::shape_function::shape_function
    • specfem::shape_function::shape_function_derivatives
  • specfem::time_scheme
    • specfem::time_scheme
    • specfem::time_scheme::time_scheme
    • specfem::time_scheme::newmark

Old structure

• specfem::algorithms
  • specfem::algorithms
  • specfem::algorithms::divergence
  • specfem::algorithms::gradient
  • specfem::algorithms::interpolate
  • specfem::algorithms::locate_point
  • specfem::algorithms::transfer
• specfem::boundary_conditions
  • specfem::boundary_conditions
  • specfem::boundary_conditions::apply_boundary_conditions
  • specfem::boundary_conditions::compute_mass_matrix_terms
• Enumerations
  • specfem::element::medium_tag
  • specfem::element::property_tag
  • specfem::element::boundary_tag
  • specfem::element::to_string
  • specfem::element::attributes
  • specfem::element::from_string
  • specfem::element::is_elastic
  • specfem::element::is_electromagnetic
  • specfem::element::medium_types
  • specfem::element::material_systems
  • specfem::element::element_types
  • specfem::dimension::type
  • specfem::dimension::dimension
  • specfem::display::format
  • specfem::interface::interface_tag
  • specfem::interface::attributes
  • specfem::interface::edges
  • specfem::simulation::type
  • specfem::simulation::simulation
  • specfem::connections::type
  • specfem::connections::to_string
  • specfem::connections::connection_mapping
  • specfem::connections::to_string
  • specfem::mesh_entity::edge
  • specfem::mesh_entity::element
  • specfem::mesh_entity::element_grid
  • specfem::mesh_entity::dim2::type
  • specfem::mesh_entity::dim3::type
  • specfem::mesh_entity::dim2::to_string
  • specfem::mesh_entity::dim3::to_string
  • specfem::mesh_entity::dim2::edges
  • specfem::mesh_entity::dim2::corners
  • specfem::mesh_entity::dim3::edges
  • specfem::mesh_entity::dim3::corners
  • specfem::mesh_entity::dim3::faces
  • specfem::wavefield::simulation_field
  • specfem::wavefield::type
  • specfem::wavefield::wavefield
  • specfem::wavefield::to_string
• Quadrature API
  • specfem::quadrature::quadrature
  • Types of quadratures implemented
• specfem::mesh
  • specfem::mesh
  • specfem::mesh::mesh
  • specfem::mesh::boundaries
  • specfem::mesh::control_nodes
  • specfem::mesh::materials
  • specfem::mesh::tags
• specfem::datatype
  • specfem::datatype
  • specfem::datatype::simd
  • specfem::datatype::simd_like
  • specfem::datatype::is_simd_mask
  • specfem::datatype::all_of
  • specfem::datatype::VectorPointViewType
  • specfem::datatype::TensorPointViewType
  • specfem::datatype::ScalarChunkElementViewType
  • specfem::datatype::VectorChunkElementViewType
  • specfem::datatype::TensorChunkElementViewType
  • specfem::datatype::ScalarChunkEdgeViewType
  • specfem::datatype::VectorChunkEdgeViewType
  • specfem::datatype::TensorChunkEdgeViewType
• Execution Framework
  • specfem::execution::VoidPolicy
  • specfem::execution::RangePolicy
  • specfem::execution::TeamPolicy
  • specfem::execution::TeamThreadRangePolicy
  • specfem::execution::PolicyType
  • specfem::execution::VoidIterator
  • specfem::execution::RangeIterator
  • specfem::execution::RangeIndex
  • specfem::execution::ChunkedDomainIterator
  • specfem::execution::ChunkElementIndex
  • specfem::execution::ChunkElementIterator
  • specfem::execution::PointIndex
  • specfem::execution::MappedChunkedDomainIterator
  • specfem::execution::MappedChunkElementIndex
  • specfem::execution::MappedChunkElementIterator
  • specfem::execution::MappedPointIndex
  • specfem::execution::TeamThreadMdRangeIterator
  • specfem::execution::ChunkedEdgeIterator
  • specfem::execution::ChunkEdgeIndex
  • specfem::execution::ChunkEdgeIterator
  • specfem::execution::EdgePointIndex
  • specfem::execution::ChunkedIntersectionIterator
  • specfem::execution::ChunkedIntersectionIndex
  • specfem::execution::ChunkedIntersectionIterator
  • specfem::execution::IntersectionPointIndex
  • specfem::execution::for_each_level
  • specfem::execution::for_all
• specfem::medium
  • specfem::medium
  • specfem::medium::material
  • specfem::medium::properties_container
  • specfem::medium::kernels_container
  • specfem::medium::compute_stress
  • specfem::medium::mass_matrix_component
  • specfem::medium::compute_wavefield
  • specfem::medium::compute_source_contribution
  • specfem::medium::compute_damping_force
  • specfem::medium::compute_cosserat_stress
  • specfem::medium::compute_couple_stress
  • specfem::medium::compute_frechet_derivatives
• specfem::kokkos_kernels
  • specfem::kokkos_kernels
  • specfem::kokkos_kernels::domain_kernels
  • specfem::kokkos_kernels::frechet_kernels
• Coupled Interface
• specfem::runtime_configuration
  • specfem::runtime_configuration
  • specfem::runtime_configuration::header
  • specfem::runtime_configuration::quadrature
  • specfem::runtime_configuration::solver
  • specfem::runtime_configuration::receivers
  • specfem::runtime_configuration::run_setup
  • specfem::runtime_configuration::database_configuration
  • specfem::runtime_configuration::seismogram
  • specfem::runtime_configuration::wavefield
  • specfem::runtime_configuration::display
  • specfem::runtime_configuration::setup
  • specfem::runtime_configuration::property
  • specfem::runtime_configuration::kernel
  • specfem::runtime_configuration::plot_wavefield
  • specfem::runtime_configuration::elastic_wave
  • specfem::runtime_configuration::electromagnetic_wave
  • specfem::runtime_configuration::sources
  • specfem::runtime_configuration::time_scheme
• specfem::parallel_configuration
  • specfem::parallel_configuration
  • specfem::parallel_configuration::chunk_config
  • specfem::parallel_configuration::edge_config
  • specfem::parallel_configuration::edge_chunk_config
  • specfem::parallel_configuration::range_config