- P0The total power of the beam.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The total power of the beam.
- RThe radius at which the beam intensity falls to $1/e^2$ of its axis value.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The radius at which the beam intensity falls to $1/e^2$ of its axis value.
- boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
- variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this residual object operates on
GaussianEnergyFluxBC
Describes an incoming heat flux beam with a Gaussian profile
This boundary condition is the finite element analog of FVGaussianEnergyFluxBC. It computes an influx of energy from a beam (e.g. laser) with a Gaussian spatial profile. The flux is given by
where is the total power of the beam, is the radius at which the intensity falls to of its axial value, and is the normed distance from the point at which we're evaluating the flux to the centerpoint of the beam. This functional form of the beam flux is taken from Wikipedia. The negative sign on the flux indicates that the flux is incoming. This class assumes that the beam impinges perpendicular to the surface.
Input Parameters
- displacementsThe displacements
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The displacements
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
- x_beam_coord0The x coordinate of the center of the beam as a function of time. Note that we will pass the origin as the spatial argument to the function; any spatial dependence in the passed-in function will be ignored
Default:0
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The x coordinate of the center of the beam as a function of time. Note that we will pass the origin as the spatial argument to the function; any spatial dependence in the passed-in function will be ignored
- y_beam_coord0The y coordinate of the center of the beam as a function of time. Note that we will pass the origin as the spatial argument to the function; any spatial dependence in the passed-in function will be ignored
Default:0
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The y coordinate of the center of the beam as a function of time. Note that we will pass the origin as the spatial argument to the function; any spatial dependence in the passed-in function will be ignored
- z_beam_coord0The z coordinate of the center of the beam as a function of time. Note that we will pass the origin as the spatial argument to the function; any spatial dependence in the passed-in function will be ignored
Default:0
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The z coordinate of the center of the beam as a function of time. Note that we will pass the origin as the spatial argument to the function; any spatial dependence in the passed-in function will be ignored
Optional Parameters
- absolute_value_vector_tagsThe tags for the vectors this residual object should fill with the absolute value of the residual contribution
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The tags for the vectors this residual object should fill with the absolute value of the residual contribution
- extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the matrices this Kernel should fill
- extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Unit:(no unit assumed)
Controllable:No
Description:The extra tags for the vectors this Kernel should fill
- matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The tag for the matrices this Kernel should fill
- vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The tag for the vectors this Kernel should fill
Tagging 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.
- diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
- 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.
- implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form
- save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:The seed for the master random number generator
- 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.