- property_fileThe file containing interpolation tables for material properties (within the directory specified by 'file_location').
C++ Type:RelativeFileName
Unit:(no unit assumed)
Controllable:No
Description:The file containing interpolation tables for material properties (within the directory specified by 'file_location').
- variableThe name of the variable that this kernel operates on
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this kernel operates on
ScalarSplineInterpolation
buildconstruction:Undocumented Class
The ScalarSplineInterpolation 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.
Overview
Example Input File Syntax
Input Parameters
- const_sampler0The value with which the data will be sampled.
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The value with which the data will be sampled.
- execute_onLINEARThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- file_location.The name of the file that stores reaction rate tables (defaults to the current directory).
Default:.
C++ Type:FileName
Unit:(no unit assumed)
Controllable:No
Description:The name of the file that stores reaction rate tables (defaults to the current directory).
- samplerThe variable with which the data will be sampled.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The variable with which the data will be sampled.
- sampling_formatreduced_fieldThe format that the rate constant files are in. Options: reduced_field and electron_energy.
Default:reduced_field
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The format that the rate constant files are in. Options: reduced_field and electron_energy.
- scale_factor1Multiplies the sampled output by a given factor. Convert from m^3 to cm^3, for example.(Optional)
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Multiplies the sampled output by a given factor. Convert from m^3 to cm^3, for example.(Optional)
- use_logFalseWhether or not to return the natural logarithm of the sampled data.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to return the natural logarithm of the sampled data.
- use_timeFalseWhether or not to sample with time.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to sample with time.
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.