VectorPostprocessorVisualizationAux

Short Description

Read values from a VectorPostprocessor that is producing vectors that are 'number of processors' * in length. Puts the value for each processor into an elemental auxiliary field.

Description

This object is intended to let you view VectorPostprocessor vectors that are of lenght num_procs (meaning there is one value per MPI process). This object will take those values and fill up an Auxiliary field with them so the values can be visualized.

Important Notes

Note: the VectorPostprocessor must be syncing the vectors it's computing to all processors. By default many just compute to processor 0 (because that's where output occurrs).

For instance: this is the case for WorkBalance. By default it only syncs to processor 0, but it has a parameter (sync_to_all_procs) to tell it to create copies of the vectors on all processors.

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Options:

    Description:The name of the variable that this object applies to

  • vector_nameThe name of the vector to use from the VectorPostprocessor

    C++ Type:std::string

    Options:

    Description:The name of the vector to use from the VectorPostprocessor

  • vppThe name of the VectorPostprocessor to pull the data from.

    C++ Type:VectorPostprocessorName

    Options:

    Description:The name of the VectorPostprocessor to pull the data from.

Required Parameters

  • use_broadcastFalseCauses this AuxKernel 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

    Options:

    Description:Causes this AuxKernel 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

  • 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, PRE_DISPLACE.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM PRE_DISPLACE

    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, PRE_DISPLACE.

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    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

    Options:

    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

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    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

    Options:

    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

Input Files

References