FuelRodLineValueSampler

Description

'FuelRodLineValueSampler' is a customized version of the LineValueSampler VectorPostprocessor to extract quantities at a user-specified fractional location within either the fuel and/or cladding for a BISON fuel rod model. The 'FuelRodLineValueSampler' VectorPostprocessor uses the FuelPinGeometry UserObject to automatically compute the user-specified locations of the line for both the fuel and cladding.

Figure 1: Schematic showing the midplane locations for the fuel and cladding.

Example Input Syntax

[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
  [fuel_vonmises]
    type = FuelRodLineValueSampler<<<{"description": "Creates a custom LineValueSampler VectorPostprocessor to outputquantities of interest within the fuel or cladding materials usingeither horizontal or vertical lines specified by a fraction.", "href": "FuelRodLineValueSampler.html"}>>>
    variable<<<{"description": "The names of the variables that this VectorPostprocessor operates on"}>>> = vonmises_stress
    material<<<{"description": "The material on which to generate LineValueSampler output. Options are: fuel clad"}>>> = 'fuel'
    fraction<<<{"description": "The fractional distance at which to place the LineValueSampler line."}>>> = 0.51
    num_points<<<{"description": "The number of points to sample along the line"}>>> = 20
    orientation<<<{"description": "The orientation of the line for the LineValueSampler output. Options are: horizontal vertical"}>>> = 'horizontal'
    fuel_pin_geometry<<<{"description": "Name of the UserObject that reads the pin geometry from the mesh."}>>> = 'pin_geometry'
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = chkfile
  []
  [clad_vonmises]
    type = FuelRodLineValueSampler<<<{"description": "Creates a custom LineValueSampler VectorPostprocessor to outputquantities of interest within the fuel or cladding materials usingeither horizontal or vertical lines specified by a fraction.", "href": "FuelRodLineValueSampler.html"}>>>
    variable<<<{"description": "The names of the variables that this VectorPostprocessor operates on"}>>> = vonmises_stress
    material<<<{"description": "The material on which to generate LineValueSampler output. Options are: fuel clad"}>>> = 'clad'
    fraction<<<{"description": "The fractional distance at which to place the LineValueSampler line."}>>> = 0.51
    num_points<<<{"description": "The number of points to sample along the line"}>>> = 9
    orientation<<<{"description": "The orientation of the line for the LineValueSampler output. Options are: horizontal vertical"}>>> = 'horizontal'
    fuel_pin_geometry<<<{"description": "Name of the UserObject that reads the pin geometry from the mesh."}>>> = 'pin_geometry'
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = chkfile
  []
[]
(test/tests/fuelrodlinevaluesampler/example_problem_smeared_test.i)

Input Parameters

  • fractionThe fractional distance at which to place the LineValueSampler line.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The fractional distance at which to place the LineValueSampler line.

  • fuel_pin_geometryName of the UserObject that reads the pin geometry from the mesh.

    C++ Type:UserObjectName

    Controllable:No

    Description:Name of the UserObject that reads the pin geometry from the mesh.

  • materialfuelThe material on which to generate LineValueSampler output. Options are: fuel clad

    Default:fuel

    C++ Type:MooseEnum

    Options:fuel, clad

    Controllable:No

    Description:The material on which to generate LineValueSampler output. Options are: fuel clad

  • num_pointsThe number of points to sample along the line

    C++ Type:unsigned int

    Controllable:No

    Description:The number of points to sample along the line

  • orientationhorizontalThe orientation of the line for the LineValueSampler output. Options are: horizontal vertical

    Default:horizontal

    C++ Type:MooseEnum

    Options:horizontal, vertical

    Controllable:No

    Description:The orientation of the line for the LineValueSampler output. Options are: horizontal vertical

  • variableThe names of the variables that this VectorPostprocessor operates on

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:The names of the variables that this VectorPostprocessor operates on

Required Parameters

  • _auto_broadcastFalse

    Default:False

    C++ Type:bool

    Controllable:No

  • 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

    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

  • 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

    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.

  • scaling1The postprocessor that the variables are multiplied with

    Default:1

    C++ Type:PostprocessorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The postprocessor that the variables are multiplied with

  • warn_discontinuous_face_valuesTrueWhether to return a warning if a discontinuous variable is sampled on a face

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to return a warning if a discontinuous variable is sampled on a face

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

    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).

  • 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

    Options:XFEM_MARK, 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.

  • 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

    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

    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

    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

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    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

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    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

    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

  • 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

    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.

Material Property Retrieval Parameters

Input Files

References

No citations exist within this document.