Skip to content

Commit

Permalink
Forgot to add some files whoopsie...
Browse files Browse the repository at this point in the history
  • Loading branch information
lsawade committed Feb 24, 2025
1 parent fdcf7ad commit 454baca
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/api/mesh/dim3/boundaries/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

.. _mesh_boundaries_absorbing_boundaries_3D:

Boundaries
++++++++++


.. doxygenstruct:: specfem::mesh::boundaries< specfem::dimension::type::dim3 >
:members:

Absorbing Boundaries
====================

.. doxygenstruct:: specfem::mesh::absorbing_boundary< specfem::dimension::type::dim3 >
:members:



Free surface boundary
=====================

.. doxygenstruct:: specfem::mesh::free_surface< specfem::dimension::type::dim3 >
:members:
14 changes: 14 additions & 0 deletions docs/api/mesh/dim3/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. _mesh:

SPECFEM++ 3D Mesh
=================

.. doxygenstruct:: specfem::mesh::mesh< specfem::dimension::type::dim3 >
:members:


.. toctree::
:maxdepth: 1

boundaries/index
15 changes: 15 additions & 0 deletions docs/api/mesh/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

.. _mesh:

SPECFEM++ Mesh
==============

.. doxygenstruct:: specfem::mesh::mesh
:members:


.. toctree::
:maxdepth: 1

dim2/index
dim3/index
27 changes: 27 additions & 0 deletions include/mesh/dim3/boundaries/free_surface.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,22 @@ template <> struct free_surface<specfem::dimension::type::dim3> {
*/
free_surface(){};

/**
* @brief Constructor
*
* Constructor for the free_surface struct that initializes the number of
* the underlying arrays with the given parameters
*
* @param num_free_surface_faces Number of free surface faces
* @param ngllsquare Number of GLL points squared
*
* @code{.cpp}
* // Example of how to use this constructor
* specfem::mesh::free_surface<specfem::dimension::type::dim3> free_surface(
* num_free_surface_faces, ngllsquare);
* @endcode
*
*/
free_surface(const int num_free_surface_faces, const int ngllsquare)
: nelements(num_free_surface_faces), ngllsquare(ngllsquare),
num_free_surface_faces(num_free_surface_faces) {
Expand All @@ -54,6 +70,17 @@ template <> struct free_surface<specfem::dimension::type::dim3> {
}
///@}

/**
* @brief Print the free_surface struct
*
* Print the free_surface struct to the console
*
* @code{.cpp}
* // Example of how to use this function
* free_surface.print();
* @endcode
*
*/
void print() const;
};

Expand Down

0 comments on commit 454baca

Please sign in to comment.