Skip to content

Commit

Permalink
Better document the return type of a function.
Browse files Browse the repository at this point in the history
  • Loading branch information
bangerth committed Nov 15, 2024
1 parent e3cee65 commit a171c06
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions include/aspect/boundary_heat_flux/interface.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,18 @@ namespace aspect
* @param material_model_inputs The material property inputs.
* @param material_model_outputs The material property outputs.
* @param normal_vectors The normal vector at each quadrature point.
*
* @return A vector of heat flux vectors at the evaluation points.
* For historical reasons, the function is asked
* to provide the heat flux as a vector, even though the place where the
* heat flux is used only uses the component of this vector that is
* to the boundary (which it computes by taking the dot product *normal*
* between the returned vector and the normal vector). Because there are
* situations where all you can do is compute the normal heat flux as a
* scalar, the `heat_flux()` function also receives the normal vector as
* an input argument. As a consequence, one way for the function to
* compute the required heat flux vector is to compute the scalar heat
* flux and multiply it by the normal vector.
*/
virtual
std::vector<Tensor<1,dim>>
Expand Down

0 comments on commit a171c06

Please sign in to comment.