LinearSolver::multigrid::OptionTags::EnablePreSmoothing< OptionsGroup > Struct Template Reference

Public Types
using	type = bool
using	group = OptionsGroup

Static Public Member Functions
static std::string	name ()

Static Public Attributes
static constexpr Options::String	help

Member Data Documentation

help

template<typename OptionsGroup >

constexpr Options::String LinearSolver::multigrid::OptionTags::EnablePreSmoothing< OptionsGroup >::help

staticconstexpr

Initial value:

=
      "Set to 'False' to disable pre-smoothing altogether (\"cascading "
      "multigrid\"). Note that pre-smoothing can be necessary to remove "
      "high-frequency modes in the data that get restricted to coarser grids, "
      "since such high-frequency modes can introduce aliasing. However, when "
      "running only a single V-cycle as preconditioner, the initial field is "
      "typically zero, so pre-smoothing may not be worthwile."

---

The documentation for this struct was generated from the following file:

• src/ParallelAlgorithms/LinearSolver/Multigrid/Tags.hpp