Skip to content

Commit

Permalink
DOC: Adding some doxygen style documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-moore22 committed Feb 12, 2024
1 parent 565a36d commit bb183c8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
11 changes: 11 additions & 0 deletions single-node/src/Explicit-Lagrange-Kokkos/SGH_solver/boundary.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@
#include "mesh.h"
#include "state.h"

/**
* \brief Apply velocity boundary conditions
*
* This function loops over all boundary nodes and applies boundary conditions
* depending on the definition of boundary set.
*
* \param mesh The mesh that boundary conditions are applied to
* \param boundary The type of boundary condition being applied
* \param node_vel A view into the nodal velocity
* \param time_value Current simulation time, uesd to apply transient boundary conditions
*/
void boundary_velocity(const mesh_t& mesh,
const CArrayKokkos<boundary_t>& boundary,
DViewCArrayKokkos<double>& node_vel,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@

#include "mesh.h"
#include "state.h"

/**
* \brief Update specific internal energy for the SGH solver
*
* This function updates the specific internal energy of each element by
* integrating the power (Force dotted into velocity) over the element.
*
* \param rk_alpha Time integration partition
* \param dt time increment
* \param mesh simulation mesh
* \param node_vel view into the nodal velocity memory
* \param node_coords view into the nodal position memory
* \param elem_sie view into the specific internal energy of each element
* \param elem_mass view into the element mass
* \param corner_force view into the corner forces
*/
void update_energy_sgh(double rk_alpha,
double dt,
const mesh_t& mesh,
Expand Down

0 comments on commit bb183c8

Please sign in to comment.