Skip to content

Commit

Permalink
improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
bobmyhill committed Aug 20, 2024
1 parent e848290 commit f2c8f6c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion include/aspect/material_model/interface.h
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,12 @@ namespace aspect

/**
* Parse an AveragingOperation and alias to an AveragingOperation
* that is appropriate for viscosity averaging.
* that only averages viscosity. If the input to this function is an
* AveragingOperation that averages all properties
* (e.g. 'harmonic_average'), the function returns the corresponding
* AveragingOperation that only operates on the viscosity
* (e.g. 'harmonic_average_only_viscosity'). This is useful in places
* where averaging is performed on only the viscosity property.
*/
AveragingOperation get_averaging_operation_for_viscosity(const AveragingOperation operation);
}
Expand Down

0 comments on commit f2c8f6c

Please sign in to comment.