Skip to content

Commit

Permalink
Clarify comments based on code review
Browse files Browse the repository at this point in the history
  • Loading branch information
jbakosi committed Dec 6, 2018
1 parent ee20f3e commit 1b0f8cf
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
4 changes: 3 additions & 1 deletion src/Control/Keywords.h
Original file line number Diff line number Diff line change
Expand Up @@ -4918,7 +4918,9 @@ struct upwind_info {
static std::string longDescription() { return
R"(This keyword is used to select the upwind flux
function used for discontinuous Galerkin (DG) spatial discretization
used in inciter. See Control/Inciter/Options/Flux.h for other valid
used in inciter. It is really only useful for scalar transport, it is thus
not selectable for anything else, and for scalar transport it is the
hardcoded flux type. See Control/Inciter/Options/Flux.h for other valid
options.)"; }
};
using upwind = keyword< upwind_info, TAOCPP_PEGTL_STRING("upwind") >;
Expand Down
8 changes: 5 additions & 3 deletions src/PDE/FunctionPrototypes.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ using ncomp_t = kw::ncomp::info::expect::type;
//! \details Functions of this type are used to evaluate known (e.g.,
//! analytical) solutions or setting initial conditions
//! \see e.g., inciter::CompFlowProblemVorticalFlow::solution
//! \note Used for both contininuous and discontinuous Galerkin discretizations
//! \note Used for both continuous and discontinuous Galerkin discretizations
using SolutionFn = std::function<
std::vector< real >( ncomp_t, ncomp_t, real, real, real, real ) >;

Expand All @@ -40,8 +40,10 @@ using RiemannFluxFn = std::function<
const std::vector< std::array< real, 3 > >& ) >;

//! Function prototype for flux vector functions
//! \details Functions of this type are used to compute numerical fluxes across a
//! surface by evaluating the fluxes in PDEs
//! \details Functions of this type are used to compute physical flux functions
//! in the PDEs being solved. These are different than the RiemannFluxFn
//! because they compute the actual flux functions, not the solution to a
//! Riemann problem.
//! \see e.g., inciter::dg::Transport::flux, inciter::dg::CompFlow::flux
using FluxFn = std::function<
std::vector< std::array< real, 3 > >
Expand Down

0 comments on commit 1b0f8cf

Please sign in to comment.