- cycle_frequencyThe cycle's frequency in Hz
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The cycle's frequency in Hz
AddPeriodicRelativeNodalDifference
buildconstruction:Undocumented Action Class
The AddPeriodicRelativeNodalDifference 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 an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
This Action automatically adds the necessary objects to calculate the relative periodic difference. Relative Difference will be outputted as a Postprocessor named: 'var'_periodic_difference
Overview
Example Input File Syntax
This Action automatically adds the necessary objects to calculate the relative periodic difference. Relative Difference will be outputted as a Postprocessor named: 'var'_periodic_difference
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
- blockThe subdomain that this action applies to.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The subdomain that this action applies to.
- familyLAGRANGESpecifies the family of FE shape functions to use for this variable
Default:LAGRANGE
C++ Type:MooseEnum
Controllable:No
Description:Specifies the family of FE shape functions to use for this variable
- inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
- initial_conditionSpecifies a constant initial condition for this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a constant initial condition for this variable
- initial_from_file_varGives the name of a variable for which to read an initial condition from a mesh file
C++ Type:std::string
Controllable:No
Description:Gives the name of a variable for which to read an initial condition from a mesh file
- num_cycles2000The number of cycles this object is active.
Default:2000
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The number of cycles this object is active.
- orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
Default:FIRST
C++ Type:MooseEnum
Controllable:No
Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)
- periodic_variableThe periodic variables (Not in log form).
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The periodic variables (Not in log form).
- periodic_variable_logThe periodic variables that are in log form.
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The periodic variables that are in log form.
- scalingSpecifies a scaling factor to apply to this variable
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Specifies a scaling factor to apply to this variable
- starting_cycle0The number of the cycles before starting the difference calculation
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The number of the cycles before starting the difference calculation
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.