- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Description:The name of the variable that this object applies to
- propertyThe scalar material property name
C++ Type:MaterialPropertyName
Description:The scalar material property name
MaterialStdVectorAux
The MaterialStdVectorAux has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
Extracts a component of a material type std::vector
Input Parameters
- index0The index to consider for this kernel
Default:0
C++ Type:unsigned int
Description:The index to consider for this kernel
- factor1The factor by which to multiply your material property for visualization
Default:1
C++ Type:double
Description:The factor by which to multiply your material property for visualization
- offset0The offset to add to your material property for visualization
Default:0
C++ Type:double
Description:The offset to add to your material property for visualization
- execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
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, FINAL, CUSTOM.
- boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Description:The list of boundary IDs from the mesh where this boundary condition applies
- blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Description:The list of block ids (SubdomainID) that this object will be applied
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- selected_qpEvaluate the std::vector
at this quadpoint. This only needs to be used if you are interested in a particular quadpoint in each element: otherwise do not include this parameter in your input file C++ Type:unsigned int
Description:Evaluate the std::vector
at this quadpoint. This only needs to be used if you are interested in a particular quadpoint in each element: otherwise do not include this parameter in your input file - enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.
- 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.