evolution::initial_data::WithNoise::AmplitudeType Struct Reference

Whether Amplitude is absolute or relative to the maximum absolute value of each variable on each element. More...

#include <WithNoise.hpp>

Public Types
using	type = NoiseAmplitudeType

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Whether Amplitude is absolute or relative to the maximum absolute value of each variable on each element.

Member Data Documentation

help

Options::String evolution::initial_data::WithNoise::AmplitudeType::help

staticconstexpr

Initial value:

=
        "'Absolute': noise is drawn from [-A, A] with A = Amplitude. "
        "'Relative': A = Amplitude * M, where M is the maximum absolute value "
        "of the variable over all of its components and grid points on the "
        "element."

---

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

• src/PointwiseFunctions/InitialDataUtilities/WithNoise.hpp