SpatialUserObjectVectorPostprocessor

Outputs the values of a spatial user object in the order of the specified spatial points

Overview

This VectorPostprocessor evaluates a spatial user object at a set of points and sets each postprocessor to the spatial value of the user object at each point. This postprocessor may be used to convert spatial user objects such as NearestPointLayeredAverage to a postprocessor that can be transferred to another application with a MultiAppVectorPostprocessorTransfer.

If neither "points" or "points_file" are provided, this object will attempt to get the spatial points directly from the user object. These points will represent locations in space where the user object obtains a unique value. To use this feature, the user object must define the spatialPoints() interface.

note:Vector names / CSV output column names

SpatialUserObjectVectorPostprocessor declares a vector with its own name. The full reporter name ends up being <vpp_object_name>/<vpp_object_name>.

Example Input File Syntax

[UserObjects]
  [npla]
    type = NearestPointLayeredAverage
    direction = x
    points = '0.5 0.25 0.25
              0.5 0.75 0.25
              0.5 0.25 0.75
              0.5 0.75 0.75'
    num_layers = 3
    variable = u
  []
[]

[VectorPostprocessors]
  [vpp]
    type = SpatialUserObjectVectorPostprocessor
    userobject = npla
    points_file = points.txt
  []
[]

Input Parameters

userobjectThe userobject whose values are to be reported
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:The userobject whose values are to be reported

Required Parameters

contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
execute_onTIMESTEP_ENDThe 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:TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM
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.
parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
Default:REPLICATED
C++ Type:MooseEnum
Unit:(no unit assumed)
Options:DISTRIBUTED, REPLICATED
Controllable:No
Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
pointsComputations will be lumped into values at these points.
C++ Type:std::vector<libMesh::Point>
Unit:(no unit assumed)
Controllable:No
Description:Computations will be lumped into values at these points.
points_fileA filename that should be looked in for points. Each set of 3 values in that file will represent a Point. This and 'points' cannot be both supplied.
C++ Type:FileName
Unit:(no unit assumed)
Controllable:No
Description:A filename that should be looked in for points. Each set of 3 values in that file will represent a Point. This and 'points' cannot be both supplied.
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.

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
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.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
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.

Advanced Parameters

(moose/test/tests/vectorpostprocessors/spatial_userobject_vector_postprocessor/spatial_userobject.i)

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 10
  ny = 10
  nz = 10
[]

[Variables]
  [dummy]
  []
[]

[Kernels]
  [diffusion]
    type = Diffusion
    variable = dummy
  []
[]

[AuxVariables]
  [u]
  []
  [np_layered_average]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[AuxKernels]
  [u]
    type = FunctionAux
    variable = u
    function = u
  []
  [np_layered_average]
    type = SpatialUserObjectAux
    variable = np_layered_average
    user_object = npla
    execute_on = timestep_end
  []
[]

[Functions]
  [u]
    type = ParsedFunction
    expression = 'x+2*y+3*z'
  []
[]

[UserObjects]
  [npla]
    type = NearestPointLayeredAverage
    direction = x
    points = '0.5 0.25 0.25
              0.5 0.75 0.25
              0.5 0.25 0.75
              0.5 0.75 0.75'
    num_layers = 3
    variable = u
  []
[]

[VectorPostprocessors]
  [vpp]
    type = SpatialUserObjectVectorPostprocessor
    userobject = npla
    points_file = points.txt
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
  execute_on = 'final'
  hide = 'dummy'
[]

Overview
Example Input File Syntax
Input Parameters