- variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Description:The name of the variable that this residual object operates on
VectorPostprocessorPointSource
A VectorPostprocessorPointSource reads in multiple point sources from a VectorPostprocessor. The point source values and coordinates are updated as the vectorPostprocessor values are changed. Example syntax for a VectorPostprocessorPointSource used in a transient simulation is given by:
[DiracKernels]
[./vpp_point_source]
type = VectorPostprocessorPointSource
variable = u
vector_postprocessor = point_sample
value_name = u
[../]
[]
using the following VectorPostprocessor to provide x,y,z coordinates and value_name = u
[point_sample_out]
type = PointValueSampler
variable = u
points = '0.2 0.8 0.0'
sort_by = id
execute_on = 'timestep_begin'
contains_complete_history = true
outputs = 'csv'
[]
Note that the PointValueSampler has execute_on = timestep_begin to force the vpp to execute prior to being used by VectorPostprocessorPointSource. It is also important for the VectorPostprocessorPointSource to never use a vpp with contains_complete_history = true, as this can modify the ordering of the coordinates and points. In the above input file, two locations have loads applied to them by the VectorPostprocessorPointSource. The load values are given by the PointValueSampler.
Input Parameters
- blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Description:The list of block ids (SubdomainID) that this object will be applied
- point_not_found_behaviorIGNOREBy default (IGNORE), it is ignored if an added point cannot be located in the specified subdomains. If this option is set to ERROR, this situation will result in an error. If this option is set to WARNING, then a warning will be issued.
Default:IGNORE
C++ Type:MooseEnum
Description:By default (IGNORE), it is ignored if an added point cannot be located in the specified subdomains. If this option is set to ERROR, this situation will result in an error. If this option is set to WARNING, then a warning will be issued.
- use_broadcastFalseCauses this diracKernel to use a broadcasted version of the vector instead of a scattered version of the vector (the default). This is slower - but is useful for debugging and testing
Default:False
C++ Type:bool
Description:Causes this diracKernel to use a broadcasted version of the vector instead of a scattered version of the vector (the default). This is slower - but is useful for debugging and testing
- value_namevaluename of column containing values.
Default:value
C++ Type:std::string
Description:name of column containing values.
- vector_postprocessorThe name of the VectorPostprocessor containing positions and corresponding load values
C++ Type:VectorPostprocessorName
Description:The name of the VectorPostprocessor containing positions and corresponding load values
- x_coord_namexname of column containing x coordinates.
Default:x
C++ Type:std::string
Description:name of column containing x coordinates.
- y_coord_nameyname of column containing y coordinates.
Default:y
C++ Type:std::string
Description:name of column containing y coordinates.
- z_coord_namezname of column containing z coordinates.
Default:z
C++ Type:std::string
Description:name of column containing z coordinates.
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Description:Adds user-defined labels for accessing object parameters via control logic.
- drop_duplicate_pointsTrueBy default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.
Default:True
C++ Type:bool
Description:By default points added to a DiracKernel are dropped if a point at the same locationhas been added before. If this option is set to false duplicate points are retainedand contribute to residual and Jacobian.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
Description:Determines whether this object is calculated using an implicit or explicit form
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
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
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.
Advanced Parameters
- extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
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>
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
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
Description:The tag for the vectors this Kernel should fill