S3DFourierNoise

buildconstruction:Undocumented Class

The S3DFourierNoise has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Generate noise from a fourier series

Overview

Example Input File Syntax

Input Parameters

  • lambdaWavelength cut off (set to about twice the interfacial width)

    C++ Type:double

    Controllable:No

    Description:Wavelength cut off (set to about twice the interfacial width)

  • midmid for initial condition

    C++ Type:double

    Controllable:No

    Description:mid for initial condition

  • rangerange for initial condition

    C++ Type:double

    Controllable:No

    Description:range for initial condition

Required Parameters

  • execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.

  • num_termsNumber of random fourier series terms (this will result in non-periodic noise). Omit this parameter to obtain a periodic noise distribution.

    C++ Type:unsigned int

    Controllable:No

    Description:Number of random fourier series terms (this will result in non-periodic noise). Omit this parameter to obtain a periodic noise distribution.

  • seed12455Random number generator seed

    Default:12455

    C++ Type:unsigned int

    Controllable:No

    Description:Random number generator seed

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters