FourierNoise.h File Reference

Go to the source code of this file.

Classes
class	FourierNoise
	Generate noise using random fourier series coefficients. More...
struct	FourierNoise::SeriesItem

Functions
template<>
InputParameters	validParams< FourierNoise > ()

Function Documentation

validParams< FourierNoise >()

template<>

InputParameters validParams< FourierNoise >

(

)

Definition at line 19 of file FourierNoise.C.

{
  InputParameters params = validParams<Function>();
  params.addClassDescription("Generate noise from a fourier series");
  params.addRequiredParam<Real>("lambda",
                                "Wavelength cut off (set to about twice the interfacial width)");
  params.addParam<unsigned int>(
      "num_terms",
      "Number of random fourier series terms (this will result in non-periodic noise). Omit this "
      "parameter to obtain a periodic noise distribution.");
  params.addParam<unsigned int>("seed", 12455, "Random number generator seed");
  return params;
}